Workspace/Plan

Edit workspace plan limits and dates

Partial edit of a workspace plan by a super role: only the sent `limits` and `period` fields change. A limit value is `-1` (unlimited), `0` (nothing) or a positive integer; booleans for `sdk_cli` / `custom_roles`. A date change recomputes the workspace status at once with the daily-cron rule when `statusSource` is `auto`; a manual status is never touched. Add-ons are not accepted here (`addons: Use /plan/addons.`). Writes `plan.edited` (+ `status.changed`) to the plan history.

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

Authorization

BearerAuthObject
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Workspace UUID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v2/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/plan" \  -H "Content-Type: application/json" \  -d '{}'
{}
{  "errors": {    "name": "Empty value"  }}
{  "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}"  }}