For the complete documentation index, see llms.txt. This page is also available as Markdown.

Disable recurring billing

Use the disableRecurringBilling method to disable recurring billing for a subscription. When you disable recurring billing, the subscription status doesn’t change. Users continue to use subscriptions with recurring billing disabled until they expire, and 2Checkout provides them with the option to renew their subscription through manual payments.

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';

$jsonRpcRequest = array (
  'method' => 'disableRecurringBilling',
  'params' => array($sessionID, $subscriptionReference),
  'id' => $i++,
  'jsonrpc' => '2.0'
);

var_dump (callRPC((Object)$jsonRpcRequest, $host, true));

Response parameters

Type
Description

Boolean

true or false depending on whether the changes were successful or not.

Last updated

Was this helpful?