models/com.revenuecat.purchases.kmp.models/Offering

Offering

interface Offering

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

Properties

abstract val annual: Package?

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

availablePackages

abstract val availablePackages: List<Package>

Array of Package objects available for purchase.

abstract val identifier: String

Unique identifier defined in RevenueCat dashboard.

abstract val lifetime: Package?

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

abstract val metadata: Map<String, Any>

Offering metadata defined in RevenueCat dashboard.

abstract val monthly: Package?

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

serverDescription

abstract val serverDescription: String

Offering description defined in RevenueCat dashboard.

abstract val sixMonth: Package?

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

abstract val threeMonth: Package?

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

abstract val twoMonth: Package?

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

abstract val weekly: Package?

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

Functions

open operator fun get(s: String): Package?

Retrieves a specific package by identifier, use this to access custom package types configured in the RevenueCat dashboard. Equivalent to calling getPackage.

getMetadataString

open fun getMetadataString(key: String, default: String): String

Returns the metadata value associated to key for the expected String type or default if not found, or it's not the expected String type.

open fun getPackage(identifier: String): Package?

Retrieves a specific package by identifier, use this to access custom package types configured in the RevenueCat dashboard