Skip to main content
GET
Check Entitlement
Check whether a customer is entitled to use a feature under their current plan. This is the primary gating endpoint — call it before executing any metered or limited operation. Auth: secret key only. Publishable keys are always rejected.
string
required
External customer ID derived by the trusted merchant backend.
string
required
Feature key to check (matches a feature code)
boolean
required
Whether the customer can use this feature
string
required
Why the request was allowed or denied (e.g. within_limit, limit_exceeded, no_subscription)
number
Units consumed in the current billing period
number
Maximum units allowed by the plan
number
Units still available
number
Your cost per unit (from cost models)
number
What you charge per unit
number
Profit per unit
number
Minimum margin threshold configured for this feature, if any
When allowed is false, the reason field tells you why — use it to show contextual upgrade prompts in your UI.