Move the current subscription to another published version in place
const url = 'https://api.seal0.app/v1/subscriptions/example/change-plan-version';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"plan":{"key":"example","version":1}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.seal0.app/v1/subscriptions/example/change-plan-version \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "plan": { "key": "example", "version": 1 } }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Header Parameters
Section titled “Header Parameters”Optional; replays the stored response for 24 hours.
Request Bodyrequired
Section titled “Request Bodyrequired”object
A plan version to pin; version omitted = latest published at request time.
object
Example generated
{ "plan": { "key": "example", "version": 1 }}Responses
Section titled “Responses”The updated subscription.
object
The customer’s external ID.
A pinned plan version.
object
Feature or plan key.
Example generated
{ "cancel_at": "2026-04-15T12:00:00Z", "created_at": "2026-04-15T12:00:00Z", "current_period_end": "2026-04-15T12:00:00Z", "current_period_start": "2026-04-15T12:00:00Z", "customer_id": "example", "grace_ends_at": "2026-04-15T12:00:00Z", "id": "example", "is_current": true, "plan": { "key": "example", "version": 1 }, "replaced_at": "2026-04-15T12:00:00Z", "status": "example", "trial_ends_at": "2026-04-15T12:00:00Z", "updated_at": "2026-04-15T12:00:00Z"}Error envelope.
object
object
Stable snake_case error code.
Offending input field, when known.
Example generated
{ "error": { "code": "example", "field": "example", "message": "example", "request_id": "example" }}Error envelope.
object
object
Stable snake_case error code.
Offending input field, when known.
Example generated
{ "error": { "code": "example", "field": "example", "message": "example", "request_id": "example" }}Error envelope.
object
object
Stable snake_case error code.
Offending input field, when known.
Example generated
{ "error": { "code": "example", "field": "example", "message": "example", "request_id": "example" }}Error envelope.
object
object
Stable snake_case error code.
Offending input field, when known.
Example generated
{ "error": { "code": "example", "field": "example", "message": "example", "request_id": "example" }}Error envelope.
object
object
Stable snake_case error code.
Offending input field, when known.
Example generated
{ "error": { "code": "example", "field": "example", "message": "example", "request_id": "example" }}Error envelope.
object
object
Stable snake_case error code.
Offending input field, when known.
Example generated
{ "error": { "code": "example", "field": "example", "message": "example", "request_id": "example" }}default
Section titled “default”Error envelope.
object
object
Stable snake_case error code.
Offending input field, when known.
Example generated
{ "error": { "code": "example", "field": "example", "message": "example", "request_id": "example" }}