purchases/com.revenuecat.purchases.models/GoogleSubscriptionOption

GoogleSubscriptionOption

data class GoogleSubscriptionOption @JvmOverloads constructor(val productId: String, val basePlanId: String, val offerId: String?, val pricingPhases: List<PricingPhase>, val tags: List<String>, val productDetails: ProductDetails, val offerToken: String, val presentedOfferingContext: PresentedOfferingContext? = null, val installmentsInfo: GoogleInstallmentsInfo? = null) : SubscriptionOption

Defines an option for purchasing a Google subscription

Constructors

@JvmOverloads

constructor(productId: String, basePlanId: String, offerId: String?, pricingPhases: List<PricingPhase>, tags: List<String>, productDetails: ProductDetails, offerToken: String, presentedOfferingContext: PresentedOfferingContext? = null, installmentsInfo: GoogleInstallmentsInfo? = null)

Properties

basePlanId

val basePlanId: String

The id of the base plan that this GoogleSubscriptionOption belongs to.

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.

open override 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}

installmentsInfo

open override val installmentsInfo: GoogleInstallmentsInfo? = null

For installment subscriptions, the details of the installment plan the customer commits to. Null for non-installment subscriptions.

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.

isPrepaid

open val isPrepaid: Boolean

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

offerId

val offerId: String?

If this represents an offer, the offerId set in the Play Console. Null otherwise.

offerToken

val offerToken: String

The token used to purchase this GoogleSubscriptionOption, whether it represents a base plan or an offer.

presentedOfferingContext

open override val presentedOfferingContext: PresentedOfferingContext? = null

The context from which this subscription option was obtained.

pricingPhases

open override val pricingPhases: List<PricingPhase>

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

productDetails

val productDetails: ProductDetails

The ProductDetails object this GoogleSubscriptionOption was created from. Use to get underlying BillingClient information.

productId

val productId: String

If this SubscriptionOption represents a base plan, this will be the basePlanId. If it represents an offer, it will be basePlanId:offerId

purchasingData

open override val purchasingData: PurchasingData