API 3.1 provides endpoints which allow you to manage subscriptions.
Among them, the following are worth highlighting:
- update subscriptions
- handle subscription switches (upgrades and downgrades).
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.
Once you configure upgrade and downgrade options in the dashboard you can use the following endpoints:
- GET /3.1/subscription_switches/availability - to fetch all available subscription switch options
- POST /3.1/subscription_switches - to request a switch to another subscription plan
- GET /3.1/subscription_switches - to list subscription switches
- GET /3.1/subscription_switches/{switchId} - to retrieve details of a given switch
- PATCH /3.1/subscription_switches/{switchId} - to manage subscription switch