Check entitlement

View as Markdown

Checks whether a customer is entitled to use a specific feature. Returns the entitlement status, current usage, limits, and remaining balance.

Use this endpoint for real-time feature gating in your application.

Authentication

AuthorizationBearer

Use a secret key (sk_test_* or sk_live_*) for full read/write access, or a public key (pk_test_* or pk_live_*) for read-only access.

Request

This endpoint expects an object.
customer_idstringRequiredformat: "uuid"
The customer to check entitlements for.
feature_idstringRequired
The feature identifier to check.
requested_quantityinteger or nullOptional>=1
Check if the customer has at least this much remaining. Defaults to 1.

Response

Entitlement check result
dataobject

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error