ReferenceUsage

Get credit balance

`available` is what you can actually spend — it is `balance` minus any credits currently reserved against in-flight work.

GET
/api/v1/credits/balance

Authorization

ApiKeyAuth
x-api-key<token>

A platform key (ck_live_…). Mint one in the console under Settings → API Keys.

In: header

Response Body

application/json

curl -X GET "https://example.com/api/v1/credits/balance"
{  "balance": 0,  "reserved": 0,  "available": 0,  "granted_this_period": 0,  "spent_this_period": 0,  "period_start": "2019-08-24T14:15:22Z"}
Was this page helpful?
Report an issue