This object represents a physical location, and includes attributes such as street address, city, state/province, postal code, and country. This object provides a structured way to store and manage location information, making it easier to process and retrieve accurate address details within your application.
Address object
Attribute | Description | |
---|---|---|
id | int | A unique identifier for this address assigned by the system. |
type | string | The address type, one of shipping or billing . |
user_id | int | The unique identifier of the customer this address belongs to. expandable |
is_default | boolean | A flag indicating whether this is the customer's default address (true) or not (false). A customer can have only one default address of the same type set at all times. |
first_name | string¦null | The customer's first name. |
last_name | string¦null | The customer's last name. |
line1 | string | The first line of the address, typically containing the street number and street name. |
line2 | string¦null | The second line of the address, which can be used for apartment number, suite number, etc. |
city | string¦null | The name of a city, town, village, etc. |
state | string¦null | The two-letter code of the state, region, or province. Learn more here. |
country | string | The two-letter code of the country, as specified by ISO 3166 alpha-2 standard. |
postal_code | string¦null | Postal code or zip associated with the address. |
company | string¦null | The company name associated with the address. |
salutation | string¦null | A salutation for the address, such as Mr., Ms., Dr. |
title | string¦null | The customer's title within the company. |
department | string¦null | The department associated with the address. |
phone | string¦null | Numeric phone number associated with the address. |
old_provider_id | string¦null | An optional field that might contain an identifier used by a previous system for this address. |
created_at | int | Unix timestamp (seconds since epoch) of when the address was created. |
updated_at | int¦null | Unix timestamp (seconds since epoch) of when the address was last updated. |