Skip to main content
GET
Get the credit balance

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful response

balance
integer
required

Credits the workspace holds now. Can be a little below 0: a read that already happened is never refused.

Required range: -9007199254740991 <= x <= 9007199254740991
tracking_paused
boolean
required

True when the workspace has no credits left. No tracked media is read until credits are added.

paused_since
string<date-time> | null
required

When tracking paused for lack of credits. Null while tracking runs, or when the workspace never held credits.

expiring_soon
object[]
required

Batches of credits that expire in the next 14 days, soonest first.

next_expiry
object | null
required

The batch of credits that expires first. Null when no credits are left.

spent_last_7_days
integer
required

Credits used in the last 7 days.

Required range: -9007199254740991 <= x <= 9007199254740991
spent_last_30_days
integer
required

Credits used in the last 30 days.

Required range: -9007199254740991 <= x <= 9007199254740991
days_covered
integer | null
required

How many days the balance lasts at the rate of your active tracked media. The rate is each media at its cadence and geo price, plus the daily geo account fee. Null when no tracked media are active, or the balance is 0 or less.

Required range: -9007199254740991 <= x <= 9007199254740991
auto_top_up
object | null
required

Auto top-up settings. Null when they were never set. Change them on the Billing page of the console.