Change Customer Subscription

Upgrades a subscriber from their current subscription to a target subscription, without requiring the customer to re-enter their card details.

Prorates and charges the difference (target plan's price minus the unused remainder of the current subscription's period) against the target plan's payment link, then activates the target subscriber and unsubscribes the current one.

Constraints (v1)

  • Only upgrades are supported — the target subscription's first payment amount must exceed the current subscription's prorated remaining value by at least the minimum chargeable difference. Downgrades are not yet supported and will typically fail with PRORATION_BELOW_MINIMUM.
  • The target subscription must have an immediate start date — you cannot change a subscriber onto a future-dated subscription.
  • The current and target subscriptions must use the same currency.

Error codes

error_codeMeaning
INACTIVE_SUBSCRIBERThe subscriber is not active
MISSING_CARDThe subscriber has no off-session chargeable card on file
SAME_SUBSCRIPTIONThe target subscription is the same as the subscriber's current subscription
PRORATION_BELOW_MINIMUMThe prorated charge difference is below the minimum chargeable amount (2 AED / 0.55 in other currencies)
CHARGE_FAILEDThe proration charge was declined (includes a decline reason)
Path Params
string
required
Defaults to MPB-SUB-89F44540B6

Subscription ID (the subscriber's current subscription)

string
required
Defaults to MPB-SUBSCRIBER-9164BF542E

Subscriber ID

Body Params
string
required

The identifier of the subscription to move the subscriber to. This is the target subscription's identifier, not a numeric id.

Responses

500

Unexpected error

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json