Entitlements
Get Entitlement Status
Read the calling organization's subscription plan, trial state, pending cancellation, feature gates, and per-quota usage. quotas[key].limit reflects the effective limit (the plan's trial limit when is_trialing is true). metered_usage_enabled reports whether the organization accepts charges beyond its included monthly allowance.
GET
Successful Response
application/json- response
plan_name*Plan Namedisplay_name*Display Nameis_trialing*Is Trialingtrial_ends_at*|nulltrial_days_remaining*integer|nullpending_cancellation_at*|nullfeature_gates*array<string>quotas*write_access*Write Accesswrite_access_reason*string|nullmetered_usage_enabled*Metered Usage Enabledis_free_plan*Is Free PlanTrue when the organization's current plan is the no-card Free plan: no subscription, and quotas that stop at their limit rather than billing an overage. Clients use this instead of matching plan_name.
curl -X GET 'https://api.bettermenu.live/entitlements/status'Example Response200
{ "plan_name": "string", "display_name": "string", "is_trialing": true, "trial_ends_at": "2019-08-24T14:15:22Z", "trial_days_remaining": 0, "pending_cancellation_at": "2019-08-24T14:15:22Z", "feature_gates": [ "string" ], "quotas": { "property1": { "limit": 0, "used": 0, "remaining": 0, "resets_at": "2019-08-24T14:15:22Z", "overage_per_unit_cents": "string" }, "property2": { "limit": 0, "used": 0, "remaining": 0, "resets_at": "2019-08-24T14:15:22Z", "overage_per_unit_cents": "string" } }, "write_access": "string", "write_access_reason": "string", "metered_usage_enabled": true, "is_free_plan": true}