These are the SparkLayer objects you can use in templates and invoice content zones. Which objects are available depends on the template: check the template's documentation to see what it receives.
Nested properties are shown with dot notation (for example dates.created_at), and [] marks an array item.
Key Type Description Example(s) namestringThe addressee's name - companystringThe company name - address_line1stringLine 1 of the address - address_line2string,nullLine 2 of the address - citystringThe city - region_codestring,nullThe region code, such as a state or county code - postal_codestring,nullThe postal code or postcode - country_codestringThe country code. Use the country filter - phonestring,nullThe phone number -
Key Type Description Example(s) idstringThe customer's SparkLayer ID - titlestringThe customer's title - first_namestringThe customer's first name - last_namestringThe customer's last name - emailstringThe customer's email address - company_namestring,nullThe customer's company name - external_idstring- - accounting_idstring- -
Content zones are configured as part of the invoicing feature. They can contain Liquid variables, so handle them accordingly in your templates.
Key Type Description Example(s) titlestring,nullThe content zone's title - contentstring,nullThe content zone's content, which can contain Liquid variables -
Key Type Description Example(s) content_zones.zone_1ContentZone Invoice content zone 1 - content_zones.zone_2ContentZone Invoice content zone 2 - content_zones.zone_3ContentZone Invoice content zone 3 -
Key Type Description Example(s) custom_attributes.[].keystringA custom attribute's key - custom_attributes.[].valuestringA custom attribute's value - identifiers.skustring,nullThe product's SKU - name_childstring,null- - name_parentstring- - quantityintegerThe quantity ordered - line_totalLineTotal or nullThe totals for the whole line - unit_totalUnitTotal or nullThe totals for one unit - image_urlstring,nullThe URL of the product's image - product_slugstring,null- - rrpMoney or nullThe recommended retail price (RRP) - barcodestring,nullThe product's barcode -
Key Type Description Example(s) total_netMoney The line total, excluding tax - discount_netMoney The discount on the line, excluding tax - tax_ratenumberThe tax rate applied to the line -
The merchant's store details.
Key Type Description Example(s) address1string,nullLine 1 of the merchant's store address - address2string,nullLine 2 of the merchant's store address - base_currencystring,nullThe base currency used by the store USD,GBP citystring,nullCity of the merchant's store address - regionstring,nullRegion code of the merchant's store address - countrystring,nullCountry code of the merchant's store address GB emailstring,nullThe merchant's email address - phonestring,nullThe merchant's store phone number - postcodestring,nullPostcode of the merchant's store address - store_namestring,nullThe connected platform's store name - timezonestring,nullThe store's time zone - urlstring,nullThe store's URL - localestring,nullThe default locale of the store en,fr
A monetary value.
Key Type Description Example(s) amountstringThe amount - currencystringThe currency code GBP,USD
Key Type Description Example(s) line_itemsarray of LineItem The line items in the package - shipping_addressAddress The address the package is shipped to -
Key Type Description Example(s) currency_codestringThe purchase's currency code - billing_addressAddress The billing address - customers.sparklayerCustomer The SparkLayer customer who placed the purchase - custom_fields.[].namestringA custom field's name - custom_fields.[].valuestring,nullA custom field's value - customer_referencestring,nullThe customer's own reference for the purchase - dates.created_atstringWhen the purchase was created - dates.updated_atstringWhen the purchase was last updated - dates.placed_atstring,nullWhen the purchase was placed - dates.calculated_submitted_atstring,null- - identifiers.visiblestringThe purchase ID shown to customers - packagesarray of Package The purchase's packages, each with its line items and shipping address - line_itemsarray of LineItem The purchase's line items - subtotalMoney The subtotal - taxMoney The total tax - shipping_costMoney The shipping cost - calculated_totalMoney The calculated total - tax_linesarray of TaxLine The tax lines that make up the total tax -
Key Type Description Example(s) total_netMoney The unit price, excluding tax - total_grossMoney The unit price, including tax - total_taxMoney The tax on one unit - tax_ratenumberThe tax rate applied -
Key Type Description Example(s) titlestringThe tax line's name - ratenumberThe tax rate - amount.numberstringThe tax amount - amount.currencystringThe tax amount's currency code -
Key Type Description Example(s) bodystringThe message's text - created_atstringWhen the message was sent - customerCustomer The customer who sent the message -
Key Type Description Example(s) assigned_byCustomer Who assigned the quote - assigned_onstringWhen the quote was assigned -
If a property doesn't behave as described here, contact our support team .
Templates : the templates you can customise and the filters they can use.Invoices : the invoice PDF and its settings. Last updated 4 October 2026
© SparkLayer™. Terms of Service. Privacy & Data Policy.
Trimbridge House, First Floor, Trim Street, Bath, BA1 1HB, United Kingdom. Registered in England & Wales, Company Number 12881913.