API reference descriptions are provided in English to preserve the exact published contract.
GET /v1/accounts/{AC}/usage
Required scope: `usage:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
groupBy | query · "day" | "sender" | "category" | "subaccount" | ||
from | query · string (date) | ||
to | query · string (date) | ||
AC | path · string (AC… SID) | yes | Account SID |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
GET /v1/accounts/{AC}/usage/api
Per-minute aggregate. Ship Messages keeps no per-request log, so this reports request counts, rate-limited counts and latency by route family and status class. Required scope: `usage:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
hours | query · integer (1–168) | ||
AC | path · string (AC… SID) | yes | Account SID |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
GET /v1/accounts/{AC}/usage/api-consumption
developer view. Aggregated from the retained request facts, so consumption is attributable to the API key that spent it, to the route template it was spent on, and a 429 to the RateLimit-Policy scope that refused it. Required scope: `usage:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
hours | query · integer (1–168) | ||
AC | path · string (AC… SID) | yes | Account SID |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.
GET /v1/accounts/{AC}/usage/limits
Required scope: `usage:read`.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
AC | path · string (AC… SID) | yes | Account SID |
Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.