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[];
    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;
    weekly: null | Package;
}

Properties

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

Properties

Readonly annual

annual: null | Package

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

Readonly availablePackages

availablePackages: Package[]

A list of all the packages available for purchase.

Readonly identifier

identifier: string

Unique identifier defined in RevenueCat dashboard.

Readonly lifetime

lifetime: null | Package

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

Readonly metadata

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

Offering metadata defined in RevenueCat dashboard.

Type declaration

  • [key: string]: unknown

Readonly monthly

monthly: null | Package

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

Readonly packagesById

packagesById: {
    [key: string]: Package;
}

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

Type declaration

Readonly serverDescription

serverDescription: string

Offering description defined in RevenueCat dashboard.

Readonly sixMonth

sixMonth: null | Package

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

Readonly threeMonth

threeMonth: null | Package

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

Readonly twoMonth

twoMonth: null | Package

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

Readonly weekly

weekly: null | Package

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

Settings

Member Visibility

Theme

On This Page

annualavailablePackagesidentifierlifetimemetadatamonthlypackagesByIdserverDescriptionsixMonththreeMonthtwoMonthweekly