listCustomerSubscriptions()


Returns list of all your subscription offers purchased by the customer.
NOTE: 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.

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 subscription you want to get results
limit integer Integer, how many results you want to get

- required parameter

Response Parameters:

Name Type Description
items object Information about each subscription
-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
-expireAt integer End of subscription period
-nextPaymentPrice integer 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
totalItemCount integer Total amount of your subscription offers currently owned by user

Request:

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

Response:

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

Example:

<?php
                            
    $customerEmail = 'customer@email.com';

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

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

Remember! you can always check it by yourself using API Console - listCustomerSubscriptions()

Back to Customer API