description

string

The name or description of this address.

<= 256 characters

company

string

The company of the person associated with this address.

<= 256 characters

first_name

string

The customer’s first name.

<= 256 characters

last_name

string

The customer’s last name.

<= 256 characters

string

The email address of the customer.

<= 256 characters

address_line_1

string

The customer's mailing address.

<= 256 characters

address_line_2

string

An additional field for the customer's mailing address.

<= 256 characters

address_line_3

string

An additional field for the customer's mailing address.

<= 256 characters

city

string

The customer’s city, town, or village.

<= 256 characters

state

string

The customer’s region name. Typically a province, a state, or a prefecture.

<= 256 characters

country_region

string

The customer's country/region.

Example:

USA

Match pattern:

^[A-Z]{3}$

postal_code

string

The customer’s postal code, also known as zip, postcode, Eircode, etc.

<= 256 characters

phone

string

The customer’s phone number at this address.

<= 256 characters

type

string

The type of address.

Allowed values:

businessresidential

tax_number

string

Tax number for the address.

<= 256 characters

source_id

string

A unique identifier for the address.

<= 32 characters

{ "source_id": "1", "description": "My Home Address", "company": "aftership", "first_name": "teddy", "last_name": "chan", "email": "[email protected]", "address_line_1": "address2", "address_line_2": "1233", "address_line_3": null, "city": "HongKong", "state": "HKG", "country_region": "HKG", "postal_code": "12323", "phone": "+8613265883816", "type": null, "tax_number": null }