Address

July 10, 2019 ยท View on GitHub

Description

Represents a physical address.

Properties

NameTypeDescriptionNotes
addressLine1StringThe 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).[optional]
addressLine2StringThe second line of the address, if any.[optional]
addressLine3StringThe third line of the address, if any.[optional]
localityStringThe city or town of the address.[optional]
sublocalityStringA civil region within the address's `locality`, if any.[optional]
sublocality2StringA civil region within the address's `sublocality`, if any.[optional]
sublocality3StringA civil region within the address's `sublocality_2`, if any.[optional]
administrativeDistrictLevel1StringA civil entity within the address's country. In the US, this is the state.[optional]
administrativeDistrictLevel2StringA civil entity within the address's `administrative_district_level_1`. In the US, this is the county.[optional]
administrativeDistrictLevel3StringA civil entity within the address's `administrative_district_level_2`, if any.[optional]
postalCodeStringThe address's postal code.[optional]
countryStringThe address's country, in ISO 3166-1-alpha-2 format. See Country for possible values[optional]
firstNameStringOptional first name when it's representing recipient.[optional]
lastNameStringOptional last name when it's representing recipient.[optional]
organizationStringOptional organization name when it's representing recipient.[optional]