Skip to main content
GET
/
v0
/
entitlements
/
activeEntitlements
List by Customer
curl --request GET \
  --url https://api.paygentic.io/v0/entitlements/activeEntitlements \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "ent_a7b8c9d0e1f2g3h4",
      "object": "entitlement",
      "billableMetrics": [
        "bm_y1z2a3b4c5d6e7f8"
      ],
      "customerId": "cus_q3r4s5t6u7v8w9x0",
      "planId": "plan_t9u0v1w2x3y4z5a6",
      "productId": "prod_m5n6o7p8q9r0s1t2",
      "subscriptionId": "sub_z1a2b3c4d5e6f7g8",
      "verifiedAt": "2024-01-20T10:00:00Z"
    },
    {
      "id": "ent_b8c9d0e1f2g3h4i5",
      "object": "entitlement",
      "billableMetrics": [
        "bm_a1b2c3d4e5f6g7h8",
        "bm_c2d3e4f5g6h7i8j9"
      ],
      "customerId": "cus_q3r4s5t6u7v8w9x0",
      "planId": "plan_t9u0v1w2x3y4z5a6",
      "productId": "prod_m5n6o7p8q9r0s1t2",
      "subscriptionId": "sub_z1a2b3c4d5e6f7g8",
      "verifiedAt": "2024-01-20T10:00:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 2
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication

Query Parameters

​
customerId
string
required

The customer ID to get active entitlements for. Unique identifier for a customer

Pattern: ^cus_[a-zA-Z0-9]+$
​
productId
string

The product ID to get active entitlements for. Unique identifier for a product

Pattern: ^prod_[a-zA-Z0-9]+$
​
subscriptionId
string

The subscription ID to get active entitlements for. Unique identifier for a subscription

Pattern: ^sub_[a-zA-Z0-9]+$

Response

List of active entitlements

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