A grant provisions an entitlement for a customer when a trigger event occurs. The key distinction between grant types is where in the billing calculation they take effect.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.
Where grants can be configured
| Level | Available |
|---|---|
| Product pricing | Yes |
| Contract phase | No |
Grant types
Quantity
A quantity grant adds to the customer’s entitlement balance in units of consumption (API calls, GB, seats, or any unit the product tracks). When the invoice is calculated, the available balance is deducted from the customer’s total consumption before pricing runs. Only the remaining quantity is priced. Example: A customer has a quantity grant of 1,000 API calls. They consume 1,400 calls. Zenskar prices 400 calls.Credits
A credits grant adds to the customer’s entitlement balance as credits. Credits are applied against the invoice total after pricing runs, reducing the amount owed. Example: A customer has a credits grant of $100. Their product total is $350. Zenskar charges $250.Configuration fields
| Field | Required | Description |
|---|---|---|
| Entitlement | Yes | The entitlement to issue the grant to. |
| Type | Yes | The grant type: Quantity or Credits. |
| Amount | Yes | The quantity or credit amount to grant. |
| Trigger event | No | When the grant is issued: on payment success, on invoice creation, or on invoice approval. |
| Label | No | How the grant appears on the invoice. |
How grants are applied
When the trigger event occurs, Zenskar adds the grant to the customer’s entitlement balance.- Quantity grants are drawn down before pricing runs. The deducted quantity reduces the consumption the pricing model calculates against.
- Credits grants are applied after pricing runs, as a reduction on the invoice total.