models/com.revenuecat.purchases.kmp.models

Package-level declarations

Types

BillingFeature

enum BillingFeature : Enum<BillingFeature>

Enum mapping billing feature types. Currently only used to check for feature availability in Android's, Play store.

CacheFetchPolicy

enum CacheFetchPolicy : Enum<CacheFetchPolicy>

Specifies behavior for a caching API.

CustomerInfo

class CustomerInfo(val activeSubscriptions: Set<String>, val allExpirationDateMillis: Map<String, Long?>, val allPurchaseDateMillis: Map<String, Long?>, val allPurchasedProductIdentifiers: Set<String>, val entitlements: EntitlementInfos, val firstSeenMillis: Long, val latestExpirationDateMillis: Long?, val managementUrlString: String?, val nonSubscriptionTransactions: List<Transaction>, val originalAppUserId: String, val originalApplicationVersion: String?, val originalPurchaseDateMillis: Long?, val requestDateMillis: Long)

Class containing all information regarding the customer.

DangerousSettings

class DangerousSettings(val autoSyncPurchases: Boolean = true)

Only use a Dangerous Setting if suggested by RevenueCat support team.

DiscountPaymentMode

enum DiscountPaymentMode : Enum<DiscountPaymentMode>

App Store only. The payment mode for a StoreProductDiscount indicates how the product discount price is charged.

DiscountType

enum DiscountType : Enum<DiscountType>

App Store only. Denotes the type of a StoreProductDiscount.

EntitlementInfo

class EntitlementInfo(val identifier: String, val isActive: Boolean, val willRenew: Boolean, val periodType: PeriodType, val latestPurchaseDateMillis: Long?, val originalPurchaseDateMillis: Long?, val expirationDateMillis: Long?, val store: Store, val productIdentifier: String, val productPlanIdentifier: String?, val isSandbox: Boolean, val unsubscribeDetectedAtMillis: Long?, val billingIssueDetectedAtMillis: Long?, val ownershipType: OwnershipType, val verification: VerificationResult)

This object gives you access to all of the information about the status of a user's entitlements.

EntitlementInfos

class EntitlementInfos(val all: Map<String, EntitlementInfo>, val verification: VerificationResult)

This class contains all the entitlements associated to the user.

EntitlementVerificationMode

enum EntitlementVerificationMode : Enum<EntitlementVerificationMode>

Verification strictness levels for EntitlementInfo.

GoogleReplacementMode

enum GoogleReplacementMode : Enum<GoogleReplacementMode> , ReplacementMode

Enum of possible replacement modes to be passed to a Play Store purchase. Ignored for Amazon and App Store purchases.

InstallmentsInfo

class InstallmentsInfo(val commitmentPaymentsCount: Int, val renewalCommitmentPaymentsCount: Int)

Type containing information of installment subscriptions. Currently only supported in Google Play.

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

Offerings

class Offerings(val all: Map<String, Offering>, val current: Offering?)

This class contains all the offerings configured in RevenueCat dashboard. For more info see https://docs.revenuecat.com/docs/entitlements

OfferPaymentMode

enum OfferPaymentMode : Enum<OfferPaymentMode>

Play Store only. Payment mode for offer pricing phases

OwnershipType

enum OwnershipType : Enum<OwnershipType>

Enum of supported ownership types for an entitlement.

Package

interface Package

Contains information about the product available for the user to purchase. For more info see /docs/entitlements.

PackageType

enum PackageType : Enum<PackageType>

Enumeration of all possible Package types.

Period

class Period(val value: Int, val unit: PeriodUnit)

Represents subscription or PricingPhase billing period.

PeriodType

enum PeriodType : Enum<PeriodType>

Enum of supported period types for an entitlement.

PeriodUnit

enum PeriodUnit : Enum<PeriodUnit>

The unit of time a Period is denoted in.

PresentedOfferingContext

class PresentedOfferingContext(val offeringIdentifier: String, val placementIdentifier: String?, val targetingContext: PresentedOfferingTargetingContext?)

Contains data about the context in which an offering was presented.

PresentedOfferingTargetingContext

class PresentedOfferingTargetingContext(val revision: Int, val ruleId: String)

The targeting context used to obtain a PresentedOfferingContext.

