Address
March 27, 2019 ยท View on GitHub
squareconnect.models.address
Description
Represents a physical address.
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| address_line_1 | str | 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). | [optional] |
| address_line_2 | str | The second line of the address, if any. | [optional] |
| address_line_3 | str | The third line of the address, if any. | [optional] |
| locality | str | The city or town of the address. | [optional] |
| sublocality | str | A civil region within the address's `locality`, if any. | [optional] |
| sublocality_2 | str | A civil region within the address's `sublocality`, if any. | [optional] |
| sublocality_3 | str | A civil region within the address's `sublocality_2`, if any. | [optional] |
| administrative_district_level_1 | str | A civil entity within the address's country. In the US, this is the state. | [optional] |
| administrative_district_level_2 | str | A civil entity within the address's `administrative_district_level_1`. In the US, this is the county. | [optional] |
| administrative_district_level_3 | str | A civil entity within the address's `administrative_district_level_2`, if any. | [optional] |
| postal_code | str | The address's postal code. | [optional] |
| country | str | The address's country, in ISO 3166-1-alpha-2 format. See Country for possible values | [optional] |
| first_name | str | Optional first name when it's representing recipient. | [optional] |
| last_name | str | Optional last name when it's representing recipient. | [optional] |
| organization | str | Optional organization name when it's representing recipient. | [optional] |