Workspace

Get workspace plan, limits and usage

Returns the workspace subscription plan, every limit it carries and the current usage measured against it. Limits come from the per-workspace snapshot (`workspace_plan.limits`), falling back to the plan template only when that snapshot is empty. Every numeric cap is pooled over the WHOLE workspace, except `max_custom_stories_per_bucket` (scope `bucket`), so a published number is a number the customer can actually reach. `cap: null` means the plan sets NO ceiling — an omitted numeric key is the stored way of saying unlimited (enterprise is `{}`, and every plan omits `max_users`, so seats are unlimited unless a vendor overlay sets a ceiling). `used: null` means that usage source is not implemented yet — `ai_tokens_per_month` is now the only such cap — and NOT that usage is zero. Boolean features follow the mirror-image rule: an omitted key means ENABLED. `subscription` is present only for workspaces provisioned from a B2STORE purchase. Accessible by super roles for any workspace, and by a Workspace Administrator of this one.

GET
/api/v2/workspaces/{id}/plan

Authorization

BearerAuthObject
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Workspace UUID

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/workspaces/019fc694-d096-70ab-bd16-2d68aed25400/plan"
{  "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",  "plan": {    "code": "growth",    "name": "Growth"  },  "subscription": {    "isTrial": false,    "lifecycleStatus": "active",    "purchasedAt": "2026-04-01 10:15:00+00"  },  "caps": [    {      "key": "max_tenants",      "scope": "workspace",      "cap": 25,      "used": 31    }  ],  "features": [    {      "key": "sdk_cli",      "enabled": false    }  ],  "tenantsPerProduct": [    {      "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",      "productName": "b2core",      "used": 2    }  ]}
{  "message": {    "error": "Your request was made with invalid credentials."  }}
{  "message": {    "error": "You are not allowed to perform this action."  }}
{  "message": {    "error": "Page not found"  }}
{  "message": {    "error": "Oops! Something went wrong! Write to administrator. Your Request Id {f1177aee-9a99-42f0-a23f-4dd29fc39b65-672e0df972ccb}"  }}