get https://api.sandbox.cleeng.com/3.1/subscription_switches/availability
This endpoint returns all available offers to which a customer can switch from the current subscription in available
array. Offers to which customer can't switch are returned in unavailable
array with the reason why the switch is not possible.
Important
Subscription upgrade and downgrade feature requires compatibility of the payment connector and payment gateway. Currently the feature is fully supported for the following: Adyen, PayPal. Please contact Cleeng Broadcaster Success Specialists team if you wish to use other payment connectors/gateways.
Possible unavailability reasons
Reason code | Explanation |
---|---|
PAYMENT_GATEWAY_NOT_SUPPORTED | The customer’s subscription was purchased with a payment gateway that is not supported by switch functionality. The following payment gateways are supported: - Adyen - Paypal |
RECURRING_PROCESS_ALREADY_STARTED | The customer's subscription is currently during the recurring payment process. Once a new billing cycle begins it will be possible to use switch functionality. |
ALREADY_HAS_ACCESS | The customer already has an active subscription to the target offer. |
TO_OFFER_COUNTRY_NOT_ALLOWED | Target offer is not accessible in the customer's country. Possible when geo-restriction was enabled on the target offer. |
TO_FREE_OFFER_NOT_ALLOWED | Switch functionality is not supported for offers with price 0. |
SUBSCRIPTION_WITH_COUPON_NOT_ALLOWED | Switch functionality is not supported for subscriptions with active coupons applied. |
MISSING_PAYMENT_DETAILS | Payment is required for a switch, but no payment details are provided. |