GET/v1/billing

Read the workspace's billing

The Billing pane's whole subject in one read: the plan tier and its status, seats paid against seats in use, the current period, the next renewal and its amount, the card on file, and the AI credit balance. Reach for this to answer what a workspace is paying for; GET /v1/workspace/plan is the narrower read when only the entitlement matters. Carries no Stripe identifiers.

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": {
    "businessType": "string",
    "credits": {
      "balance": 1.5
    },
    "customer": {
      "hasStripe": true
    },
    "period": {},
    "plan": "string",
    "renewal": {
      "cancelAtPeriodEnd": true,
      "currency": "string"
    },
    "seats": {
      "paid": 1.5,
      "used": 1.5
    },
    "status": "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