Address Object- Square API Reference

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


        
  
  
          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).


        
  
  
          address_line_2
        


        

        
    string

The second line of the address, if any.


        
  
  
          address_line_3
        


        

        
    string

The third line of the address, if any.

The city or town of the address.


        
  
  
          sublocality
        


        

        
    string

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


        
  
  
          sublocality_2
        


        

        
    string

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


        
  
  
          sublocality_3
        


        

        
    string

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


        
  
  
          administrative_district_level_1
        


        

        
    string

A civil entity within the address's country. In the US, this is the state.


        
  
  
          administrative_district_level_2
        


        

        
    string

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


        
  
  
          administrative_district_level_3
        


        

        
    string

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


        
  
  
          postal_code
        


        

        
    string

The address's postal code.

The address's country, in ISO 3166-1-alpha-2 format. See Country for possible values


        
  
  
          first_name
        


        

        
    string

Optional first name when it's representing recipient.

Optional last name when it's representing recipient.


        
  
  
          organization
        


        

        
    string

Optional organization name when it's representing recipient.

Object Index / Definition

You are viewing an old version of the API

All Versions

Address

Properties

Share Feedback

Object Index / Definition You are viewing an old version of the API 2020-01-22 Version 2020-01-22 All Versions Address

Properties

Share Feedback

Object Index / Definition

You are viewing an old version of the API

All Versions

Address