Skip to main content
GET
Check your credits balance
The balance is shared across your whole organisation. See Credits for when a credit is actually consumed.

Authorizations

X-API-Key
string
header
required

Query Parameters

api_key
string

Legacy alternative to the X-API-Key header. Prefer the header.

Response

Credit balance retrieved successfully.

success
boolean
Example:

true

credits_left
integer

Credits remaining on the account, across the whole organisation.

Example:

32377

email
string

Email of the account the API key belongs to.