public/com.revenuecat.purchases.models/SubscriptionOption

SubscriptionOption

interface SubscriptionOption : Parcelable

A purchase-able entity for a subscription product.

Functions

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

billingPeriod

open val billingPeriod: Period?

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

freePhase

open val 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

open val fullPricePhase: PricingPhase?

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

abstract val id: String

For Google subscriptions: If this SubscriptionOption represents a base plan, this will be the basePlanId. If it represents an offer, it will be {basePlanId}:{offerId}

introPhase

open val 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

open val isBasePlan: Boolean

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

pricingPhases

abstract val pricingPhases: List<PricingPhase>

Pricing phases defining a user's payment plan for the product over time.

purchasingData

abstract val purchasingData: PurchasingData

Inheritors

GoogleSubscriptionOption

Sources

androidJvm source