GET/v1/workspace/plan

Read the workspace's plan and seats

What the workspace is ENTITLED to: its tier, business type, subscription status, trial end, when it subscribed, and how many seats it holds. A workspace with no plan row reads as the entry tier rather than an error, and a trial that has run out reads as the entry tier too. Any seat. This is the entitlement — /v1/billing is the money — so a caller that only needs the tier should read this one.

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",
    "effectivePlan": "string",
    "plan": "string",
    "seats": 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