StoreKit · IOS API REFERENCE

Product.SubscriptionOffer

struct · iOS 15.0+ · SDK 27.1

struct SubscriptionOffer

Information about a subscription offer configured in App Store Connect.

Members (7)

get · iOS 15.0+

TypeScript

get paymentMode(): Product_SubscriptionOffer_PaymentMode

Swift declaration

let paymentMode: Product.SubscriptionOffer.PaymentMode

How the user is charged for this offer.

get · iOS 15.0+

TypeScript

get periodCount(): number

Swift declaration

let periodCount: Int

The number of periods this offer will renew for. Always 1 except for `.payAsYouGo`.

get · iOS 15.0+

TypeScript

get displayPrice(): string

Swift declaration

let displayPrice: String

A localized string representation of `price`.

get · iOS 15.0+

TypeScript

get id(): (string) | null

Swift declaration

let id: String?

The offer identifier. This is always `nil` for introductory offers and never `nil` for other offer types.

get · iOS 15.0+

TypeScript

get type(): Product_SubscriptionOffer_OfferType

Swift declaration

let type: Product.SubscriptionOffer.OfferType

The type of the offer.

get · iOS 15.0+

TypeScript

get price(): _Foundation_Decimal

Swift declaration

let price: Decimal

The discounted price that the offer provides in local currency. This is the price per period in the case of `.payAsYouGo`

get · iOS 15.0+

TypeScript

get period(): Product_SubscriptionPeriod

Swift declaration

let period: Product.SubscriptionPeriod

The duration that this offer lasts before auto-renewing or changing to standard subscription renewals.

No declarations were skipped in this snapshot.