v1

latestOpenAPI 3.1.02026-08-042453938.9 KB
Entitlements

Check entitlement

Fast pre-request check: is this customer allowed to use this feature?

Returns allowed: true/false with remaining quota. Use this before processing expensive requests to avoid wasting compute on customers who are over quota.

Redis-backed hot-path with DB fallback for persisted usage events.

post/v1/entitlements/check

Request body

customerIdstring required

Customer ID

featureKeystring required

Feature/meter key (e.g., "search", "api_calls")

quantitynumber

Quantity to check (default: 1)

Response

Entitlement check result

allowedboolean
featureKeystring
remainingnumber
limitnumber
unlimitedboolean
period'DAILY' | 'MONTHLY'
periodResetsAtstring date-time
reasonstring