GET/api/v6/account/usage

Usage by scope

Period usage broken down by organization, cost center, user, key and service.

Scope

API key with the account capability granted

Usage limit

20 requests per minute

Account usage broken down by scope (organization, cost center, user, API key or service) for a period. The total field is the org:0 usage, that is the grand total. Amounts carry 6 decimals.

Sensitive financial data

The API key must have the account capability explicitly enabled. Access to all services does NOT grant it: it is granted separately, per key, from the customer portal (Developers → API keys). A key without the capability gets 403.

Query parameters

period

stringoptional

Period in YYYY-MM format. Defaults to the current month.

Responses

200

Period usage.

{
  "success": true,
  "data": {
    "period": "2026-06",
    "total": "108.000000",
    "scopes": [
      { "scopeType": "org", "scopeRef": "0", "consumed": "108.000000" },
      { "scopeType": "cost_center", "scopeRef": "17", "consumed": "108.000000" },
      { "scopeType": "service", "scopeRef": "urlshortener", "consumed": "108.000000" }
    ]
  },
  "meta": {
    "requestId": "b9b1704baffab21150213c02fd853975",
    "timestamp": "2026-06-02T19:43:59+00:00",
    "responseTimeMs": 4.1
  }
}

401

Invalid or missing credentials.

403

The API key lacks the required capability, or the organization cannot run the request.

429

Request limit exceeded. Wait for Retry-After.

Possible errors

Codes this endpoint can return in error.code. The full detail lives in the catalog.

401AUTH_REQUIREDNo Bearer token was sent, and every call requires one.401AUTH_INVALID_KEYThe API key is not recognized: wrong format, revoked or expired.401AUTH_SERVICE_NOT_ALLOWEDThe key is not allowed to use the service behind this endpoint.403ACCOUNT_NOT_ACTIVEYour organization is suspended or closed.403ACCOUNT_BLOCKEDA full block is active: every call is rejected.403ACCOUNT_CONFIG_NOT_FOUNDWe could not load the organization behind your key.403FORBIDDENGeneric 403: fallback when no `ACCOUNT_*` applies.429RATE_TPS_EXCEEDEDYou exceeded your organization quota for this endpoint.

See the full catalog

Scope and limits

Query parameters

Responses

Possible errors