Change Plan

curl --request POST \
  --url https://api.example.com/api/v1/workspaces/{workspace_id}/billing/change-plan \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "member_ids_to_evict": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "promotion_code": "<string>"
}
'

{
  "plan": "<string>"
}

billing

Change Plan

Switch between Team and Business plans on an existing subscription.

Replaces the base plan subscription item in Stripe and removes any seat add-ons (extra_seats resets to 0 — re-add after switching if needed).

Pre-flight checks (409 with structured body):

org_disconnect_required: target plan allows fewer org connections than are currently connected. Disconnect excess orgs first, then retry.
member_eviction_required: target plan’s included seats are fewer than the current member count. Supply member_ids_to_evict (exactly the overflow count) to proceed atomically.

POST

api

workspaces

{workspace_id}

billing

change-plan

Change Plan

curl --request POST \
  --url https://api.example.com/api/v1/workspaces/{workspace_id}/billing/change-plan \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "member_ids_to_evict": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "promotion_code": "<string>"
}
'

{
  "plan": "<string>"
}

Authorizations

X-API-Key

string

header

required

Headers

X-Workspace-Id

string | null

Path Parameters

workspace_id

string<uuid>

required

Cookies

riftmap_access

string | null

Body

application/json

plan

enum<string>

required

Available options:

team,

business

member_ids_to_evict

string<uuid>[] | null

promotion_code

string | null

Response

Successful Response

plan

string

required

Preview pending charges that will bill on the final invoice if not waived Preview Change Plan