Skip to main content
GET
Get remaining API credits

Authorizations

X-Api-Key
string
header
required

Per-account API key. Also accepted as Api-Key or Authorization: Bearer <key>.

Headers

Api-Origin-Key
string

Partner origin key. When present, switches the response to a partner usage report covering all accounts that share the partner's custom origin. Also accepted as X-Api-Origin-Key.

Query Parameters

start_date
string<date>

Start of the partner usage report range (ISO 8601 date, e.g. 2026-06-01). Defaults to the beginning of the current month. Only used with Api-Origin-Key.

end_date
string<date>

End of the partner usage report range (ISO 8601 date, e.g. 2026-06-10). Defaults to today. Only used with Api-Origin-Key.

Response

Credits returned

credits_remaining
number<float>
required

API credits currently remaining on the account. (When Api-Origin-Key is supplied, the body is a partner usage report instead: partner_origin, date_range, summary, and per-account accounts usage breakdowns.)

Example:

1000