Skip to main content
GET
Get the credit balance summary

Authorizations

X-API-Key
string
header
required

Response

Successful Response

The global credit meter: credits left, allowance, period, and flags.

available
number
required

Credits left to spend: the balance, floored at zero, in decimal credits. A running table's hold does not lower it.

balance
number
required

Settled credit balance, in decimal credits.

held
number
required

Credits in-flight runs set aside for their highest possible cost, in decimal credits. Still part of the balance until charged, so it does not lower the credits left.

is_blocked
boolean
required

The balance is empty; credit-consuming work is refused.

is_low
boolean
required

The balance is at or below the low-balance threshold.

period_allowance
number
required

Credits granted each period by the plan, in decimal credits.

period_end
string<date-time>
required

When the allowance next refills.

period_start
string<date-time>
required

Start of the current grant period.