Saltar al contenido principal
GET
Get credit balance
Consultarlo no cuesta nada, así que un programa puede revisarlo antes de cada lote. remaining ya descuenta los créditos que retienen tus tareas en cola y en ejecución. El significado de cada campo está en Créditos y límites.

Autorizaciones

Authorization
string
header
requerido

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

Respuesta

Your account's credits.

success
boolean
requerido
remaining
number
requerido

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
requerido

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

cycleResetsAt
string<date-time> | null
requerido

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
requerido

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>
requerido

Your plan. free when no paid plan is active.

Opciones disponibles:
free,
basic,
pro,
scale,
max
topUpBalance
object | null
requerido

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.