GET Token Usage

Route

/api/v2/token/usage

Ability

• usage-stats

Notes

• This endpoint does not debit request usage.
• This endpoint does not write an API event entry.

Response 200 (success)

{
  "error": false,
  "usage": {
    "calls": {
      "remaining": 1234,
      "lifetime": 56789,
      "plan_limit": 10000,
      "used_this_cycle": 8766
    },
    "plan": {
      "type": "standard",
      "name": "Standard Plan",
      "expires_at": "2026-04-30T00:00:00+00:00",
      "rate_limit": 60,
      "token_limit": 5
    },
    "token": {
      "name": "My SDK Token",
      "last_used_at": "2026-03-29T12:34:56+00:00"
    },
    "activity": {
      "last_api_call_at": "2026-03-29T12:34:56+00:00",
      "last_api_call_name": "Search Products",
      "last_api_call_status": 200
    },
    "estimates": {
      "average_daily_usage": 42.5,
      "estimated_days_left": 29,
      "basis": "lifetime_usage_since_signup"
    }
  },
  "response_time": "XXXms",
  "request_fulfilled": true,
  "request_debited": false
}

Response 403

{
  "message": "Invalid ability provided.",
  "response_time": "XXXms",
  "request_fulfilled": false,
  "request_debited": false
}