Skip to main content

Subscription 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 subscription, you would use

{{package.line_items[0].item_name}}.

If you wanted to see the name of the second line item, you would use the merge tag

{{package.line_items[1].item_name}}.

Merge Tag

Type

Description

{{package.line_items[0].line_item_id}}integerLine item ID #
{{package.line_items[0].package_id}}integerSubscription ID #
{{package.line_items[0].admin_id}}integerAdmin worker ID # (sales rep)
{{package.line_items[0].item_external_key}}stringItem external key
{{package.line_items[0].item_id}}integerItem ID # for this line
{{package.line_items[0].item_name}}stringItem name
{{package.line_items[0].item_external_key}}}}stringItem external key
{{package.line_items[0].item_accounting_sku}}stringItem accounting SKU
{{package.line_items[0].item_token}}stringItem token
{{package.line_items[0].item_units}}float
{{package.line_items[0].item_type}}stringItem type
{{package.line_items[0].item_is_usage}}booleanWhether or not the item is usage-based/metered
{{package.line_items[0].line_item_bundle_id}}integerItem bundle ID #
{{package.line_items[0].tierset_id}}integerTierset ID # for this line
{{package.line_items[0].nickname}}stringNickname for this line of the subscription
{{package.line_items[0].descrip}}stringDescription
{{package.line_items[0].trial_days}}integer(Deprecated - see trial recurs)
{{package.line_items[0].trial_units}}float
{{package.line_items[0].trial_recurs}}integer# of free trial cycles/cycles to skip
{{package.line_items[0].expire_datetime}}datetime
{{package.line_items[0].expire_recurs}}integer# of invoices to occur on before expiring
{{package.line_items[0].line_quantity}}floatQuantity
{{package.line_items[0].subscribe_datetime}}datetimeThe date/time this line item was last upgraded, downgraded, or added
{{package.line_items[0].subscribe_prorate_from_datetime}}datetime
{{package.line_items[0].subscribe_prorate_to_datetime}}datetime
{{package.line_items[0].cancel_datetime}}datetimeThe date/time this line item was cancelled
{{package.line_items[0].custom_1}}mixedCustom field #1
{{package.line_items[0].custom_2}}mixedCustom field #2
{{package.line_items[0].custom_3}}mixedCustom field #3
{{package.line_items[0].custom_4}}mixedCustom field #4
{{package.line_items[0].custom_5}}mixedCustom field #5
{{package.line_items[0].custom_6}}mixedCustom field #6
{{package.line_items[0].custom_7}}mixedCustom field #7
{{package.line_items[0].custom_8}}mixedCustom field #8
{{package.line_items[0].custom_9}}mixedCustom field #9
{{package.line_items[0].custom_10}}mixedCustom field #10
{{package.line_items[0].custom_11}}mixedCustom field #11
{{package.line_items[0].custom_12}}mixedCustom field #12
{{package.line_items[0].custom_13}}mixedCustom field #13
{{package.line_items[0].custom_14}}mixedCustom field #14
{{package.line_items[0].custom_15}}mixedCustom field #15
{{package.line_items[0].custom_16}}mixedCustom field #16
{{package.line_items[0].custom_17}}mixedCustom field #17
{{package.line_items[0].custom_18}}mixedCustom field #18
{{package.line_items[0].custom_19}}mixedCustom field #19
{{package.line_items[0].custom_20}}mixedCustom field #20
{{package.line_items[0].tierset}}arrayThe pricing for the line item