Extend a subscription
Overview
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.
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 | Type/Description |
---|---|
Boolean |
true or false depending on whether the changes were successful or not. |
Request
<?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);