Skip to main content
GET
Get account credit

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Response

The record, as a JSON object. There is no envelope.

The account credit balance and limits for adding funds.

enabled
boolean
required

The value of enabled.

Example:

true

balance
string
required

The value of balance.

Example:

"10.00"

limit
string | null
required

The value of limit.

Example:

"1000.00"

headroom
string | null
required

The value of headroom.

Example:

"990.00"

currency
string | null
required

The three-letter currency code used for monetary amounts.

Example:

"USD"

minimum
string
required

The value of minimum.

Example:

"5.00"

maximum
string
required

The value of maximum.

Example:

"500.00"

presets
string[]
required

The value of presets.

Example: