Address Object Fields
Learn about the fields used to model addresses of physical locations.
These field references describe the fields in an address object.
The following fields are available:
| Field | Type | Pattern | Min | Max | Description |
|---|---|---|---|---|---|
country_subdivision_code | String | — | — | 6 | The four-letter ISO code for the state or province that represents the subdivision. For example, use US-CA for California. Leave this field blank if it is not required. |
city | String | — | — | 256 | The name of the city. |
postal_code | String | — | — | 256 | The postal code. |
county | String | — | — | 256 | The name of the county. |
country_code | String | ^[A-Z]{2}$ | 2 | 2 | The two-letter ISO code for the country. If the service later uses the address to determine tax or liability, such as for physical goods, it uses this value as the geographic location unless a subdivision is specified. |
street_name | String | — | — | 256 | The street name. You can concatenate multiple lines with a comma (,). |
address_detail | String | — | — | 512 | Additional address details, such as an apartment number. |
freeform_address | String | — | — | 256 | The free-text address. |
building_number | String | — | — | 256 | The building number. |
Updated 3 months ago
Did this page help you?