ResourcesSubscriptions
Preview a plan change
Preview the billing impact before changing a subscription's plan.
Plan changes may be customer-only depending on provider support.
Authorization
bearerAuth storeAuth AuthorizationBearer <token>
Provide your SellApp API key as a bearer token.
In: header
X-STORE<token>
Select the SellApp store for this API request.
In: header
Path Parameters
productSubscription*integer
The productSubscription path parameter.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://sell.app/api/v2/subscriptions/0/actions/change-plan/preview" \ -H "Content-Type: application/json" \ -d '{ "target_variant_id": 4321, "effective_timing": "immediate", "proration_behavior": "provider_default" }'{
"message": "Unauthenticated."
}{
"message": "This action is unauthorized."
}{
"message": "Rule not found."
}{
"message": "The given data was invalid.",
"errors": {
"data": [
"The data field is required."
]
}
}