Preview a plan change

Plan changes may be customer-only depending on provider support.

Authorization

bearerAuth

AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

Path Parameters

productSubscription*integer

The productSubscription path parameter.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

idempotency_key?|

Optional idempotency key. You may also send this as the Idempotency-Key header.

Lengthlength <= 128

target_variant_id*integer

effective_timing?string

Value in"immediate" | "next_renewal"

proration_behavior?string

Value in"invoice_now" | "credit_next_invoice" | "none" | "provider_default"

metadata?

Response Body

`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"  }'

{
  "data": {
    "preview_token": "subprev_9c4b2f",
    "expires_at": "2026-07-03T12:15:00.000000Z",
    "preview_payload": {
      "estimated_total_cents": 1500
    },
    "request_payload": {
      "target_variant_id": 4321
    },
    "customer_message": null,
    "seller_message": null
  },
  "message": "Subscription plan change preview created."
}