Promotional Entitlements
Get a list of promotional entitlements
Retrieves a paginated list of a customer's promotional entitlements.
get/api/v1/customers/{id}/promotional-entitlements
Path parameters
idstring required
The unique identifier of the entity
Query parameters
afterstring uuid
Return items that come after this cursor
beforestring uuid
Return items that come before this cursor
limitinteger
Maximum number of items to return
statusstring[]
Filter by promotional entitlement status. Supports comma-separated values for multiple statuses
Filter by creation date using range operators: gt, gte, lt, lte
Headers
X-ACCOUNT-IDstring
Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.
X-ENVIRONMENT-IDstring
Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).
Response
A paginated list of promotional entitlement objects.