Entitlements

Check feature access and retrieve entitlement balances
View as Markdown

Entitlements represent what a customer is allowed to access based on their active subscriptions. Use these endpoints for real-time feature gating and quota checks in your application.

Endpoints

MethodPathDescription
POST/entitlements/checkCheck if a customer is entitled to a specific feature
GET/customers/{id}/entitlementsGet all entitlements for a customer

Key concepts

  • Entitlement check: The check endpoint returns a single entitled: true/false result for a specific feature. Use this for real-time access control (e.g., before allowing an API call or file upload).
  • Requested quantity: Optionally pass requested_quantity to check if the customer has at least N units remaining. Defaults to 1.
  • Unlimited entitlements: Some features may be unlimited (is_unlimited: true). For these, remaining is null and the customer is always entitled.
  • Deduplication: When a customer has the same feature from multiple subscriptions, the highest limit (or unlimited) is returned.
  • Reset period: The reset_at field indicates when the entitlement counter resets (typically the next billing period start).