Skip to content

Payload branch "billing"

Every aspect of the current checkout's "billing side" will be grouped into this branch; please note that some kind of scenarios require a mandatory step, so sometime this entities are not representing general user's choices.

Let's review an example:

js
{
  "context": "...",
  "event": "...",
  "checkout_step": "...",
  "attributes": {...},
  "products": [...],
  "carrier": {...},
  "payment": {...},
  "delivery": {...},
  "billing": {
    "address": {
      "firstname": "FABIO",
      "lastname": "POLITI",
      "company": "",
      "address1": "VIA TOLOI",
      "address2": "40",
      "postcode": "00052",
      "city": "CERVETERI",
      "phone": "3471123000",
      "phone_mobile": "3471123000",
      "fax": null,
      "vat_number": "PLTFBA83A14H501I",
      "cf": "PLTFBA83A14H501I",
      "extrainfo": "f.politi@icoa.it",
      "country_name": "Italia",
      "state_name": "Roma"
    },
    "invoice_required": false
  },
  "user": {...},
  "engagements": {...}
}

Variables full details

Here you can find a detailed description of each variable or sub-branch:

VarTypeDescription
addressobject/nullChoosen billing address (if exists/defined)
invoice_requiredbooleanInvoice is required for billing

Object: "address"

This object holds informations about a general "address" (both shipping or billing), and it is always defined with these variables:

VarTypeDescription
firstnamestring/nullAddress's holder firstname (if person)
lastnamestring/nullAddress's holder lastname (if person)
companystring/nullAddress's holder company (if NOT person)
address1stringAddress's part (1)
address2stringAddress's part (2)
postcodestringAddress's postcode/zipcode
citystringAddress's city/location
phonestringAddress's phone
phone_mobilestring/nullAddress's mobile phone
faxstring/nullAddress's fax number
vat_numberstring/nullAddress's VAT number
cfstring/nullAddress holder fiscal code
extrainfostring/nullAddress's additional info
country_namestringAddress's country name (translated)
state_namestringAddress's state/province name (translated)

Released under the MIT License.