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
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
region | Chrome
Full support
61
| Edge Full support 15 | Firefox
Full support
56
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
Full support
56
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
- See implementation notes.
- User must explicitly enable this feature.
- User must explicitly enable this feature.