Web/API/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 APIThe definition of 'PaymentAddress.region' in that specification.	Candidate Recommendation	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`region`	Chrome Full support 60	Edge Full support 15	Firefox No support No Notes' No support No Notes' Notes' Available only in nightly builds.	IE No support No	Opera Full support 47	Safari Full support 11.1	WebView Android No support No	Chrome Android Full support 56	Firefox Android No support No Notes' No support No Notes' Notes' Available only in nightly builds.	Opera Android Full support 44	Safari iOS Full support 11.3	Samsung Internet Android Full support Yes

Legend

Full support: Full support
No support: No support
See implementation notes.': See implementation notes.

PaymentAddress.region by Mozilla Contributors is licensed under CC-BY-SA 2.5.