Switch subscription

post

https://api.sandbox.cleeng.com/3.1/subscription_switches

This endpoint is used to upgrade or downgrade a subscription to another subscription plan. Use either subscriptionId OR customerId and fromOfferId together (customerId and fromOfferId can only be used with Cleeng-managed subscriptions where the whole lifecycle is under the control of Cleeng). As these last two parameters are deprecated, subscriptionId is going to be the only option to use this endpoint.

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 Support Team if you wish to use other payment connectors/gateways.

Body Params

subscriptionId

int32

Subscription identifier at Cleeng. This is the ID of the subscription the customer is switching from. Required conditionally when customerId and fromOfferId not provided.

toOfferId

string

required

ID of the subscription offer to which a customer wants to upgrade

switchDirection

string

required

Supported: upgrade, downgrade, unspecified. Note: unspecified is only supported for externally-managed subscriptions (subscriptions whose life cycle is managed outside of Cleeng).

algorithm

string

Supported: DEFERRED, IMMEDIATE_WITHOUT_PRORATION. Required conditionally if the subscription is externally-managed (externally-managed subscriptions, e.g. managed in an app store, outside of Cleeng).

customerId

int32

Cleeng ID of a customer. Deprecated.

fromOfferId

string

Offer ID of a customer’s subscription that will be upgraded. Deprecated.

Headers

Content-Type

string

Defaults to application/json

X-Publisher-Token

string

required

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

422422