Disable a subscription
Overview
Use the cancelSubscription method to disable an active subscription. Avangate disables the subscription immediately and no longer performs any recurring billing actions.
Parameters
Parameters | Type/Description |
---|---|
Parameters |
Type/Description |
sessionID |
Required (string) |
|
Session identifier, the output of the Login method. Include sessionID into all your requests. Avangate 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 |
---|---|
Boolean |
true or false depending on whether the call resulted in success or not. |
Request
<?php require ('PATH_TO_AUTH'); $subscriptionReference = 'YOUR_SUBSCRIPTION_REFERENCE'; $jsonRpcRequest = array ( 'method' => 'cancelSubscription', 'params' => array($sessionID, $subscriptionReference), 'id' => $i++, 'jsonrpc' => '2.0'); var_dump (callRPC((Object)$jsonRpcRequest, $host, true));