Address

Description

The Address object contains all address details. This object can represent a billing address, a shipping address, or both.

Properties

TypeNameDescription
stringFirstNameFirst name of the user.
stringLastNameLast name of the user.
stringCompanyName

Company or organization name of the user.

Note: When a company name is unavailable, provide the first and last name of the user.

stringAddress1Street address line 1.
stringAddress2Street address line 2.
stringAddress3Street address line 3.
stringAddress4Street address line 4.
stringAddress5Street address line 5.
stringAddress6Street address line 6.
stringCityCity of the user.
stringStateState or province of the user.
stringZipCodeZip or postal code of the user.
stringCountryTwo-character ISO-3166-1 country code.
Examples
  • US for United States
  • CA for Canada
booleanIsDefaultIndicates whether this is the default address for the user.
stringAddressIdUnique identifier for the address.