Skip to main content
GET
Check remaining credits
Return the remaining API credit balance for the account tied to your API key. Checking your balance is free and never deducts credits.

Authorizations

X-API-Key
string
header
required

Response

Remaining credit balance.

balance
integer
required

Remaining API credits for the account tied to this API key.

Example:

1000

overage_enabled
boolean
required

Whether the account may continue using credits below zero.

overage_amount
integer | null
required

How far below zero the balance may fall, or null when overage is disabled.

Example:

10000

auto_topup_enabled
boolean
required

Whether automatic credit top-ups are enabled for the account.

auto_topup_threshold_credits
integer | null
required

Balance that triggers an auto top-up, or null when auto top-up is disabled.

Example:

5000

auto_topup_target_credits
integer | null
required

Balance restored by an auto top-up, or null when auto top-up is disabled.

Example:

15000