Retrieve specific list of subscriptions
Last updated: 25-Sep-2019
Extract information on a specific list of subscriptions. Use the getSubscriptions method to retrieve details about a specific list of your account’s subscriptions.
Subscriptions can be retrieved starting with 5 minutes after their orders are generated in the 2Checkout system.
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 (Array of strings) |
Unique, system-generated subscription identifier. |
|
aggregate |
Required (boolean) |
|
true - search will work across all your aggregated 2Checkout accounts. false - default value. You limit the search to the account whose details you used for authentication. |
Parameters | Type/Description |
---|---|
Array of objects |
<?php
require ('PATH_TO_AUTH');
$subscriptionReferences = array('REFERENCE1', 'REFERENCE2', 'REFERENCE3');
$jsonRpcRequest = array (
'method' => 'getSubscriptions',
'params' => array($sessionID, $subscriptionReferences),
'id' => $i++,
'jsonrpc' => '2.0');
var_dump (callRPC((Object)$jsonRpcRequest, $host, true));
Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.
We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.