Zum Hauptinhalt springen
GET
Get credit balance
Die Abfrage kostet nichts, ein Programm kann sie also vor jedem Batch ausführen. remaining zieht die Credits, die Ihre wartenden und laufenden Tasks reservieren, bereits ab. Was jedes Feld bedeutet, steht unter Credits und Limits.

Autorisierungen

Authorization
string
header
erforderlich

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

Antwort

Your account's credits.

success
boolean
erforderlich
remaining
number
erforderlich

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
erforderlich

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

cycleResetsAt
string<date-time> | null
erforderlich

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
erforderlich

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

Your plan. free when no paid plan is active.

Verfügbare Optionen:
free,
basic,
pro,
scale,
max
topUpBalance
object | null
erforderlich

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.