Confirm a plan change
Confirm a previewed plan change on the customer's behalf.
Send the preview token from the plan-change preview response for the same change. The response includes approval_url with a pending action when the customer still has to approve the change at the provider, or pay the proration order named by proration_order_id for a subscription the store bills in house. When the provider applies the change directly, the action is returned as confirmed and approval_url is omitted.
Provide your SellApp API key as a bearer token.
In: header
Path Parameters
The productSubscription path parameter.
Header Parameters
A caller-generated key, unique per store and subscription lifecycle request. Sending it here is the same as sending idempotency_key in the body.
length <= 128Caller-generated key for safely retrying this operation. The JSON idempotency_key field is also accepted; when both are sent, the header takes precedence.
length <= 128Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://sell.app/api/v2/subscriptions/55/actions/change-plan/confirm" \ -H "X-STORE: launch-lab" \ -H "Content-Type: application/json" \ -d '{ "target_variant_id": 4321, "preview_token": "subprev_9c4b2f" }'{
"data": {
"id": 101,
"product_subscription_id": 55,
"subscription_id": "I-BW452GLLEP1G",
"action": "change_plan",
"status": "pending",
"provider": "paypal",
"proration_order_id": null,
"error": null,
"customer_message": null,
"confirmed_at": null,
"failed_at": null,
"created_at": "2026-07-03T12:00:00.000000Z",
"updated_at": "2026-07-03T12:00:00.000000Z"
},
"message": "Subscription plan change requested.",
"approval_url": "https://www.paypal.com/checkoutnow?token=5EX12345AB678901C"
}{
"type": "invalid_request_error",
"code": "bad_request",
"message": "The request could not be understood.",
"status": 400,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#bad-request"
}{
"type": "authentication_error",
"code": "unauthenticated",
"message": "Unauthenticated.",
"status": 401,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#unauthenticated"
}{
"type": "authorization_error",
"code": "forbidden",
"message": "This action is unauthorized.",
"status": 403,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#forbidden"
}{
"type": "not_found_error",
"code": "resource_not_found",
"message": "Not Found.",
"status": 404,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#resource-not-found"
}{
"type": "validation_error",
"code": "validation_failed",
"message": "The selected product variant id is invalid.",
"status": 422,
"param": "product_variant_id",
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#validation-failed",
"errors": {
"product_variant_id": [
"The selected product variant id is invalid."
]
}
}{
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "Too Many Attempts.",
"status": 429,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#rate-limit-exceeded"
}{
"type": "api_error",
"code": "api_error",
"message": "Server Error",
"status": 500,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#api-error"
}