Atlas
Admin — Organizations

Update organization plan

Updates the plan tier for a workspace. Valid tiers: free, trial, team, enterprise.

PATCH
/api/v1/admin/organizations/{id}/plan

Path Parameters

id*string
Length1 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

planTier*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:3001/api/v1/admin/organizations/org_abc123/plan" \  -H "Content-Type: application/json" \  -d '{    "planTier": "starter"  }'
{
  "message": "string",
  "organization": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
Edit on GitHub

Last updated on