control:read scope.
Get usage
Response
Fields
| Field | Description |
|---|---|
period.start | Start of the current billing cycle (ISO 8601). |
period.end | End of the current billing cycle, or null if open-ended. |
credits.allotment | Total credits available this cycle (base plan + any overages purchased). |
credits.used | Credits consumed so far this cycle. Sonnet-equivalent tokens: Haiku requests count as 0.33×, Opus as 5×. |
credits.remaining | allotment - used. Requests fail with 402 AI_CREDITS_EXHAUSTED when this reaches zero. |
credits.overage_purchased | Additional credits purchased outside the plan allotment. |
credits.overage_consumed | Overage credits consumed. |
requests.total | Total AI requests made this cycle. |
Credit accounting
Credits are denominated in Sonnet-equivalent tokens. The model rate-ratios are:| Model | Rate-ratio |
|---|---|
claude-haiku-4-5 | 0.33× |
claude-sonnet-4-6 | 1.0× |
claude-opus-4-7 | 5.0× |
meta.usage.sonnet_equivalent_tokens field on every AI response shows the credit impact of that specific request.
Error codes
| Code | HTTP | Description |
|---|---|---|
INVALID_API_KEY | 401 | Invalid or revoked token |
MISSING_SCOPE | 403 | Key lacks control:read scope |