v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

List entitlements

You can use this endpoint to list a customer's entitlements and calculate a subscription's length. You can fetch entitlements for two types of offer: subscriptions and passes only. (For more information on offers, see What is a Cleeng offer?). <br><br> 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.

get/entitlements

Query parameters

customerIdinteger required

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

customerEmailstring

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

offsetinteger required

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

limitinteger required

Number of results you want to retrieve.

statusstring

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

offerTypestring

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). <br> Default: when offerType is not provided, the endpoint returns only subscriptions and passes.

Response

200

successboolean

nextPageboolean

messagestring

Example response

{
  "success": true,
  "data": [
    {
      "offerType": "S",
      "offerId": "S210309420_PL",
      "customerId": 801798658,
      "status": "terminated",
      "expiresAt": 1622831581,
      "startedAt": 1622828737
    }
  ],
  "message": "Entitlements fetched successfully"
}