Skip to main content
Anchor to CustomerAddressInput

CustomerAddressInput

input_object

The input fields to create or update a mailing address.

•String

The first line of the address. Typically the street address or PO Box number.

•String

The second line of the address. Typically the apartment, suite, or unit number.

•String

The name of the city, district, village, or town.

•String

The name of the customer's company or organization.

•String

The first name of the customer.

•String

The last name of the customer.

•String

The customer's unique phone number, formatted using E.164 standard. For example, +16135551111.

•String

The country code, in ISO 3166-1 format. Accepts either a two-letter alpha-2 code, a three-letter alpha-3 code, or a three-digit numeric code. For example, US, USA, or 840 represents the United States.

•String

The zip or postal code of the address.

•String

The alphanumeric code for the region of the address, such as the province, state, or district. For example, 'ON' for Ontario, Canada.


Was this section helpful?