Core Concepts
Licenses & Entitlements
License types, entitlement types, structured values, and how they connect.
Licenses & Entitlements
Licenses
A License defines the commercial and functional contract applied to an instance.
License Types
| Type | Use Case |
|---|---|
COMMUNITY | Free, open-source tier |
TRIAL | Time-limited evaluation |
DEVELOPMENT | Internal/testing environments |
PAID | Production commercial license |
Key Fields
| Field | Description |
|---|---|
name | License name (e.g. "Starter", "Enterprise") |
slug | Unique per organization |
type | One of the license types above |
version | Auto-incrementing version number |
version_name | Optional human-readable version (e.g. "v2.1") |
is_active | Whether the license is currently active |
is_default | Whether this is the default license for new instances |
Entitlements
An Entitlement defines a specific usage right or quota. Entitlements exist independently of licenses — they become active when linked to a license via a license_entitlement.
Entitlement Types
| Type | Description | Example |
|---|---|---|
BOOLEAN | On/off feature access | "Can use SSO" |
NUMBER | Metered quota with threshold | "1,000 API calls" |
CONFIG | Arbitrary JSON configuration | {"maxUsers": 50} |
Metering (NUMBER type only)
| Field | Options | Description |
|---|---|---|
meter_type | CALCULATED_USAGE, RAW_EVENT | How usage is metered |
aggregation_method | SUM, COUNT, AVERAGE, MAX, MIN, LATEST | How events are aggregated |
License Entitlements
The link between a license and an entitlement carries a structured value:
{
"type": "number",
"value": 1000
}Possible value shapes:
{"type": "number", "value": 1000}— numeric threshold{"type": "boolean", "value": true}— feature toggle{"type": "object", "value": {"maxUsers": 50}}— config object
How It All Connects
License: "Enterprise"
├── Entitlement: "API Calls" (NUMBER) → value: 10,000
├── Entitlement: "SSO Enabled" (BOOLEAN) → value: true
└── Entitlement: "Branding" (CONFIG) → value: {"theme": "custom"}When an instance is assigned this license, it inherits all these entitlements and their thresholds. Usage is tracked per instance, per entitlement.
See It in the Console
Browse, create, and configure licenses and entitlements from the Console — including linking entitlements to licenses with specific thresholds and values.