For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retrieve 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.

Request parameters

Parameter
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.

Request sample

<?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));

Response parameters

Parameter
Type

Array of objects

Last updated

Was this helpful?