Subscription renewal notifications
Overview
Use the setRenewalNotificationStatus method to subscribe or unsubscribe shoppers from subscription renewal notifications.
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. |
|
status |
Required (boolean) |
|
true – enable subscription renewal notifications. false – disable subscription renewal notifications. |
Response
Parameters | Type/Description |
---|---|
Boolean |
true or false depending on whether or not the operation succeeded. |
Request
<?php require ('PATH_TO_AUTH'); $subscriptionReference = 'YOUR_SUBSCRIPTION_REFERENCE'; $status = false; $jsonRpcRequest = array ( 'method' => 'setRenewalNotificationStatus', 'params' => array($sessionID, $subscriptionReference, $Status), 'id' => $i++, 'jsonrpc' => '2.0'); var_dump (callRPC((Object)$jsonRpcRequest, $host, true));