Example address object
{
"object": "address",
"id": 64471546,
"address1": "12, rue de Cléry",
"address2": null,
"city": "Paris",
"company_title": "ACME corp",
"country": "France",
"country_code": "FR",
"first_name": "Alice",
"last_name": "Dubois",
"name": "Alice Dubois",
"state": null,
"state_code": null,
"zip": "75002"
}
An address
is a physical address. It can be used as a billing address, a shipping address or as the location of a delivery event.
FIELD | DESCRIPTION |
---|---|
id integer | Unique identifier of the address |
address1 string | Street address, including street number |
address2 string | Optional additional field for the street address |
city string | City, town or village |
company_title string | Name of the company (for business addresses) |
country string | Country name. This is for presentation only and the below country_code field should be provided in priority |
country_code string, 2 letter ISO code, e.g. FR or GB | Country code |
first_name string | Address first name |
last_name string | Address last name |
name string | Address full name |
state string | State name. This is for presentation only and the below state_code should be provided in priority |
state_code string, 2 letter ISO code (US and CA), e.g. NY | State code (US and Canada only) |
zip string | Postal code (zip, postcode, Eircode, …) |