Product

description

get description(): string

let description: String

A localized description of the product.

displayName

get displayName(): string

let displayName: String

A localized display name of the product.

displayPrice

get displayPrice(): string

let displayPrice: String

A localized string representation of `price`.

subscription

get subscription(): (Product_SubscriptionInfo) | null

let subscription: Product.SubscriptionInfo?

Properties and functionality specific to auto-renewable subscriptions. This is never `nil` if `type` is `.autoRenewable`, and always `nil` for all other product types.

debugDescription

get debugDescription(): string

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.

priceFormatStyle

get priceFormatStyle(): _Foundation_Decimal_FormatStyle_Currency

@backDeployed(before: iOS 16.0, macOS 13.0, tvOS 16.0, watchOS 9.0, macCatalyst 16.0)
var priceFormatStyle: Decimal.FormatStyle.Currency { get }

The format style to use when formatting numbers derived from the price for the product. Use `displayPrice` when possible. Use `priceFormatStyle` only for localizing numbers derived from the `price` property, such as "2 products for $(`price * 2`)". - Important: When using `priceFormatStyle` on systems earlier than iOS 16.0, macOS 13.0, tvOS 16.0 or watchOS 9.0, the property may return a format style with a sentinel locale with identifier "xx\_XX" 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.

isFamilyShareable

get isFamilyShareable(): boolean

let isFamilyShareable: Bool

Whether the product is available for family sharing.

latestTransaction

get latestTransaction(): Promise<(VerificationResult<Transaction>) | null>

var latestTransaction: VerificationResult<Transaction>? { get async }

The most recent transaction for the product, or `nil` if the user has never purchased this product.

currentEntitlement

get currentEntitlement(): Promise<(VerificationResult<Transaction>) | null>

var currentEntitlement: VerificationResult<Transaction>? { get async }

The transaction that entitles the user to this product, or `nil` if the user is not currently entitled to this product. @DeprecationSummary { Use the ``currentEntitlements`` property instead. }

jsonRepresentation

get jsonRepresentation(): ArrayBuffer

var jsonRepresentation: Data { get }

The raw JSON representation of the product.

currentEntitlements

get currentEntitlements(): Transaction_Transactions

@backDeployed(before: iOS 26.0, macOS 26.0, tvOS 26.0, watchOS 26.0, visionOS 26.0)
var currentEntitlements: Transaction.Transactions { get }

subscriptionPeriodFormatStyle

get subscriptionPeriodFormatStyle(): _Foundation_Date_ComponentsFormatStyle

@backDeployed(before: iOS 16.0, macOS 13.0, tvOS 16.0, watchOS 9.0, macCatalyst 16.0)
var subscriptionPeriodFormatStyle: Date.ComponentsFormatStyle { get }

The format style to use when formatting subscription periods for the subscription. Use the `formatted(_:referenceDate:)` method on `Product.SubscriptionPeriod` with this style to format the subscription period for the App Store locale for the subscription. - Important: When using `subscriptionPeriodFormatStyle` on systems earlier than iOS 16.0, macOS 13.0, tvOS 16.0 or watchOS 9.0, the property may return a format style with a sentinel locale with identifier "xx\_XX" 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.

id

get id(): string

let id: String

The unique product identifier.

subscriptionPeriodUnitFormatStyle

get subscriptionPeriodUnitFormatStyle(): Product_SubscriptionPeriod_Unit_FormatStyle

var subscriptionPeriodUnitFormatStyle: Product.SubscriptionPeriod.Unit.FormatStyle { get }

The format style to use when formatting subscription period units for the subscription. Use the `formatted(_:)` method on `Product.SubscriptionPeriod.Unit` with this style to format the subscription period for the App Store locale for the subscription.

type

get type(): Product_ProductType

let type: Product.ProductType

The type of the product.

price

get price(): _Foundation_Decimal

let price: Decimal

The price of the product in local currency.

products

static products(identifiers: Array<string>): Promise<Array<Product>>

static func products<Identifiers>(for identifiers: Identifiers) async throws -> [Product] where Identifiers : Collection, Identifiers.Element == String

Requests product data from the App Store. - Parameter identifiers: A set of product identifiers to load from the App Store. If any identifiers are not found, they will be excluded from the return value. - Returns: An array of all the products received from the App Store. - Throws: `StoreKitError`

purchase

purchaseOptions(options?: Array<Product_PurchaseOption>): Promise<Product_PurchaseResult>

@MainActor func purchase(options: Set<Product.PurchaseOption> = []) async throws -> Product.PurchaseResult

Processes a purchase for the product. - Parameter options: A set of options to configure the purchase. - Returns: The result of the purchase. - Throws: A `PurchaseError` or `StoreKitError`.

purchase

purchaseConfirmInOptions(viewController: _UIKit_UIViewController, options?: Array<Product_PurchaseOption>): Promise<Product_PurchaseResult>

func purchase(confirmIn viewController: UIViewController, options: Set<Product.PurchaseOption> = []) async throws -> Product.PurchaseResult

Processes a purchase for the product. - Parameters: - viewController: The view controller to show purchase confirmation UI in proximity to. - options: A set of options to configure the purchase. - Returns: The result of the purchase - Throws: A `PurchaseError` or `StoreKitError`.

purchase

purchaseConfirmInOptions44435(scene: _UIKit_UIScene, options?: Array<Product_PurchaseOption>): Promise<Product_PurchaseResult>

@MainActor func purchase(confirmIn scene: some UIScene, options: Set<Product.PurchaseOption> = []) async throws -> Product.PurchaseResult

Processes a purchase for the product. - Parameters: - scene: The scene to show purchase confirmation UI in proximity to. - options: A set of options to configure the purchase. - Returns: The result of the purchase - Throws: A `PurchaseError` or `StoreKitError`.