Usage
Monitor your API quota, extra credits, and account status in real time.
The Usage endpoint returns your remaining API quota, extra credits, rate limits, and API key details at any time. It does not consume any credits.
Note: the subscription object reports your combined API quota (subscription allowance + remaining top-ups), not the subscription portion alone. Use the dashboard for a subscription vs top-up split.
This endpoint is free. It never consumes any credits.
Request
curl "https://api.piloterr.com/v2/usage" \
-H "x-api-key: YOUR_API_KEY"Response Fields
| Field | Type | Description |
|---|---|---|
remaining | integer | Total credits available now (API quota + extra credits) |
total_used | integer | Total credits consumed so far (API quota + extra credits; top-up usage persists across billing periods) |
renewal_date | string | Date when the subscription renews (ISO 8601) |
period.start | string | Start of the current billing period |
period.end | string | End of the current billing period |
subscription.used | integer | API calls used against your combined API quota |
subscription.total | integer | Combined API quota cap (subscription + top-ups) |
subscription.remaining | integer | Remaining combined API quota (subscription remainder + unused top-ups) |
subscription.percent_used | number | Percentage of API quota consumed |
credits.given | integer | Extra credits granted to your account (separate ledger) |
credits.consumed | integer | Extra credits consumed |
credits.remaining | integer | Extra credits remaining |
rate_limit.per_minute | integer | null | Requests per minute limit (null = unlimited) |
rate_limit.per_second | integer | null | Requests per second limit (null = unlimited) |
account.name | string | Name of the account |
account.slug | string | Account identifier slug |
api_key.alias | string | Friendly name of the API key |
api_key.active | boolean | Whether the key is currently active |
api_key.category | string | Key category (e.g. development, production) |
api_key.expires | string | null | Expiry date of the key (null = never expires) |
api_key.quotas | object | Custom per-key quotas: total, daily, weekly, monthly |
Example Response
{
"remaining": 450,
"total_used": 1550,
"renewal_date": "2026-04-25",
"period": {
"start": "2026-03-25",
"end": "2026-04-25"
},
"subscription": {
"used": 1550,
"total": 2000,
"remaining": 450,
"percent_used": 77
},
"credits": {
"given": 0,
"consumed": 0,
"remaining": 0,
"percent_used": 0
},
"rate_limit": {
"per_minute": null,
"per_second": null
},
"account": {
"name": "Acme Corp",
"slug": "acme-corp"
},
"api_key": {
"alias": "production",
"active": true,
"category": "production",
"expires": null,
"quotas": {
"total": null,
"daily": null,
"weekly": null,
"monthly": null
}
}
}