Skip to main content
GET
Returns whether the workspace can buy credit top-ups, the plan rate, the preset amounts and the current credit balance. Use it to render a top-up screen before calling POST /billing/add-funds.
Only the workspace owner can call this endpoint. It is protected by the billing:manage permission.

Request

Headers

string
required
Bearer token (JWT or API key)

Response

boolean
true when the plan is creator or pro with status active or trialing
string
Current plan slug, for example free, starter, creator or pro
array
Plan slugs that can buy top-ups: ["creator", "pro"]
number | null
Credits per $1 at the current plan rate. null when not eligible.
object
min_usd (10), max_usd (1000) and presets_usd ([10, 25, 50, 100])
array
Each item has usd and credits. Empty when not eligible.
object
plan_credits (renewing monthly), topup_credits (never expire) and total_credits
object | null
Always null for now. Automatic top-up is coming soon.

Errors

See Plans, Credits & Top-ups for the rate formula and plan rules.