<- Object

Object

Address

Represents a postal address in a country.

Link to section

Properties

Link to section

address_line_1

string

The first line of the address.

Fields that start with address_line provide the address's most specific details, like street number, street name, and building name. They do not provide less specific details like city, state/province, or country (these details are provided in other fields).

Link to section

address_line_2

string

The second line of the address, if any.

Link to section

address_line_3

string

The third line of the address, if any.

Link to section

locality

string

The city or town of the address. For a full list of field meanings by country, see Working with Addresses.

Link to section

sublocality

string

A civil region within the address's locality, if any.

Link to section

sublocality_2

string

A civil region within the address's sublocality, if any.

Link to section

sublocality_3

string

A civil region within the address's sublocality_2, if any.

Link to section

administrative_district_level_1

string

A civil entity within the address's country. In the US, this is the state. For a full list of field meanings by country, see Working with Addresses.

Link to section

administrative_district_level_2

string

A civil entity within the address's administrative_district_level_1. In the US, this is the county.

Link to section

administrative_district_level_3

string

A civil entity within the address's administrative_district_level_2, if any.

Link to section

postal_code

string

The address's postal code. For a full list of field meanings by country, see Working with Addresses.

Link to section

country

string

The address's country, in the two-letter format of ISO 3166. For example, US or FR.

Show values

Link to section

first_name

string

Optional first name when it's representing recipient.

Link to section

last_name

string

Optional last name when it's representing recipient.