Retrieve order subscription references
Overview
List the references associated with the subscription generated for an order.
Requirements
This method requires you to set a specific partner using setPartner.
Parameters
| Parameter | Type/Description |
|---|---|
| sessionID | Required (String) |
| Session identifier, output of the Login method. An exception is thrown if the values are incorrect. | |
| refNo | Required (String) |
| The unique identifier of an order from the 2Checkout system. | |
| pageNo | Optional (Int) |
|
Break down the subscription information using pagination into groups of 50 items (PartnerSubscription objects) per page. Example values:
Can be NULL. |
Response
| Parameter | Type/Description | |
|---|---|---|
|
PartnerSubscription |
Array of objects |
|
|
|
Details below |
|
|
|
SubscriptionReference |
String |
|
|
|
The unique reference associated with a subscription generated for a product included in a partner order. |
|
|
HasEndUserInformation |
Boolean |
|
|
|
True or false, depending on whether end-user information is attached to the subscription. |
|
|
RegistrationStatus |
String |
|
|
|
Possible values:
|
|
|
RegistrationEmails |
String |
|
|
|
The email used by the end-user in the registration process. Can be NULL. |
|
|
FullfilmentStatus |
String |
|
|
|
Fulfillment status possible values:
|
Request
<?php
require ('PATH_TO_AUTH'); // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/02Authentication
require ('PATH_TO_setPartner'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/Partner/00Set_partner
$refNo = 'YOUR_ORDER_REFERENCE';
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'getOrderSubscriptions',
'params' => array($sessionID, $refNo)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));
Errors
| Error | Description |
|---|---|
|
NOT_FOUND_PARTNER |
A partner must be set first. |
|
EMPTY_ORDER_REFERENCE |
Order reference not provided. |
|
INVALID_REFERENCE |
Invalid order reference. |
