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": {
    "offset": 123,
    "limit": 123,
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

API key authentication

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

List of active entitlements

object
enum<string>
default:list
Available options:
list
data
object[]
pagination
object