Saltar para o conteúdo principal
GET
Get credit balance
A consulta não custa nada, então um programa pode verificá-la antes de cada lote. remaining já desconta os créditos reservados pelas suas tarefas na fila e em execução. O significado de cada campo está em Créditos e limites.

Autorizações

Authorization
string
header
obrigatório

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

Resposta

Your account's credits.

success
boolean
obrigatório
remaining
number
obrigatório

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
obrigatório

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

cycleResetsAt
string<date-time> | null
obrigatório

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
obrigatório

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>
obrigatório

Your plan. free when no paid plan is active.

Opções disponíveis:
free,
basic,
pro,
scale,
max
topUpBalance
object | null
obrigatório

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.