> The full uetr.ai documentation index is at https://uetr.ai/llms.txt, and every page under https://uetr.ai/docs/api is also Markdown at its address plus `.md`.

# Get plan usage

Get the account's plan and how many of its active transfers are in use. Finished transfers archive themselves a week after their last check and are not counted. Archived transfers stay in the account and never count. On a custom package, also how many transfers were added in the current billing period against the package's volume, and when it resets. Reading changes nothing.

`GET https://uetr.ai/api/v1/account/usage`

- MCP tool: `get_plan_usage`
- Access: any key or connection

## Response

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `plan` | object | Yes |  |
| `plan.id` | string | Yes | free, rescue, monitor, monitor_20, or operator for the retired Operator plan. |
| `plan.name` | string | Yes |  |
| `active_transfers` | object or null | Yes | Null unless the account has an active subscription; get_account gives the subscription status. |
| `active_transfers.limit` | integer | Yes | Active transfers the plan covers. |
| `active_transfers.in_use` | integer | Yes | Active transfers in the account. It can exceed the limit after the plan changed. |
| `package` | object or null | Yes | Null unless the account has a custom package. Adds stop with monthly_limit_reached once added_this_period reaches included_transfers plus additional_transfers. |
| `package.name` | string | Yes |  |
| `package.included_transfers` | integer | Yes | Transfers included in each billing period. |
| `package.additional_transfers` | integer | Yes | Extra transfers allowed in each billing period beyond the included ones, billed on the renewal invoice at the package's pro-rated rate. |
| `package.added_this_period` | integer | Yes | Transfers added in the current billing period, extra ones included. Deleting a transfer does not lower it. |
| `package.additional_added_this_period` | integer | Yes | Of those, the extra transfers billed on the renewal invoice. |
| `package.period_start` | string or null | Yes | When the current billing period started. |
| `package.resets_at` | string or null | Yes | When the next billing period starts and the count begins again. |

## Example

```sh
curl -X GET "https://uetr.ai/api/v1/account/usage" \
  -H "Authorization: Bearer $UETR_API_KEY"
```

The answer:

```json
{
  "plan": {
    "id": "monitor",
    "name": "Monitor"
  },
  "active_transfers": {
    "limit": 10,
    "in_use": 1
  },
  "package": null
}
```

## Refusals

Besides the [access refusals](/docs/api/errors#access-refusals) every call can meet, this call can answer:

- [`plan_unverified`](/docs/api/errors#plan_unverified) (503): Plan could not be verified.