Appearance
Account
Usage of the current billing period.
Generated
This page is generated from api/openapi/v1.yaml (OpenAPI 3.1.0, API version 1.0.0).
Usage of the current billing month
GET
/v1/usageScope: config:read. Billable events (agents + humans), bot events (measured, never billed), AI questions, and the key's rate limit.
Responses
| Status | Description |
|---|---|
200 | Usage. |
401 | Missing, invalid, expired or revoked API key (unauthorized). |
403 | The key lacks the required scope (forbidden_scope). |
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
month | string | ||
plan | "free" | "growth" | "pro" | "scale" | ||
billable_events | integer | Agent + human events this month. | |
free_bot_events | integer | Indexing bot events — measured, never billed. | |
events_limit | integer | ||
events_pct | number | ||
level | "none" | "warning" | "exceeded" | ||
overage_estimate | number | ||
hard_stop | boolean | ||
ai_questions | integer | ||
ai_questions_limit | integer | ||
rate_limit_per_minute | integer |