Skip to main content
GET
Get credit balance
Reading it costs nothing, so a program can check it before each batch. remaining already excludes the credits your queued and running tasks hold. What each field means is on Credits and limits.

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>.

Response

Your account's credits.

success
boolean
required
remaining
number
required

Credits you can spend now, with up to two decimals. Tasks you already submitted hold their price in reserved, so it is not in this number. A submit that needs more returns 402 INSUFFICIENT_CREDITS.

perCycle
number | null
required

Credits your plan grants each billing cycle. null without an active plan.

cycleResetsAt
string<date-time> | null
required

When the current billing cycle ends. At renewal your balance becomes the next cycle's plan credits plus the top-up credits you still hold. null without an active plan.

reserved
number
required

Credits your queued and running tasks hold. A completed task is charged from its hold, and a failed task's hold returns to remaining.

plan
enum<string>
required

Your plan. free when no paid plan is active.

Available options:
free,
basic,
pro,
scale,
max
topUpBalance
object | null
required

Top-up credits within remaining. They last three months from purchase, carry over renewals, and are spent after your plan's credits. null when you have none.