Disable a subscription

Use the cancelSubscription method to disable an active subscription. 2Checkout disables the subscription immediately and no longer performs any recurring billing actions.

Request parameters

Parameter	Type / Description
sessionID	Required (string) Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes.
SubscriptionReference	Required (string) Unique, system-generated subscription identifier.
ChurnReasons	Array Possible values for this field are: CHURN_REASON_NOT_SATISFIED_PRODUCT CHURN_REASON_ENABLED_BY_MISTAKE CHURN_REASON_PREFER_MANUAL CHURN_REASON_ALREADY_RENEWED CHURN_REASON_DONT_NEED CHURN_REASON_WANT_PAUSE CHURN_REASON_COVID CHURN_REASON_HIGH_PRICE CHURN_REASON_NOT_SATISFIED_SUPPORT CHURN_REASON_EXTRAORDINARY CHURN_REASON_OTHER
ChurnReasonOther	String This field should have a value only if the ChurnReasons has the CHURN_REASON_EXTRAORDINARY or CHURN_REASON_OTHER values.

Request sample

<?php

require ('PATH_TO_AUTH');

$subscriptionReference = 'YOUR_SUBSCRIPTION_REFERENCE';

try {
    $disableSubscription = $client->cancelSubscription($sessionID, $subscriptionReference);
}
catch (SoapFault $e) {
    echo "disableSubscription: " . $e->getMessage();
    exit;
}
var_dump("disableSubscription", $disableSubscription);

Response parameters

Type	Description
Boolean	true or false depending on whether the call resulted in success or not.