Renewal status
Overview
Use the getRenewalDetails method to retrieve information regarding subscription renewals based on 2Checkout Subscription References:
- Information on the automatic renewal (recurring billing) status (enabled or disabled).
- The link that customers access to renew the subscription though a manual payment.
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 | Type/Description |
|---|---|
|
recurringEnabled |
Boolean |
|
|
TRUE= automatic renewal (recurring billing) is enabled for the subscription. FALSE= automatic renewal (recurring billing) is not enabled for the subscription. |
|
manualRenewalLink |
String |
|
|
The manual renewal link customers can use to renew their subscription. |
Request
<?php
require ('PATH_TO_AUTH');
$subscriptionReference = 'YOUR_SUBSCRIPTION_REFERENCE';
$jsonRpcRequest = array (
'method' => 'getRenewalDetails',
'params' => array($sessionID, $subscriptionReference),
'id' => $i++,
'jsonrpc' => '2.0');
var_dump (callRPC((Object)$jsonRpcRequest, $host, true));