Price

class Price(val formatted: String, val amountMicros: Long, val currencyCode: String)

Represents a monetary price.

PricingPhase

class PricingPhase(val billingPeriod: Period, val recurrenceMode: RecurrenceMode, val billingCycleCount: Int?, val price: Price, val offerPaymentMode: OfferPaymentMode?)

Play Store only. Encapsulates how a user pays for a subscription at a given point in time.

ProductCategory

enum ProductCategory : Enum<ProductCategory>

The category of a product, whether a subscription or a one-time purchase.

ProductType

enum ProductType : Enum<ProductType>

Possible product types.

PromotionalOffer

interface PromotionalOffer

App Store only. Represents a StoreProductDiscount that has been validated and is ready to be used for a purchase.

PurchasesAreCompletedBy

sealed interface PurchasesAreCompletedBy

Modes for completing the purchase process.

PurchasesError

class PurchasesError(val code: PurchasesErrorCode, val underlyingErrorMessage: String? = null)

This class represents an error

PurchasesErrorCode

enum PurchasesErrorCode : Enum<PurchasesErrorCode>

A predefined error type.

PurchasesException

open class PurchasesException(val error: PurchasesError) : Exception

An exception wrapping a PurchasesError.

PurchasesTransactionException

class PurchasesTransactionException(purchasesError: PurchasesError, val userCancelled: Boolean) : PurchasesException

An exception indicating an error occurred during a transaction. Extends PurchasesException by adding a userCancelled property.

PurchasingData

interface PurchasingData

Data connected to a purchase.

RecurrenceMode

enum RecurrenceMode : Enum<RecurrenceMode>

Recurrence mode for a pricing phase. Google Play Store only.

ReplacementMode

interface ReplacementMode

Contains information about the replacement mode to use in case of a product upgrade. Use the platform specific subclasses in each implementation. Currently only used for Play store upgrades/downgrades

Store

enum Store : Enum<Store>

Enum of supported stores

StoreKitVersion

enum StoreKitVersion : Enum<StoreKitVersion>

Defines which version of StoreKit may be used.

StoreMessageType

enum StoreMessageType : Enum<StoreMessageType>

Enum mapping in-app message types.

StoreProduct

interface StoreProduct

Represents an in-app product's or subscription's listing details.

StoreProductDiscount

interface StoreProductDiscount

App Store only. Information about a subscription offer that you configured in App Store Connect.

StoreTransaction

class StoreTransaction(val transactionId: String?, val productIds: List<String>, val purchaseTime: Long)

Represents an in-app billing purchase.

SubscriptionOption

interface SubscriptionOption

Play Store only. A purchase-able entity for a subscription product.

SubscriptionOptions

interface SubscriptionOptions

A collection of SubscriptionOptions.

Transaction

class Transaction(val transactionIdentifier: String, val productIdentifier: String, val purchaseDateMillis: Long)

Representation of a transaction.

VerificationResult

enum VerificationResult : Enum<VerificationResult>

The result of the verification process.

Properties

billingPeriod

val SubscriptionOption.billingPeriod: Period?

The subscription period of fullPricePhase (after free and intro trials).

freePhase

val SubscriptionOption.freePhase: PricingPhase?

The free trial PricingPhase of the subscription. Looks for the first pricing phase of the SubscriptionOption where amountMicros is 0. There can be a freeTrialPhase and an introductoryPhase in the same SubscriptionOption.

fullPricePhase

val SubscriptionOption.fullPricePhase: PricingPhase?

The full price PricingPhase of the subscription. Looks for the last price phase of the SubscriptionOption.

introPhase

val SubscriptionOption.introPhase: PricingPhase?

The intro trial PricingPhase of the subscription. Looks for the first pricing phase of the SubscriptionOption where amountMicros is greater than 0. There can be a freeTrialPhase and an introductoryPhase in the same SubscriptionOption.

isBasePlan

val SubscriptionOption.isBasePlan: Boolean

True if this SubscriptionOption represents a Google subscription base plan (rather than an offer). Not applicable for Amazon subscriptions.

isPrepaid

val SubscriptionOption.isPrepaid: Boolean

True if the subscription is pre-paid. Not applicable for Amazon subscriptions.