core

Get API usage statistics

Get current usage, quota, and reset date for the API key.

get/v1/usage

Headers

X-API-Keystring nullable

Response

Successful Response

tierstring required

API key tier (free, paid, enterprise)

api_key_idstring required

API key ID

customer_namestring required

Customer name

quota_limitinteger required

Maximum requests allowed per period

current_usageinteger required

Current usage count

remaininginteger required

Remaining requests

availableinteger nullable

Credits spendable right now - same value as remaining, named for the question callers ask. Already net of credits frozen by in-flight reservations.

call_credit_holdinteger nullable

Credits ONE outbound call freezes at dial time (a refundable hold, not a charge). available // call_credit_hold is the CREDIT-limited bound on calls in flight - entitlement and the per-customer concurrency cap gate independently, so it is not a guarantee that many will start.

percentage_usednumber required

Percentage of quota used

reset_datestring required

Date when usage resets (YYYY-MM-DD)

periodstring required

Quota period (monthly, weekly, daily)

statusstring required

API key status (active, revoked, suspended)

validation_timestampstring nullable

UTC timestamp when usage response was produced (ISO 8601).

Example response

{
  "api_key_id": "f4d0a2c2-f73f-4de6-ac3e-f42ce35af4d6",
  "customer_name": "Acme Inc",
  "quota_limit": 10000,
  "current_usage": 2375,
  "remaining": 7625,
  "percentage_used": 23.75,
  "reset_date": "2026-03-31",
  "period": "monthly",
  "status": "active"
}

Changes

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