Documentation Index
Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt
Use this file to discover all available pages before exploring further.
A consumption tracks how a customer draws down an entitlement. When a specified invoice event occurs, Zenskar deducts the usage amount from the customer’s entitlement balance.
| Level | Available |
|---|
| Product pricing | Yes |
| Contract phase | Yes |
Entitlement types
Consumptions work with three entitlement types:
| Type | What it tracks |
|---|
| Credits | Monetary credits held by the customer. |
| Quantity | A numeric unit, such as API calls or seats. |
| Feature | A feature flag or capability the customer has access to. |
Configuration fields
| Field | Required | Description |
|---|
| Entitlement | Yes | The entitlement to deduct from. |
| Type | Yes | The entitlement type: Credits, Quantity, or Feature. |
| Trigger event | Yes | When the deduction runs: on invoice approval, on invoice creation, or on monitoring. |
| Label | No | How the consumption appears on the invoice. |
| Show additional info | No | When enabled, additional usage detail is shown on the invoice line item. |
How consumptions are applied
When the trigger event occurs, Zenskar deducts the usage amount from the customer’s available entitlement balance. If the balance is insufficient, the remaining usage becomes an overage and is billed normally.