Returns list of all your subscription offers purchased by the customer.

📘
This method will list only subscriptions which didn't expire (e.g returns the subscriptions for which the customer has still access rights to the content). Parameter 'status' in response may take value 'active' or 'cancelled'. Value 'active' means subscription will renew after expiration time, value 'cancelled' means user resigned and it will not be prolonged after it expires. Subscriptions which were cancelled and expired won't be listed by this method.

🚧
This method should not be used for real-time entitlement checks. Use getAccessStatus or getAccessibleTags instead.

📘
You can try that method by clicking here

Parameters

Name	Type	Description
publisherToken*	string	You can find your publisher token at api-keys page.
customerEmail*	string	Set customer email which you want to get subscription list from
offset*	integer	Integer, from which element you want to get results.
limit*	integer	Integer, how many elements you want to get

Result parameters

Name	Type	Description
items	object	Information about each subscription
-subscriptionId	integer	Subscription identifier at Cleeng
-offerId	string	Subscription offer ID, e.g. S123123123_US
-status	string	Current status of subscription, 'active' means subscription will renew after expiration time and 'cancelled' means user resigned and it will not be prolonged after it expires
-expiresAt	integer	End of subscription period
-nextPaymentPrice	float	Price for upcoming subscription period
-nextPaymentCurrency	string	Price currency for upcoming subscription period
-paymentGateway	string	Example values: adyen, ingenico, moneris, apple, paypal, roku, amazon, android
-paymentMethod	string	Example values: mc, amex, visa, ios, tvos, paypal, roku, amazon, android
-externalPaymentId	string	External Id of the latest payment for this subscription
totalItemCount	integer	Total amount of your subscription offers currently owned by user
customerId	integer	Customer identifier at Cleeng

API Request/Response

Request

{    
  "method": "listCustomerSubscriptions",    
  "params": {    
    "publisherToken": "TeurE3xRXcFtF7gSbhYCXx_qC1IrvnDWGejDv114-OE0cdZ9",     "customerEmail": "[email protected]",    
    "offset": "0",    
    "limit": "10"    
  },    
  "jsonrpc": "2.0",    
  "id": 1    
}

Response

{
  "result": {
    "items": [
      {
        "subscriptionId": 955044431,
        "offerId": "S123123123_US",
        "status": "active",
        "expiresAt": 1364146427,
        "nextPaymentPrice": 21.98,
        "nextPaymentCurrency": "USD",
        "paymentGateway": "apple",
        "paymentMethod": "tvos"
        "externalPaymentId": ""
      },
      {
        "subscriptionId": 967464836,
        "offerId": "S321321321_US",
        "status": "active",
        "expiresAt": 1364146427,
        "nextPaymentPrice": 1.52,
        "nextPaymentCurrency": "USD",
        "paymentGateway": "android",
        "paymentMethod": "android"
        "externalPaymentId": ""
      }
    ],
    "totalItemCount": 2
    "customerId": 801798658
  },
  "id": "1",
  "jsonrpc": "2.0"
}

PHP Example

<?php
    $customerEmail = '[email protected]';

    $cleengApi = new Cleeng_Api();
    $cleengApi->setPublisherToken('Y72a8Cr0KQciwzU7DbOcSXOFL1gT9a6gIYRb6hhOvCdPaxKW');

    $cleengApi->listCustomerSubscriptions($customerEmail, 0, 10);
?>