Retrieve specific list of subscriptions
Overview
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
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. |
Response
Parameters | Type/Description |
---|---|
Array of objects |
Request
<?php require ('PATH_TO_AUTH'); $SubscriptionReferences = array('REFERENCE1', 'REFERENCE2', 'REFERENCE3'); try { $ListofSubscriptions = $client->getSubscriptions($sessionID, $SubscriptionReferences); } catch (SoapFault $e) { echo "ListofSubscriptions: " . $e->getMessage(); exit; } var_dump("ListofSubscriptions", $ListofSubscriptions);