GET/v1/billing/credits

Read the AI credit balance and ledger

The workspace's credit balance and the append-only ledger behind it, newest first: every purchase, grant, spend and adjustment with what it pointed at. The balance is the sum of the ledger, so the two can never disagree. Reach for this to answer where a workspace's credits went.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

bodyquery · nulloptional

paramsquery · objectoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": {
    "balance": 1.5,
    "ledger": [
      "string"
    ]
  }
}

datarequired

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired