Entitlements

The Entitlements section (/entitlements) lets you define usage rights that can be attached to licenses.

Entitlement List

The main view shows all entitlements with their name, type, meter type, and aggregation method.

Creating an Entitlement

1. Navigate to Entitlements → New Entitlement
2. Fill in:
   • Name — Entitlement name (e.g. "API Calls")
   • Slug — URL-safe identifier
   • Type — BOOLEAN, NUMBER, or CONFIG
   • Meter Type (NUMBER only) — CALCULATED_USAGE or RAW_EVENT
   • Aggregation Method (NUMBER only) — SUM, COUNT, AVERAGE, MAX, MIN, LATEST
3. Click Create

Entitlement Detail

Click an entitlement to see its detail page with tabs:

Overview

• Entitlement metadata and properties

Usage Tab

• Usage data across all instances that have this entitlement
• Current consumption per instance vs threshold

Licenses Tab

• All licenses that include this entitlement and their configured threshold values

Customers Tab

• All customers whose instances have this entitlement (aggregated view)

API Equivalent