Skip to main content
GET
Get credit balance
Returns the current credit balance for the authenticated user (or the user’s active organization, if applicable).
Pair this with POST /v1/workflows/estimate-credits or POST /v1/nodes/estimate-credits to confirm there’s enough balance before kicking off an expensive run.

Authorizations

string
required
Bearer API key. Format: Bearer gx_your_api_key.

Response

number
Raw credit balance in microcredits. Divide by 1,000,000 to convert to credits. Use formatted if you just need a display string.
string
Human-readable balance, denominated in millions (e.g. "1.23M").
boolean
true when the user’s (or org’s) subscription is currently active.
boolean
true when the returned balance belongs to an organization the user is a member of, rather than the user’s personal account.

Request

Response example

Errors