Product.SubscriptionInfo

groupLevel

get groupLevel(): number

@backDeployed(before: iOS 17.0, macOS 14.0, tvOS 17.0, watchOS 10.0)
var groupLevel: Int { get }

The level of this subscription relative to other subscriptions in the same group. Subscriptions with a lower group level indicate a higher level of service. For example, if someone subscribes to a subscription with a group level lower than their current subscription, this would be an upgrade. - Important: When using `groupLevel` on systems earlier than iOS 17.0, macOS 14.0, tvOS 17.0 or watchOS 10.0, the property may return a sentinel value of 0 in some uncommon cases: (1) StoreKit Testing in Xcode (workaround: test your app on a device running a more recent OS) or (2) a critical server error.

pricingTerms

get pricingTerms(): Array<Product_SubscriptionInfo_PricingTerms>

let pricingTerms: [Product.SubscriptionInfo.PricingTerms]

winBackOffers

get winBackOffers(): Array<Product_SubscriptionOffer>

let winBackOffers: [Product.SubscriptionOffer]

An array of all win-back offers configured for this subscription

groupDisplayName

get groupDisplayName(): string

@backDeployed(before: iOS 17.0, macOS 14.0, tvOS 17.0, watchOS 10.0)
var groupDisplayName: String { get }

A localized display name of the subscription's group. To get the display name of the subscription itself, use ``Product/displayName`` on the corresponding ``Product`` value. - Important: When using `groupDisplayName` on systems earlier than iOS 17.0, macOS 14.0, tvOS 17.0 or watchOS 10.0, the property may return a sentinel empty string in some uncommon cases: (1) StoreKit Testing in Xcode (workaround: test your app on a device running a more recent OS) or (2) a critical server error.

introductoryOffer

get introductoryOffer(): (Product_SubscriptionOffer) | null

let introductoryOffer: Product.SubscriptionOffer?

An optional introductory offer that will automatically be applied if the user is eligible.

promotionalOffers

get promotionalOffers(): Array<Product_SubscriptionOffer>

let promotionalOffers: [Product.SubscriptionOffer]

An array of all the promotional offers configured for this subscription.

subscriptionPeriod

get subscriptionPeriod(): Product_SubscriptionPeriod

let subscriptionPeriod: Product.SubscriptionPeriod

The duration that this subscription lasts before auto-renewing.

subscriptionGroupID

get subscriptionGroupID(): string

let subscriptionGroupID: String

The group identifier for this subscription.

bundledSubscriptions

get bundledSubscriptions(): Array<Product_SubscriptionInfo_BundledSubscription>

let bundledSubscriptions: [Product.SubscriptionInfo.BundledSubscription]

Properties and functionality specific to auto-renewable subscriptions included in a subscription bundle. This list is only populated if `type` is `.subscriptionBundle`, and always empty for all other product types.

isEligibleForIntroOffer

static isEligibleForIntroOfferFor(groupID: string): Promise<boolean>

static func isEligibleForIntroOffer(for groupID: String) async -> Bool

Whether the user is eligible to have an introductory offer applied to a purchase in this subscription group. - Parameter groupID: The group identifier to check eligibility for.

isEligibleForIntroOffer

get isEligibleForIntroOffer(): Promise<boolean>

var isEligibleForIntroOffer: Bool { get async }

Whether the user is eligible to have an introductory offer applied to their purchase.

status

static statusTransactionID(transactionID: number): Promise<(Product_SubscriptionInfo_Status) | null>

static func status(transactionID: UInt64) async throws -> SubscriptionStatus?

status

static statusFor(groupID: string): Promise<Array<Product_SubscriptionInfo_Status>>

static func status(for groupID: String) async throws -> [Product.SubscriptionInfo.Status]

status

get status(): Promise<Array<Product_SubscriptionInfo_Status>>

var status: [Product.SubscriptionInfo.Status] { get async throws }