Change plan

Moves the active workspace to another paid plan.

An upgrade is prorated and takes effect immediately; a downgrade is scheduled for the next renewal (see the billing service). The interval cannot change here — cancel and re-subscribe instead. Writes nothing on an upgrade: Stripe’s webhook applies the new state and emails the account’s billing contacts.

Authentication

X-Workspace-Idstring
API Key authentication via header

Request

This endpoint expects an object.
planenumRequired

A workspace’s pricing tier.

There is no Free tier: an unsubscribed workspace has no subscription row at all, and its events are tracked and reported but never dispatched.

intervalenumOptional
A subscription's billing cadence.

Response

Successful Response

Errors

422
Unprocessable Entity Error