Skip to main content

Customers

Merge Tag

Type

Description

{{customer.customer_id}}integerCustomer ID #
{{customer.parent_customer_id}}integerParent customer ID #
{{customer.token}}stringCustomer Token
{{customer.superuser_id}}integerMain contact ID #
{{customer.external_key}}stringExternal key value
{{customer.display_as}}stringDeprecated
{{customer.company}}stringCompany/customer name
{{customer.language_id}}integerLanguage ID #
{{customer.currency_id}}integerCurrency ID #
{{customer.currency_iso4217}}stringISO 2417 currency code representation
{{customer.currency_symbol}}stringSymbol for currency ($, £, etc.)
{{customer.class_id}}integerDefault class tracking ID #
{{customer.admin_id}}integerAdmin/Worker ID #
{{customer.campaign_id}}integerCampaign/lead source ID #
{{customer.superuser_username}}stringMain contact username
{{customer.superuser_email}}stringMain contact e-mail address
{{customer.superuser_name}}stringMain contact name
{{customer.superuser_first_name}}stringMain contact first name
{{customer.superuser_last_name}}stringMain contact last name
{{customer.superuser_phone}}stringMain contact phone number
{{customer.superuser_token}}stringMain contact token
{{customer.superuser_title}}stringMain contact title
{{customer.bill_addr1}}stringBilling address line 1
{{customer.bill_addr2}}stringBilling address line 2
{{customer.bill_addr3}}stringBilling address line 3
{{customer.bill_city}}stringBilling address city
{{customer.bill_state}}stringBilling address state/province
{{customer.bill_postcode}}stringBilling address postal code
{{customer.bill_country}}stringBilling address country
{{customer.bill_block}}stringPrintable billing address
{{customer.ship_addr1}}stringShip address line 1
{{customer.ship_addr2}}stringShip address line 2
{{customer.ship_addr3}}stringShip address line 3
{{customer.ship_city}}stringShip address city
{{customer.ship_state}}stringShip address state/province
{{customer.ship_postcode}}stringShip address postal code
{{customer.ship_country}}stringShip address country
{{customer.ship_block}}stringPrintable shipping address
{{customer.custom_1}}mixedCustom field #1
{{customer.custom_2}}mixedCustom field #2
{{customer.custom_3}}mixedCustom field #3
{{customer.custom_4}}mixedCustom field #4
{{customer.custom_5}}mixedCustom field #5
{{customer.custom_6}}mixedCustom field #6
{{customer.custom_7}}mixedCustom field #7
{{customer.custom_8}}mixedCustom field #8
{{customer.custom_9}}mixedCustom field #9
{{customer.custom_10}}mixedCustom field #10
{{customer.custom_11}}mixedCustom field #11
{{customer.custom_12}}mixedCustom field #12
{{customer.custom_13}}mixedCustom field #13
{{customer.custom_14}}mixedCustom field #14
{{customer.custom_15}}mixedCustom field #15
{{customer.custom_16}}mixedCustom field #16
{{customer.custom_17}}mixedCustom field #17
{{customer.custom_18}}mixedCustom field #18
{{customer.custom_19}}mixedCustom field #19
{{customer.custom_20}}mixedCustom field #20
{{customer.write_datetime}}stringDate/time this customer was created
{{customer.write_ipaddr}}stringIP address that created this customer
{{customer.mod_datetime}}stringDate/time this customer was updated
{{customer.mod_ipaddr}}stringIP address that updated this customer
{{customer.mod_ipaddr}}stringIP address that updated this customer
{{customer.brand_id}}integerBrand ID #
{{customer.class_name}}stringClass name
{{customer.terms_id}}integerDefault terms ID #
{{customer.terms_name}}stringDefault payment terms
{{customer.terms_days}}integer# of days for the default payment terms
{{customer.url_statementlink}}stringURL the customer can visit to view their monthly statement
{{customer.url_paymethodlink}}stringURL the customer can visit to update their payment method
{{customer.url_self}}stringURL for viewing the customer in the GUI
{{customer.admin_name}}stringAdmin/Worker name
{{customer.email}}stringAdmin/Worker email
{{customer.status_id}}integerCustomer status ID #
{{customer.customer_status_name}}stringHuman-friendly customer status
{{customer.customer_status_str}}stringStatus string
{{customer.customer_status_state}}stringStatus code
{{customer.default_paymethod}}stringDefault payment method type
{{customer.default_creditcard_id}}integerDefault credit card ID # (if the default payment method is a credit card)
{{customer.default_ach_id}}integerDefault ACH/eCheck ID # (if the default payment method is ACH)
{{customer.no_taxes}}booleanFlag to disable charging of taxes
{{customer.no_dunning}}booleanFlag to disable dunning
{{customer.no_latefees}}booleanFlag to disable late fees
{{customer.no_procfees}}booleanFlag to disable processing fees
{{customer.invoice_delivery}}enum[print,email]Delivery method for initial invoices ("email" or "print" for printed hard-copy via Docsaway, Lob, etc.)
{{customer.dunning_delivery}}enum[print,email]Delivery method for dunning/reminder invoices ("email" or "print" for printed hard-copy via Docsaway, Lob, etc.)
{{customer.tax_ident}}stringTax ID #/VAT #
{{customer.total}}floatThe sum total amount of all invoices ever issued to this customer (lifetime value)
{{customer.balance}}floatBalance due for this customer
{{customer.paid}}floatThe lifetime net total payments minus refunds this customer has made
{{customer.mrr}}floatCurrent monthly recurring revenue of the customer
{{customer.arr}}floatCurrent annual recurring revenue of the customer
{{customer.tags}}arrayA list of tags