Get Entitlement

Retrieve a specific entitlement by ID. For metered entitlements, the response includes live balance, usage, and access status for the current billing period.

GET /v1/entitlements/{entitlementId}

Get Entitlement

cURL

curl --request GET \
  --url https://api.paygentic.io/v1/entitlements/{entitlementId} \
  --header 'Authorization: Bearer <token>'

200

booleanEntitlement

{ "object": "entitlement", "id": "ent_a7b8c9d0e1f2g3h4", "customerId": "cus_x1y2z3a4b5c6d7e8", "featureId": "feat_p1q2r3s4t5u6v7w8", "featureKey": "sso_enabled", "featureType": "boolean", "subscriptionId": "sub_m1n2o3p4q5r6s7t8", "status": "active", "hasAccess": true, "activeFrom": "2024-01-01T00:00:00Z", "activeTo": null, "metadata": {} }

Authorizations

Authorization · string · header · required

API key authentication

Path Parameters

entitlementId · string · required

The unique identifier of the entitlement

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

Query Parameters

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

200

application/json

Successfully retrieved the entitlement.

Option 1

Option 2

Option 3

A specific entitlement. The response shape varies by featureType.

object · enum<string> · default: entitlement · required

Available options: entitlement

id · string · required

Unique identifier for the entitlement.

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

customerId · string · required

Unique identifier for a customer

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

featureId · string · required

The feature this entitlement grants access to.

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

featureKey · string · required

The unique key identifying the feature.

featureType · enum<string> · required

The type of feature.

Available options: boolean

status · enum<string> · required

Current status of the entitlement.

Available options: active, canceled, expired

activeFrom · string<date-time> · required

When the entitlement becomes active.

hasAccess · boolean · required

Whether the customer currently has active access to this entitlement.

subscriptionId · string | null

The subscription this entitlement is associated with, if any.

activeTo · string<date-time> | null

When the entitlement expires. Null means no expiration.

metadata · object

Additional metadata for the entitlement.

Show child attributes