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

Extend a subscription

Extend the lifetime of a subscription in the 2Checkout system on-demand. Use the extendSubscription method to set a new expiration deadline for a subscription.

Extending subscriptions with addons

• When you extend a main subscription, 2Checkout also extends its active addon subscriptions whose expiration date is the same as the main subscription's. You don't need to extend them separately.

• You can extend an addon subscription on its own, but you cannot extend it beyond the expiration date of its main subscription, or to a date in the past.

• The main subscription and the addon subscriptions are extended in a single operation: either all of them are updated, or none.

• Extending a subscription does not process a payment. It only changes the expiration date.

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.

days

Required (int) 2Checkout prolongs the lifetime of a subscription using the number of days you send, adding the interval on top of the expiration date. Hint: Use a negative number to reduce the lifetime of a subscription. Cannot be NULL.

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';
$days = 5;

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

Error codes

Error code
Description

INVALID_LICENCE_OPERATION

Cannot extend subscription to a date in the past.

INVALID_ADDON_EXTENSION_OPERATION

Addon subscription cannot be extended beyond the main subscription expiration date.

INVALID_ADDON_EXTENSION_OPERATION

Addon subscription is not linked to a main subscription.

Last updated

Was this helpful?