Get credit balance
Credits
Get credit balance
Return the authenticated user’s current credit balance.
GET
Get credit balance
Returns the current credit balance for the authenticated user (or the user’s active organization, if applicable).
Authorizations
Bearer API key. Format:
Bearer gx_your_api_key.Response
Raw credit balance in microcredits. Divide by 1,000,000 to convert to
credits. Use
formatted if you just need a display string.Human-readable balance, denominated in millions (e.g.
"1.23M").true when the user’s (or org’s) subscription is currently active.true when the returned balance belongs to an organization the user is a
member of, rather than the user’s personal account.Request
- cURL
- Node.js
- Python
Response example
Errors
| Status | Reason |
|---|---|
401 | Missing or invalid API key |
500 | Server error |