PaymentAddress.region

The read-only region property of the PaymentAddress interface returns a string containing the top-level administrative subdivision of the country in which the address is located. For example, this may be a state, province, oblast, or prefecture.

Syntax

var paymentRegion = PaymentAddress.region;

Value

A DOMString specifying the top-level administrative subdivision within the country in which the address is located. This region has different names in different countries, such as: state, province, oblast, prefecture, or county.

Usage notes

In some countries, like Belgium, it's uncommon for people to provide a region as part of their postal address. In such cases, the browser returns an empty string as the value of region. However, the address should still be acceptable to use for its intended purpose (e.g., to ship a product). However, always verify addresses to make sure what the user provides is usable.

Specifications

Specification Status Comment
Payment Request API
The definition of 'PaymentAddress.region' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

BCD tables only load in the browser