SubscriptionOption

interface SubscriptionOption

A purchase-able entity for a subscription product.

Properties

Link copied to clipboard
open val billingPeriod: Period?

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

Link copied to clipboard
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.

Link copied to clipboard
open val fullPricePhase: PricingPhase?

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

Link copied to clipboard
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}

Link copied to clipboard
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.

Link copied to clipboard
open val isBasePlan: Boolean

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

Link copied to clipboard
abstract val presentedOfferingIdentifier: String?

The offering ID this SubscriptionOption was returned from.

Link copied to clipboard
abstract val pricingPhases: List<PricingPhase>

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

Link copied to clipboard
abstract val purchasingData: PurchasingData
Link copied to clipboard
abstract val tags: List<String>

Tags defined on the base plan or offer. Keep in mind that offers automatically inherit their base plan's tag. Empty for Amazon.

Inheritors

Link copied to clipboard

Sources

Link copied to clipboard