Fetch available switches

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

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.

Possible unavailability reasons

Reason codeExplanation
PAYMENT_GATEWAY_NOT_SUPPORTEDThe customer’s subscription was purchased with a payment gateway that is notsupported by switch functionality.
The following payment gateways are supported:
  • Adyen
  • Paypal
RECURRING_PROCESS_ALREADY_STARTEDThe 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_ACCESSThe customer already has an active subscription to the target offer.
TO_OFFER_COUNTRY_NOT_ALLOWEDTarget offer is not accessible in the customer's country. Possible when geo-restriction was enabled on the target offer.
TO_FREE_OFFER_NOT_ALLOWEDSwitch functionality is not supported for offers with price 0.
MISSING_PAYMENT_DETAILSPayment is required for a switch, but no payment details are provided.
Query Params
int32
required

Cleeng ID of a customer

string
required

ID of subscription offer from which all available offers to switch will be returned.

Headers
string
required
Responses

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