メインコンテンツへスキップ
GET
Get credit balance
取得にクレジットはかからないため、バッチを送る前に毎回確認できます。remaining からは、待機中と実行中のタスクが確保しているクレジットがすでに引かれています。各フィールドの意味はクレジットと上限にあります。

承認

Authorization
string
header
必須

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

レスポンス

Your account's credits.

success
boolean
必須
remaining
number
必須

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
必須

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

cycleResetsAt
string<date-time> | null
必須

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
必須

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>
必須

Your plan. free when no paid plan is active.

利用可能なオプション:
free,
basic,
pro,
scale,
max
topUpBalance
object | null
必須

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.