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

Enable recurring billing

Use the enableRecurringBilling method to switch on the automatic renewal system for a subscription that's manually renewable.

You can enable recurring billing for an addon subscription only while its main subscription is active and has automatic renewal enabled.

Request parameters

Parameters
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.

Response parameters

Parameters
Type/Description

Boolean

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

Request sample

<?php

require ('PATH_TO_AUTH');

$subscriptionReference = 'YOUR_SUBSCRIPTION_REFERENCE';

try {
    $enabledSubscriptionRecurring = $client->enableRecurringBilling($sessionID, $subscriptionReferenceTest);
}
catch (SoapFault $e) {
    echo "enabledSubscriptionRecurring: " . $e->getMessage();
    exit;
}
var_dump("enabledSubscriptionRecurring", $enabledSubscriptionRecurring);

Error codes

Error code
Description

ADDON_AUTORENEWAL_MAIN_NOT_ELIGIBLE

Auto-renewal cannot be enabled for this add-on while its main subscription is not active with auto-renewal on.

Last updated

Was this helpful?