Skip to main content
GET
/
v1
/
billing
/
entitlements
Get billing entitlements
curl --request GET \
  --url https://api.truthlocks.com/v1/billing/entitlements \
  --header 'X-API-Key: <api-key>'
{
  "plan": "<string>",
  "entitlements": {}
}
GET /v1/billing/entitlements
Returns the resolved entitlements for your tenant, including the active plan, unlocked feature flags, and numeric quotas. Use this to check what your current plan allows before performing billable operations.

​
Response

​
plan_key
string
The active plan identifier (e.g., plan_starter, plan_business).
​
features
object
Feature flags unlocked by your plan and add-ons. Each key is a feature name and the value indicates whether it is enabled.
​
quotas
object
Numeric limits for billable resources. Each key is a metric name and the value is the limit.
To check your active add-ons, see billing overview. Add-on entitlements are merged into the features and quotas objects automatically.

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Response

Entitlements list

​
plan
string
​
entitlements
object