Remove a workspace from the shared plan
DELETE/api/v1/organizations/{id}/shared-plan/workspaces/{workspace_id}
DELETE /organizations/{id}/shared-plan/workspaces/{workspace_id}
curl -X DELETE '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'Response · 200
{
"object": "shared_plan_removal",
"workspace_id": "workspace_123",
"external_id": "external_123",
"left": false,
"drops_to": "free"
}Take a workspace off the shared plan. Its usage this period stays counted on the plan. It drops to Free if its Owner's one free workspace is unused, else it needs a plan before it sends again (drops_to: free or needs_plan); it stays on the organization's billing, so a plan bought for it is billed to the organization. A workspace not on the shared plan answers left: false and nothing changes. Idempotency-Key is optional: a retry with it answers what the first call did. 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.
Parameters3 fields
| Field | Type | Description |
|---|---|---|
idrequired | string · path | The organization's id (`org_…`), from `GET /whoami` or Organization → API. |
workspace_idrequired | string · path | The workspace's id (`ws_…`). |
Idempotency-Key | string · header | Any unique string (1–256 characters, e.g. a UUID). Retrying with the same key and the same body within 24 hours returns the first result instead of sending again; the same key with a different body is `409 invalid_idempotent_request`, and one still in flight is `409 concurrent_idempotent_requests`. |
Response · 200 fields5 fields
| Field | Type | Description |
|---|---|---|
objectrequired | enumshared_plan_removal | — |
workspace_idrequired | string | `ws_…` |
external_idrequired | string | — |
leftrequired | boolean | False when it wasn't on the shared plan: nothing changed. |
drops_torequired | enum | null | `free`: it is on Free (its Owner's one free workspace). `needs_plan`: it sends again once a plan is bought for it. Null when `left` is false. |
200400401403404409429