Switch subscription

This endpoint is used to upgrade a subscription to another subscription plan.

Errors

Error code

Explanation

VALIDATION_ERROR

General input validation error. Details about error will be returned in message field in the response.

PAYMENT_GATEWAY_NOT_SUPPORTED

The customer’s subscription was purchased with a payment gateway that is not supported by switch functionality.
Following payment gateways are supported:

  • Adyen
  • Paypal
  • Bambora
  • Moneris
  • Stripe

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.

SWITCH_NOT_DEFINED_IN_SWITCH_SETTINGS

Subscription switch between the two given offers was not defined as possible in the dashboard.

Language
Authentication
Header
Click Try It! to start a request and see the response here!