# Get a campaign's plan

`GET https://api.tryscouty.com/v1/campaigns/{campaignId}/plan`

Reports the plan covering one campaign: how many creators it may sign this period, how many it has signed and activated, and when the period ends. Amounts and billing links are not part of this answer.

- Scope: `plan:read`
- Kind: read
- MCP tool: `scouty_get_plan`

## Authorization

Send `Authorization: Bearer $SCOUTY_TOKEN`. The token needs the `plan:read` scope.

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `campaignId` | `integer` | Required | The campaign whose plan to read. |

## Request

### cURL

```bash
curl -s https://api.tryscouty.com/v1/campaigns/42/plan \
  -H "Authorization: Bearer $SCOUTY_TOKEN"
```

### JavaScript

```js
const response = await fetch("https://api.tryscouty.com/v1/campaigns/42/plan", {
  headers: {
    Authorization: `Bearer ${process.env.SCOUTY_TOKEN}`,
  },
});
console.log(await response.json());
```

### Python

```python
import os

import requests

token = os.environ["SCOUTY_TOKEN"]
response = requests.get(
    "https://api.tryscouty.com/v1/campaigns/42/plan",
    headers={"Authorization": f"Bearer {token}"},
)
print(response.json())
```

## Responses

### 200 OK

```json
{
  "campaignId": 42,
  "enforced": true,
  "status": "active",
  "tier": "<plan tier>",
  "tierName": "<plan name>",
  "interval": "month",
  "extraSlots": "<integer>",
  "trialEnd": null,
  "currentPeriodEnd": "2026-10-15T00:00:00.000Z",
  "cancelAtPeriodEnd": false,
  "cap": "<integer>",
  "used": "<integer>",
  "remaining": "<integer>",
  "activated": "<integer>",
  "activationRemaining": "<integer>",
  "trial": false,
  "periodStart": "2026-09-15T00:00:00.000Z",
  "periodEnd": "2026-10-15T00:00:00.000Z",
  "full": false
}
```

### 401 Unauthorized

```json
{
  "error": {
    "code": "missing_token",
    "message": "This API needs an Authorization header carrying a bearer token."
  }
}
```

### 403 Forbidden

```json
{
  "error": {
    "code": "insufficient_scope",
    "message": "This token does not carry the plan:read scope. Ask the team for one that does."
  }
}
```

### 404 Not Found

```json
{
  "error": {
    "code": "not_found",
    "message": "No such campaign."
  }
}
```

### 429 Too Many Requests

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please wait for the current minute to end."
  }
}
```

## Errors

| Status | `error.code` | Meaning |
|---|---|---|
| 401 Unauthorized | `missing_token`, `invalid_token`, `token_revoked`, `token_expired`, `token_orphaned` | No token, or one that is not recognized, revoked or expired. |
| 403 Forbidden | `insufficient_scope`, `wrong_principal` | The token does not carry the scope this capability needs. |
| 404 Not Found | `not_found` | No such route, or no such campaign for this client. |
| 429 Too Many Requests | `rate_limited` | Too many requests this minute. Retry-After says how long is left. |

Full reference: https://docs.tryscouty.com/reference