Atlas
Platform Admin

Change workspace plan tier

SaaS only. Updates the plan tier for a workspace (free, trial, team, enterprise).

PATCH
/api/v1/platform/workspaces/:id/plan

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 "http://localhost:3001/api/v1/platform/workspaces/:id/plan" \  -H "Content-Type: application/json" \  -d '{    "planTier": "team"  }'
{
  "message": "string",
  "workspaceId": "string",
  "planTier": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}