Interface Product

Represents product's listing details.

interface Product {
    currentPrice: Price;
    defaultNonSubscriptionOption: null | NonSubscriptionOption;
    defaultPurchaseOption: PurchaseOption;
    defaultSubscriptionOption: null | SubscriptionOption;
    description: null | string;
    displayName: string;
    identifier: string;
    normalPeriodDuration: null | string;
    presentedOfferingContext: PresentedOfferingContext;
    presentedOfferingIdentifier: string;
    productType: ProductType;
    subscriptionOptions: {
        [optionId: string]: SubscriptionOption;
    };
    title: string;
}

Properties

currentPrice defaultNonSubscriptionOption defaultPurchaseOption defaultSubscriptionOption description displayName identifier normalPeriodDuration presentedOfferingContext presentedOfferingIdentifier productType subscriptionOptions title

Properties

Readonly currentPrice

currentPrice: Price

Price of the product. This will match the default option's base phase price in subscriptions or the price in non-subscriptions.

Readonly defaultNonSubscriptionOption

defaultNonSubscriptionOption: null | NonSubscriptionOption

The default non-subscription option for this product. Null in the case of subscriptions.

Readonly defaultPurchaseOption

defaultPurchaseOption: PurchaseOption

The default purchase option for this product.

Readonly defaultSubscriptionOption

defaultSubscriptionOption: null | SubscriptionOption

The default subscription option for this product. Null if no subscription options are available like in the case of consumables and non-consumables.

Readonly description

description: null | string

The description of the product as configured in the RevenueCat dashboard.

Readonly displayName

displayName: string

Name of the product.

Deprecated

Readonly identifier

identifier: string

The product ID.

Readonly normalPeriodDuration

normalPeriodDuration: null | string

The period duration for a subscription product. This will match the default option's base phase period duration. Null for non-subscriptions.

Readonly presentedOfferingContext

presentedOfferingContext: PresentedOfferingContext

The context from which this product was obtained.

Readonly presentedOfferingIdentifier

presentedOfferingIdentifier: string

The offering ID used to obtain this product.

Deprecated

Readonly productType

productType: ProductType

The type of product.

Readonly subscriptionOptions

subscriptionOptions: {
    [optionId: string]: SubscriptionOption;
}

A dictionary with all the possible subscription options available for this product. Each key contains the key to be used when executing a purchase. Will be empty for non-subscriptions

If retrieved through getOfferings the offers are only the ones the customer is entitled to.

Type declaration

Readonly title

title: string

The title of the product as configured in the RevenueCat dashboard.

Settings

Member Visibility

Theme

On This Page

currentPricedefaultNonSubscriptionOptiondefaultPurchaseOptiondefaultSubscriptionOptiondescriptiondisplayNameidentifiernormalPeriodDurationpresentedOfferingContextpresentedOfferingIdentifierproductTypesubscriptionOptionstitle