Subscriptions
Migrate subscription to latest plan version
Migrates a subscription to the latest published version of its plan or add-ons. Handles prorated charges or credits automatically.
post/api/v1/subscriptions/{id}/migrate
Path parameters
idstring required
The unique identifier of the entity
Headers
X-ACCOUNT-IDstring
Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.
X-ENVIRONMENT-IDstring
Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).
Request body
Response
The migrated subscription object.