Interface PurchaseParams

Parameters used to customise the purchase flow when invoking the .purchase method.

interface PurchaseParams {
    customerEmail?: string;
    defaultLocale?: string;
    htmlTarget?: HTMLElement;
    metadata?: PurchaseMetadata;
    purchaseOption?: null | PurchaseOption;
    rcPackage: Package;
    selectedLocale?: string;
}

Properties

customerEmail? defaultLocale? htmlTarget? metadata? purchaseOption? rcPackage selectedLocale?

Properties

OptionalcustomerEmail

customerEmail?: string

The email of the user. If undefined, RevenueCat will ask the customer for their email.

OptionaldefaultLocale

defaultLocale?: string

The default locale to use if the selectedLocale is not available. Defaults to english.

OptionalhtmlTarget

htmlTarget?: HTMLElement

The HTML element where the billing view should be added. If undefined, a new div will be created at the root of the page and appended to the body.

Optionalmetadata

metadata?: PurchaseMetadata

The purchase metadata to be passed to the backend. Any information provided here will be propagated to the payment gateway and to the RC transaction as metadata.

OptionalpurchaseOption

purchaseOption?: null | PurchaseOption

The option to be used for this purchase. If not specified or null the default one will be used.

rcPackage

rcPackage: Package

The package you want to purchase. Obtained from Purchases.getOfferings.

OptionalselectedLocale

selectedLocale?: string

The locale to use for the purchase flow. If not specified, English will be used

Settings

Member Visibility

On This Page

Properties