Usage report template variables

Overview

This page documents the Mustache variables that appear in the usage report document Zenskar generates for organizations with usage reporting enabled.

Unlike Invoice, Credit Note, Payment Receipt, Refund Receipt, and Contract, the usage report is not a template you can create or edit from Communications > Document Templates. It isn’t one of the selectable types there, and it can’t be attached to an email template either. Usage report generation is a separate, feature-flagged pipeline. This page is a reference for understanding what data a usage report contains, not a how-to for customizing it.

For how Mustache syntax itself works ({{variable}}, sections, inverted sections) and the data type conventions used in the tables below, see the Templating guide.

1. Global and header variables

Variable	Type	Description
`{{logo}}`	String (URL)	Organization’s logo URL
`{{zenskar_logo}}`	String (URL)	Zenskar logo URL for footer branding
`{{zenskar_redirect_url}}`	String (URL)	Destination link for the “Powered by” footer attribution

2. Party information

2.1 Customer

Variable	Type	Description
`{{customer.name}}`	String	Customer’s full name
`{{{customer.address}}}`	String (HTML)	Customer’s address; render with the unescaped `{{{ }}}` form
`{{customer.email}}`	String	Customer’s contact email address

2.2 Seller

Variable	Type	Description
`{{seller.name}}`	String	Seller/issuing company’s legal name
`{{{seller.address}}}`	String (HTML)	Seller’s address; render with the unescaped `{{{ }}}` form

3. Document lines and entitlement deduction

Array: {{#document_lines}}...{{/document_lines}} Within a line item, an entitlement-deduction wrapper is present when that line involves a deduction from a prepaid balance: Wrapper: {{#templating_data.deduct-entitlement}}...{{/templating_data.deduct-entitlement}}

Variable	Type	Description
`{{templating_data.formatted_initial_quantity}}`	String (Number)	Starting balance of the prepaid entitlement at the beginning of the period
`{{templating_data.formatted_quantity_consumed}}`	String (Number)	Amount consumed during the report period
`{{templating_data.formatted_quantity_left_after_deduction}}`	String (Number)	Remaining balance after subtracting usage

4. Usage details table (`aggregate_logs`)

The detailed usage log table is built from nested arrays rather than a flat list of objects:

Variable	Type	Description
`{{#headers}}...{{/headers}}`	Array (Strings)	Column titles, for example “Date”, “Feature”, “Quantity”
`{{#rows}}...{{/rows}}`	Array (Objects)	The log rows
`{{#row}}...{{/row}}`	Array (Strings)	Within a row, the cell values in column order

Iterate the headers and each row’s cells with {{.}}, which refers to the current string in that array rather than a named field:

<tr>
  {{#headers}}<th>{{.}}</th>{{/headers}}
</tr>
{{#rows}}
<tr>
  {{#row}}<td>{{.}}</td>{{/row}}
</tr>
{{/rows}}

Getting started

Product modules

Security

Model context protocol (MCP)

Pricing models

Third-party integrations

Zenskar versioning

Overview

1. Global and header variables

2. Party information

2.1 Customer

2.2 Seller

3. Document lines and entitlement deduction

4. Usage details table (`aggregate_logs`)

​Overview

​1. Global and header variables

​2. Party information

​2.1 Customer

​2.2 Seller

​3. Document lines and entitlement deduction

​4. Usage details table (aggregate_logs)

Overview

1. Global and header variables

2. Party information

2.1 Customer

2.2 Seller

3. Document lines and entitlement deduction

4. Usage details table (`aggregate_logs`)