Usage & SLA

Get current-month billable usage

Required scope: usage:read. Returns the billable call count for the current calendar month (sandbox/is_test and 5xx failures excluded). Quota is null for unlimited plans.

get/v1/usage

Request

  • Base URL: https://api.nashboard.ai
  • URL: https://api.nashboard.ai/v1/usage
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Headers

X-Nashboard-Version'2026-06-13'

API version pin (ISO date). Absent → latest. Unknown or future → 400 unsupported_version. The X-Amouen-Version header name is still accepted as a deprecated alias; when both are present, X-Nashboard-Version takes precedence.

Response

Current-month usage summary.

period_startstring date-time required
period_endstring date-time required
planstring required

Tenant plan tier (e.g. free, starter, growth, enterprise).

call_countinteger required

Billable API calls in the current calendar month.

quotainteger nullable required

Monthly call quota; null for unlimited plans.

quota_remaininginteger nullable required

Remaining quota; null for unlimited plans.

Changes

No recorded changes to this operation across all 1 revision of this API.