Square.Connect.Model.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]

[Back to Model list] [Back to API list] [Back to README]