Interface FlagsConfig

Flags used to enable or disable certain features in the sdk.

interface FlagsConfig {
    applePayBrandingLogoEnabled?: boolean;
    autoCollectUTMAsMetadata?: boolean;
    collectAnalyticsEvents?: boolean;
    hideBackButton?: boolean;
    storeLoadTime?: StoreLoadTime;
}

Properties

applePayBrandingLogoEnabled? autoCollectUTMAsMetadata? collectAnalyticsEvents? hideBackButton? storeLoadTime?

Properties

OptionalapplePayBrandingLogoEnabled

applePayBrandingLogoEnabled?: boolean

If set to true, the SDK injects the branding app icon as an apple-touch-icon link tag so it appears in the Apple Pay sheet. Best effort is made to not overwrite an existing apple-touch-icon on the page.

Default Value

false

OptionalautoCollectUTMAsMetadata

autoCollectUTMAsMetadata?: boolean

If set to true, the SDK will automatically collect UTM parameters and store them as at the time of purchase.

Default Value

true

OptionalcollectAnalyticsEvents

collectAnalyticsEvents?: boolean

If set to true, the SDK will automatically collect analytics events.

Default Value

true

OptionalhideBackButton

hideBackButton?: boolean

If set to true, the checkout back button will be hidden.

Default Value

false

OptionalstoreLoadTime

storeLoadTime?: StoreLoadTime

Determines when the store module (e.g. Stripe) is loaded.

  • "configuration": Preloaded when the SDK is configured (default).
  • "purchase_start": Loaded on demand when a purchase is started.

Default Value

"configuration"

Deprecated

we always load stripe only when needed

Settings

Member Visibility

On This Page

Properties