Invoice Line Items

Note that for merge tags for line items, the number in brackets in the merge tag corresponds to which line the item is on the invoice, quote, or subscription.

For example, if you want to see the name of the first line item on an invoice, you would use {{invoice.line_items[0].item_name}}.

If you wanted to see the name of the second line item, you would use the merge tag {{invoice.line_items[1].item_name}}.

Merge Tag	Type	Description
{{invoice.line_items[0].line_item_id}}	integer	Invoice Line ID #
{{invoice.line_items[0].invoice_id}}	integer	Invoice ID #
{{invoice.line_items[0].admin_id}}	integer	Admin worker/sales rep ID #
{{invoice.line_items[0].item_id}}	string	Item ID # for this line
{{invoice.line_items[0].item_name}}	string	Item name
{{invoice.line_items[0].item_accounting_sku}}	string	Item accounting SKU
{{invoice.line_items[0].item_external_key}}	string	Item external key
{{invoice.line_items[0].item_token}}	string	Item token
{{invoice.line_items[0].item_units}}	string	Item units
{{invoice.line_items[0].item_type}}	string	Item type
{{invoice.line_items[0].invoice_line_bundle_id}}	integer	Invoice line bundle ID #
{{invoice.line_items[0].paycycle}}	string	Payment cycle
{{invoice.line_items[0].tierset_id}}	integer	Tierset ID # for this line
{{invoice.line_items[0].package_line_id}}	integer	Subscription line ID # that this line originated from
{{invoice.line_items[0].package_line_external_key}}	string	Subscription line external key
{{invoice.line_items[0].package_obligation_id}}	integer	The contractual obligation this line counted towards
{{invoice.line_items[0].package_line_first_obligation_id}}	integer	The ID # of the first contractual obligation for the subscription line that this line originated from
{{invoice.line_items[0].descrip}}	string	Description
{{invoice.line_items[0].line_rate}}	float	Rate
{{invoice.line_items[0].line_quantity}}	float	Quantity
{{invoice.line_items[0].line_usage}}	float	Usage Value
{{invoice.line_items[0].line_subtotal}}	float	Line subtotal
{{invoice.line_items[0].line_total}}	float	Line total
{{invoice.line_items[0].usage_from}}	float
{{invoice.line_items[0].usage_to}}	float
{{invoice.line_items[0].number_of_recurs_this}}	integer	# of times this has recurred since the last up/downgrade
{{invoice.line_items[0].number_of_recurs_line}}	integer	# of times this line has recurred
{{invoice.line_items[0].tax_taxable}}	float	The total amount that was taxable
{{invoice.line_items[0].tax_taxed}}	float	The amount that tax was calculated from
{{invoice.line_items[0].tax_total}}	float	The tax amount for this line
{{invoice.line_items[0].tax_id}}	string
{{invoice.line_items[0].tax_group_id}}	string
{{invoice.line_items[0].tax_name}}	string
{{invoice.line_items[0].tax_group_name}}	string
{{invoice.line_items[0].is_usage}}	boolean	Whether or not this line item was created from usage data
{{invoice.line_items[0].is_setup}}	boolean	Whether or not this line item was a one-time setup fee
{{invoice.line_items[0].is_base}}	boolean	Whether or not this line item is the base line item for other tiered/volume/unit lines
{{invoice.line_items[0].is_free}}	boolean	Whether or not this line item was free (equal to $0.00)
{{invoice.line_items[0].is_recurring}}	boolean	Whether or not this line is recurring
{{invoice.line_items[0].is_taxed}}	boolean	Whether or not this line item was taxed/subject to VAT
{{invoice.line_items[0].is_latefee}}	boolean	Whether or not this line item was a late fee
{{invoice.line_items[0].is_obligation}}	boolean	Whether or not this line item was towards a contractual obligation
{{invoice.line_items[0].custom_1}}	mixed	Custom field #1
{{invoice.line_items[0].custom_2}}	mixed	Custom field #2
{{invoice.line_items[0].custom_3}}	mixed	Custom field #3
{{invoice.line_items[0].custom_4}}	mixed	Custom field #4
{{invoice.line_items[0].custom_5}}	mixed	Custom field #5
{{invoice.line_items[0].custom_6}}	mixed	Custom field #6
{{invoice.line_items[0].custom_7}}	mixed	Custom field #7
{{invoice.line_items[0].custom_8}}	mixed	Custom field #8
{{invoice.line_items[0].custom_9}}	mixed	Custom field #9
{{invoice.line_items[0].custom_10}}	mixed	Custom field #10
{{invoice.line_items[0].custom_11}}	mixed	Custom field #11
{{invoice.line_items[0].custom_12}}	mixed	Custom field #12
{{invoice.line_items[0].custom_13}}	mixed	Custom field #13
{{invoice.line_items[0].custom_14}}	mixed	Custom field #14
{{invoice.line_items[0].custom_15}}	mixed	Custom field #15
{{invoice.line_items[0].custom_16}}	mixed	Custom field #16
{{invoice.line_items[0].custom_17}}	mixed	Custom field #17
{{invoice.line_items[0].custom_18}}	mixed	Custom field #18
{{invoice.line_items[0].custom_19}}	mixed	Custom field #19
{{invoice.line_items[0].custom_20}}	mixed	Custom field #20