Entitlements API
Read the benefits that the subscriptions and memberships of a customer give.
An entitlement is a benefit that a customer holds, such as access to video content or to a ticket sale. OneBasket grants entitlements when a subscription or membership starts and removes them when it ends. Read entitlements to decide what a signed-in customer is allowed to see or do. See Subscriptions and memberships.
| Property | Value |
|---|---|
| Base path | /entitlements |
| Authentication | x-api-key header and a bearer token. The entitlements returned belong to the customer in the token. |
| OpenAPI document | entitlements.yaml |
The path of the list endpoint is /entitlements/entitlements. The first segment is the base path of the API and the second is the resource.