| Invoice Information | |
| [% date %] | Today’s date. |
| [% merchant %] | Your merchant name as it is currently defined in Subscribe. Note: If this value is not as you expect, please work with your Vindicia Client Support contact to change it. |
| [% invoice_num %] | The auto-generated Invoice Number. This will be based on the Merchant AutoBill Identifier with a sequence number identifying the billing covered, for example: SUBMONTHLYAhd38-00000003. If you do not define Merchant AutoBill Identifiers for subscriptions, the VID will be used in its place. |
| [% opening_balance %] | The amount after payments have been subtracted from the balance forward. |
| [% payment_type %] | The payment type (MAP, CC, EDD, etc.) used to make payment of the balance due. |
| [% balance_forward %] | The balance carried forward from previous invoices. |
| [% balance_due %] | The balance due after all payments, credits, charges and taxes have been applied to the balance forward. |
| [% transaction_id %] | Unique identifier, generated by Subscribe for the Invoice. Note: This field will be populated only after a payment is made against the Invoice. |
| [% invoice_date %] | The date the invoice was created and sent. |
| [% currency %] | The currency used for the transaction. |
| [% payment_due_date %] | The date the invoice becomes due. |
| Customer Information | |
| [% cust_name %] | The customer’s name. |
| [% cust_email_address %] | The customer’s email address. |
| [% cust_address %] | The customer’s address. A concatenation of all available customer address information. For example: 1820 Gateway St\{sep\}Apt. A{sep}Foster City, California 94403${sep}US |
| [% cust_address_street1 %] | The customer’s street address (1st line). |
| [% cust_address_street2 %] | The customer’s street address (2nd line). |
| [% cust_address_street3 %] | The customer’s street address (3rd line). |
| [% cust_address_city %] | The customer’s city. |
| [% cust_address_district %] | The customer’s state. |
| [% cust_address_postal_code %] | The customer’s zip code. |
| [% cust_address_city_dist %] | The customer’s city, state, and zip code. For example: Foster City, California 94403 |
| Payments | |
| [% total_payments %] | Currency value of all the payments. |
| [% payments %] | An array of payments applied to the AutoBill. [% FOR x IN payments %] [% x.type %] [% x.date %] [% x.amount %] [% END %] |
| type | Used with the [% payments %] tag to retrieve the type of payment used. |
| date | Used with the [% payments %] tag to retrieve the date the payment was applied to the account. |
| amount | Used with the [% payments %] tag to retrieve the payment amount. |
| Credits | |
| [% total_credits %] | Currency value total of all credits. |
| [% credits %] | An array of credits applied to the AutoBill. [% FOR y IN credits %] [% y.credit_date %] [% y.credit_amount %] [% END %] |
| date | Used with the [% credits %] tag to retrieve the date the credit was made to the account. |
| amount | Used with the [% credits %] tag to retrieve the credit amount. |
| Charges | |
| [% total_charges %] | Currency value total of all charges. |
| [% charges %] | An array of charges applied to the AutoBill. [% FOR c IN charges %] [% c.product %] [% c.desc %] [% c.price %] [% c.quantity %] [% c.total %] [% c.rate_plan_id %] [% c.rate_plan_description %] [% c.included_units %] [% c.min_fee %] [% c.max_fee %] [% c.unit_name_singular %] [% c.unit_name_plural %] [% c.unit_total_amount %] [% c.unit_amount_and_name %] [% c.rate_plan_tiers %] [% c.rated_unit_events %] [% END %] |
| product | Used with the [% charges %] tag to retrieve the Product’s ID. |
| desc | Used with the [% charges %] tag to retrieve the Product’s description. |
| price | Used with the [% charges %] tag to retrieve the Product’s price. |
| quantity | Used with the [% charges %] tag to retrieve the number of Products. |
| total | Used with the [% charges %] tag to retrieve the total charge. |
| rate_plan_id | Your Rate Plan ID. |
| rate_plan_description | Your description for the Rate Plan. |
| included_units | The number of Units included with the Rate Plan. |
| min_fee | The minimum fee for the Rate Plan. |
| max_fee | The maximum fee for the Rate Plan. |
| unit_name_singular | The singular version of the Unit name. |
| unit_name_plural | The plural version of the Unit name. |
| unit_total_amount | The total number of reported Units. |
| unit_amount_and_name | The number and name of the reported Units. (Subscribe will automatically return the singular or plural name, dependent upon the reported number of Units.) |
| [% rate_plan_tiers %] | An array of all the Tiers in the Rate Plan. [% FOR t in c.rate_plan_tiers %] [% t.tier_name %] [% t.tier_begins_at_level %] [% t.tier_ends_at_level %] [% t.tier_rate_price %] [% t.tier_rated_units_tier_total %] [% t.tier_cost_total %] [% END %] |
| tier_name | Used with the [% rate_plan_tiers %] tag to retrieve the name of the Tier. |
| tier_begins_at_level | Used with the [% rate_plan_tiers %] tag to retrieve the beginsAtLevel for the Tier. |
| tier_ends_at_level | Used with the [% rate_plan_tiers %] tag to retrieve the endsAtLevel for the Tier. |
| tier_rate_price | Used with the [% rate_plan_tiers %] tag to retrieve the ratePrice for the Tier. |
| tier_rated_units_tier_total | Used with the [% rate_plan_tiers %] tag to retrieve the number of Rated Units reported for the Tier. |
| tier_cost_total | Used with the [% rate_plan_tiers %] tag to retrieve the total charge for the Tier. |
| [% rated_unit_events %] | An array of all (unbilled) Rated Unit Events applied to the AutoBill. [% FOR e IN c.rated_unit_events %] [% e.event_date %] [% e.received_date %] [% e.amount %] [% e.unit_name %] // singular or plural, based on # of units [% e.description %] [% e.rate_plan_id %] [% e.rate_plan_description %] [% e.product_id %] [% e.product_description %] [% END %] |
| event_date | Used with the [% rated_unit_events %] tag to retrieve the date the specified Event occurred, or the date the Event was reported to Subscribe. |
| received_date | Used with the [% rated_unit_events %] tag to retrieve the date the event was received. |
| amount | Used with the [% rated_unit_events %] tag to retrieve the number of Rated Units included in the Event. |
| unit_name | Used with the [% rated_unit_events %] tag to retrieve the name for the Unit associated with the Event. Subscribe will automatically return the singular or plural version of the name, dependent upon the number of Units reported for the Event. |
| description | Used with the [% rated_unit_events %] tag to retrieve the description for the Event. |
| rate_plan_id | Used with the [% rated_unit_events %] tag to retrieve the Rate Plan ID for the Event. |
| rate_plan_description | Used with the [% rated_unit_events %] tag to retrieve the description for the Rate Plan associated with the Event. |
| product_id | Used with the [% rated_unit_events %] tag to retrieve the Product ID associated with the Event. |
| product_description | Used with the [% rated_unit_events %] tag to retrieve the description for the Product associated with the Event. |
| Taxes | |
| [% tax %] | The total of all taxes applied to the Invoice. |
| [% taxes %] | An array of taxes applied to the AutoBill. [% FOR t IN taxes %] [% t.description %] [% t.amount %] [% END %] |
| description | Used with the [% taxes %] tag to retrieve the description of the tax. |
| amount | Used with the [% taxes %] tag to retrieve the amount of the tax. |
| tax_exemption_id | The Tax Exemption Code for the primary Sales Tax Exemption defined for this Account. The most common example is the customer VAT ID—also known as the VAT Registration Number or VAT Identification number (VATIN). |
| [% cust_address_city_dist_country %] | The customer city, state, zip/postal code, and country. For example: Foster City, California, 94403 US. |
| Parent topic:Working with Invoices | |