Skip to main content
GET
/
can
Check Entitlement
curl --request GET \
  --url https://api.nozle.app/api/v1/can \
  --header 'Authorization: Bearer <token>'
{
  "allowed": true,
  "reason": "<string>",
  "used": 123,
  "limit": 123,
  "remaining": 123,
  "cost_per_use_cents": 123,
  "revenue_per_use_cents": 123,
  "margin_per_use_cents": 123,
  "min_margin_percent": 123
}
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: pk_ or sk_
​
customer_id
string
required
External customer ID
​
feature
string
required
Feature key to check (matches a billable metric code)
​
allowed
boolean
required
Whether the customer can use this feature
​
reason
string
required
Why the request was allowed or denied (e.g. within_limit, limit_exceeded, no_subscription)
​
used
number
Units consumed in the current billing period
​
limit
number
Maximum units allowed by the plan
​
remaining
number
Units still available
​
cost_per_use_cents
number
Your cost per unit (from cost models)
​
revenue_per_use_cents
number
What you charge per unit
​
margin_per_use_cents
number
Profit per unit
​
min_margin_percent
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.