GET
/
entitlements
/
activeEntitlements
Get active entitlements for a customer
curl --request GET \
  --url https://api.paygentic.io/v0/entitlements/activeEntitlements \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "entitlement",
      "customerId": "<string>",
      "productId": "<string>",
      "subscriptionId": "<string>",
      "planId": "<string>",
      "billableMetrics": [
        "<string>"
      ],
      "verifiedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
customerId
string
required

The customer ID to get active entitlements for.

​
productId
string

The product ID to get active entitlements for.

​
subscriptionId
string

The subscription ID to get active entitlements for.

Response

200
application/json

List of active entitlements for a customer.

The response is of type object.