# Get account usage by month, today's counters, and plan limits

Source: https://joinsimplesms.com/docs/api/usage/get
Index: https://joinsimplesms.com/llms.txt

`GET /v1/usage`

Counts for the whole account, so test and live keys read the same numbers. Months and days are UTC; the current month comes first and is month-to-date. Scope: billing.

Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `months` | integer | No | How many months to return, counting back from the current one Default 3. Maximum 6. Minimum 1. |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | Usage | `Usage` |
| 400 | Invalid months | `Error` |
| 401 | Missing, malformed, or revoked API key | `Error` |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 200: `Usage` fields

| Field | Type | Description |
| --- | --- | --- |
| `object` | `usage` |  |
| `months` | array of UsageCounters | Newest first; a month with no traffic is listed with zeros |
| `today` | UsageCounters | The current UTC day so far |
| `limits` | object | Caps applied to live traffic on your plan; null means no cap |
| `limits.messages_per_day` | integer | Example: `10000`. |
| `limits.messages_per_month` | integer | Nullable. |
| `limits.lookups_per_day` | integer | 0 when live lookups are not available on your plan Example: `5000`. |
| `limits.verifications_per_day` | integer | Example: `2000`. |
| `limits.verifications_per_month` | integer | Nullable. |

## Errors

| Status | When |
| --- | --- |
| 400 | Invalid months |
| 401 | Missing, malformed, or revoked API key |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged |
| 429 | Rate limit or quota exceeded |

Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/errors) lists every code and what to do about it.

```json
{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}
```

## Examples

### curl

```bash
curl -X GET "https://api.joinsimplesms.com/v1/usage" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"
```

### Node.js

The Node.js SDK does not wrap this endpoint yet; call it with `fetch`.

```javascript
const res = await fetch('https://api.joinsimplesms.com/v1/usage', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SIMPLESMS_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();
```

### Python

The Python SDK does not wrap this endpoint yet; call it over HTTP.

```python
import json, os, urllib.request

req = urllib.request.Request(
    "https://api.joinsimplesms.com/v1/usage",
    method="GET",
    headers={
        "Authorization": f"Bearer {os.environ['SIMPLESMS_API_KEY']}",
    },
)
with urllib.request.urlopen(req) as res:
    data = json.load(res)
```

## Related

- Guide: [Usage](/docs/usage)
- [All usage endpoints](/docs/api#usage)
- [API reference](/docs/api)