Skip to main content
GET
Get Credit Balance
Check how many credits you have left, along with your lifetime purchased and used totals. It’s worth a quick call before kicking off anything that reserves credits — like character extraction or a render.

Response

Insufficient balance causes credit-consuming endpoints to fail with a 402 error. See Pricing for what each operation costs.

Example

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Response

Credit balance

balance
number

Current credit balance

Example:

250

credits
number

Alias of balance (spec-compliant field name)

Example:

250

total_purchased
number

Total credits purchased

Example:

500

total_used
number

Total credits used

Example:

250

updated_at
string<date-time>

Timestamp of last balance update