v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Addresses::Region

List Country Regions

List the regions (states/provinces) of a country. Use a region's code or name as the address region value. Many countries have no regions.

get/addresses/countries/{country_id}/regions

country_idstring required

The country's ISO 3166-1 alpha-2 code (e.g. "US").

codestring nullable required

Region/state code (e.g. "CA"). Pass this (or name) as the address region value.

namestring required

Region/state name (e.g. "California").

localized_namestring

Region name localized to the request's locale.

country_codestring

The country's ISO 3166-1 alpha-2 code.

[
  {
    "code": "CA",
    "name": "California",
    "localized_name": "California",
    "country_code": "US"
  }
]