Skip to main content
GET
/
v1
/
entitlements
List Entitlements
curl --request GET \
  --url https://api.paygentic.io/v1/entitlements \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "hasAccess": true,
      "featureKey": "max_users",
      "featureType": "static",
      "config": {
        "limit": 25
      },
      "entitlementId": "ent_a7b8c9d0e1f2g3h4",
      "productId": "prod_m5n6o7p8q9r0s1t2",
      "activeFrom": "2024-01-01T00:00:00Z",
      "activeTo": "2025-01-01T00:00:00Z",
      "status": "active"
    },
    {
      "hasAccess": true,
      "featureKey": "sso_enabled",
      "featureType": "boolean",
      "config": null,
      "entitlementId": "ent_b8c9d0e1f2g3h4i5",
      "productId": "prod_m5n6o7p8q9r0s1t2",
      "activeFrom": "2024-01-01T00:00:00Z",
      "activeTo": null,
      "status": "active"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 2
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.paygentic.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key authentication

Query Parameters

​
customerId
string
required

The unique identifier of the customer to retrieve entitlements for. Unique identifier for a customer

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

Filter results to a specific feature by its key. When specified, productId is also required. Use this to check access to a single feature.

​
productId
string

Filter results to entitlements for a specific product. Required when featureKey is specified since feature keys are scoped to products. Unique identifier for a product

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

Filter results to entitlements for a specific subscription. Unique identifier for a subscription

Pattern: ^sub_[a-zA-Z0-9]+$
​
limit
integer
default:10

Maximum number of entitlements to return per page. Use with offset for pagination.

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of entitlements to skip. Use with limit for pagination through large result sets.

Required range: x >= 0
​
at
string<date-time>

Evaluate balance and access at this point in time (RFC 3339 datetime with any UTC offset, e.g. 2024-01-15T10:30:00Z or 2024-01-15T15:30:00+05:30). Defaults to current time.

Response

Successfully retrieved the list of entitlements for the customer.

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

Array of entitlement access results.

​
pagination
object
required

Offset-based pagination response.