Features & Usage
Check Feature Access
Check if a tenant has access to a specific feature or has an active subscription for a product.
POST
Returns whether the tenant’s active plan includes the requested feature.
For multi-product orgs, pass
productSlug to scope the check to a specific product’s subscription.
If the feature is backed by a credit pool, also returns the available credit balance.
Request Body
The external tenant ID from your application
The feature key to check (must match a key in
plan.features). Optional when productSlug is provided — omitting it performs a subscription-existence check (returns true if the tenant has any active/trial subscription for that product).Scope the check to a specific product (e.g.
product-a). Required for multi-product orgs. At least one of featureKey or productSlug must be provided.For credit-backed features: number of credits needed. Defaults to
0 (balance check only).Authentication
Requires a public key (x-public-key: pk_live_...) or secret key (Authorization: Bearer sk_live_...).
Response
Whether the tenant can access the feature or has an active subscription for the product
Echoed feature key (absent when only
productSlug was provided)Echoed product slug (when provided)
The tenant ID that was checked
Only present when the feature maps to a credit pool.