CLcleeng

List switches

This endpoint lets you list all subscription switches (e.g. upgrades, downgrades) that meet the requirements given in the API request. For example, it allows you to filter switches by status or subscription ID. <br><br> Important <br> 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.

get/subscription_switches

Request

  • Base URL
    https://api.sandbox.cleeng.com/3.1
  • URL
    https://api.sandbox.cleeng.com/3.1/subscription_switches
  • Auth
    API key in header X-Publisher-Token

Query parameters

customerIdinteger required

The identifier of a customer at Cleeng.

subscriptionIdstring

The identifier of a subscription at Cleeng.

statusstring

The status of a subscription switch (e.g. upgrade or downgrade). Available values: pending, inprogress, finished, cancelled, failed.

Response

200

Changes

No recorded changes to this operation across all 1 revision of this API.