A storefront country code, scoped to a specific payment platform.

Returned from Store.getStorefront and passed to when().storefrontUpdated() listeners.

interface Storefront {
    countryCode?: string;
    platform: Platform;
}

Properties

countryCode?: string

ISO 3166-1 alpha-2 country code (e.g., "US", "FR").

Undefined if the value has not been fetched yet, or if the fetch failed. Never set to a falsy value once populated — a later failed refresh will preserve the previously-known country code.

platform: Platform

The platform this storefront belongs to.