Subscription Entitlements

Get Entitlements

We provide a HTTP GET endpoint to query your customers' entitlements:

curl 'https://api.breeze.cash/v1/entitlements' \
 -u "<YOUR_API_KEY>:" \
 --header 'Content-Type: application/json'

This API supports the following optional query parameters:

subscriptionId: (string) the subscription's ID; if omitted, then this filter will not be applied.
customerId: (string) the customer's ID; if omitted, then this filter will not be applied.
isActive: (boolean) whether the entitlement is currently active; if omitted, then this filter will not be applied.
limit: (integer; minimum 1, maximum 100) sets the upper bound of the number of entitlements returned for this GET request; if omitted, then a default upper bound of 100 will be used.
cursorToken: (string) used for paginating over the results; you should retrieve this value from the nextPageToken field in the previous API response's body; if omitted, the API will return the first page of the query.
sort: (asc or desc) sorts the result of the query by ascending or descending creation time; if omitted, then the default sorting direction is ascending.

This API returns the following response:

{
  "entitlements": [{ // an array of objects
    "id": "ent_1234567890",
    "createdAt": 1762846570000, // unix timestamp
    "updatedAt": 1762846570000, // unix timestamp, optional
    "subscriptionId": "subs_1234567890", // the subscription this entitlement is created for
    "productId": "prd_1234567890", // the product associated with this entitlement
    "invoiceId": "invc_1234567890", // optional
    "livemode": true, // sandbox vs livemode entitlement
    "customerId": "cus_1234567890", // the customer's ID
    "merchantId": "mch_1234567890", // your merchant ID
    "startPeriod": 1762846570000, // unix timestamp
    "endPeriod": 1762846570000, // unix timestamp
    "idempotencyKey": "subs_1234567890-1762846570000-1762846570000" // uniquely identifies this entitlement
  }],
  "hasMore": true, // indicates that there are more results to be returned, use "nextPageToken"
  "nextPageToken": "next-page-token" // only returned when "hasMore" is true
}