Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
26 lines (21 loc) · 2.12 KB

Address.md

File metadata and controls

26 lines (21 loc) · 2.12 KB

SquareConnect.Address

Description

Represents a physical address.

Properties

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