Set a workspace's shared plan cap

Set a workspace's shared plan cap

PATCH/api/v1/organizations/{id}/shared-plan/workspaces/{workspace_id}

PATCH /organizations/{id}/shared-plan/workspaces/{workspace_id}
curl -X PATCH 'https://www.unitpost.com/api/v1/organizations/org_123/shared-plan/workspaces/ws_123' \
  -H 'Authorization: Bearer YOUR_ORG_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'
Response · 200
{
  "object": "shared_plan_workspace",
  "workspace_id": "workspace_123",
  "external_id": "external_123",
  "name": "Example",
  "cap_cents": 0,
  "joined_at": "2026-01-01T00:00:00.000Z",
  "used_cents": 0
}

Set what a workspace on the shared plan may draw from it each period, allowance and overage together, in cents (cap_cents; 0 stops it drawing at all, null removes the cap). At its cap only that workspace pauses (quota_exceeded); caps may add up to more than the plan. The workspace's activity log names the key. The key's creator must still be an organization Owner. Takes an organization key (ok_live_…) with organizations:billing.

Parameters2 fields
FieldTypeDescription
idrequiredstring · pathThe organization's id (`org_…`), from `GET /whoami` or Organization → API.
workspace_idrequiredstring · pathThe workspace's id (`ws_…`).
Request body1 field
FieldTypeDescription
cap_centsrequiredintegerIts cap, in cents a period: 0 stops it drawing, null removes the cap.
Response · 200 fields7 fields
FieldTypeDescription
objectrequiredenumshared_plan_workspace—
workspace_idrequiredstring`ws_…`
external_idrequiredstringYour own id for it, if you gave one.
namerequiredstring—
cap_centsrequiredintegerWhat it may draw from the shared plan each period, allowance and overage together. Null: no cap.
joined_atrequiredstring—
used_centsrequiredintegerWhat it drew this period, counted against its cap.
200400401403404422429

Search docs and guides

Search the docs and product guides.