Core API (API 3.1) provides endpoints which allow you to manage subscriptions
See the overview of Core (3.1) API endpoints which allow you to manage subscriptions.
Create subscription
Designed for creating externally-managed subscriptions whose lifecycle is managed outside of Cleeng.
Get subscription(s)
You can retrieve subscription details based on subscription ID or fetch subscriptions that match the specified criteria.
Update subscription
You can update an existing subscription, for example apply a coupon.
Change subscription status
Activate, cancel, or terminate a subscription.
Pause subscription
You can pause and resume subscriptions if you enable the feature in the Cleeng dashboard.
Upgrade or downgrade subscription
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 web the following: Adyen, PayPal. Please contact Cleeng Support Team if you wish to use other payment connectors/gateways.
If external app stores, such as Apple, Google Play, support subscription upgrades and downgrades, they are also supported in Cleeng.
Once you configure upgrade and downgrade options in the dashboard you can use the following endpoints:
- Fetch available switches - to fetch all available subscription switch options
- Switch subscription - to request a switch to another subscription plan
- List switches - to list subscription switches
- Fetch switch details - to retrieve details of a given switch
- Update switch - to manage subscription switch
- Fetch subscription switch settings - to fetch possible upgrades or downgrades that are configured for a given offer.
Configure and manage gift subscriptions
You can configure and manage gift subscriptions.
Manage externally-managed subscriptions
Transfer subscription from one account to another, revive terminated subscriptions, renew an active or stopped (canceled) subscription.