Interface Offering

An offering is a collection of Package available for the user to purchase. For more info see https://docs.revenuecat.com/docs/entitlements

interface Offering {
    annual: null | Package;
    availablePackages: Package[];
    hasPaywall: boolean;
    identifier: string;
    lifetime: null | Package;
    metadata: null | { [key: string]: unknown };
    monthly: null | Package;
    packagesById: { [key: string]: Package };
    serverDescription: string;
    sixMonth: null | Package;
    threeMonth: null | Package;
    twoMonth: null | Package;
    webCheckoutURL?: null | string;
    weekly: null | Package;
}

Properties

annual availablePackages hasPaywall identifier lifetime metadata monthly packagesById serverDescription sixMonth threeMonth twoMonth webCheckoutURL? weekly

Properties

Readonlyannual

annual: null | Package

Annual package type configured in the RevenueCat dashboard, if available.

ReadonlyavailablePackages

availablePackages: Package[]

A list of all the packages available for purchase.

ReadonlyhasPaywall

hasPaywall: boolean

Whether this offering has an attached paywall configured in the RevenueCat dashboard.

Readonlyidentifier

identifier: string

Unique identifier defined in RevenueCat dashboard.

Readonlylifetime

lifetime: null | Package

Lifetime package type configured in the RevenueCat dashboard, if available.

Readonlymetadata

metadata: null | { [key: string]: unknown }

Offering metadata defined in RevenueCat dashboard.

Readonlymonthly

monthly: null | Package

Monthly package type configured in the RevenueCat dashboard, if available.

ReadonlypackagesById

packagesById: { [key: string]: Package }

A map of all the packages available for purchase keyed by package ID.

ReadonlyserverDescription

serverDescription: string

Offering description defined in RevenueCat dashboard.

ReadonlysixMonth

sixMonth: null | Package

Six month package type configured in the RevenueCat dashboard, if available.

ReadonlythreeMonth

threeMonth: null | Package

Three month package type configured in the RevenueCat dashboard, if available.

ReadonlytwoMonth

twoMonth: null | Package

Two month package type configured in the RevenueCat dashboard, if available.

Optional ReadonlywebCheckoutURL

webCheckoutURL?: null | string

The default web checkout URL for this offering, if available.

Readonlyweekly

weekly: null | Package

Weekly package type configured in the RevenueCat dashboard, if available.

Settings

Member Visibility

On This Page

Properties