List entitlements

get

https://api.sandbox.cleeng.com/3.1/entitlements

You can use this endpoint to list a customer's entitlements and calculate a subscription's length. You can fetch entitlements for the following types of offer: subscriptions, passes, and one-time purchases (lifetime purchases and time-limited rentals). (For more information on offers, see What is a Cleeng offer?).

If there are two or more subscriptions or passes for the same offer and the same customer, there will be as many entitlements returned as there are subscriptions / passes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

customerId

int32

required

Customer identifier at Cleeng. One of the parameters is required: either customerId or customerEmail.

customerEmail

string

The email address of the customer. One of the parameters is required: either customerId or customerEmail.

offset

int32

required

From which element you want to get results. Helpful in pagination.

limit

int32

required

Number of results you want to retrieve.

status

string

The current status of a one-time purchase (active, terminated, all) or a subscription (available values for subscriptions: active, cancelled, terminated, all.
Note that granting entitlements is based on subscription status, not its expiration date.

offerType

string

The type of offer. Available values: S, P, SP, PS, A, R (S - subscriptions, P - passes, SP, PS - both subscriptions and passes, A - one-time lifetime purchases , R - one-time purchases: rentals, SPAR - all entitlement types: subscriptions, passes, one-time purchases - both lifetime and rentals).
Default: when offerType is not provided, the endpoint returns only subscriptions and passes.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400