Storekit

StoreKit Reference

StoreKit 2 for in-app purchases and subscriptions (iOS 26+).

Downloaded Reference Files

Fetching More Docs

1. Search this skill's local .md files first. 2. If the topic is not here, check the other installed Apple skills you have available by their names, descriptions, or SKILL.md frontmatter, then grep their local files. This is faster and uses less context than fetching new docs from the internet. 3. If no installed skill has the page, use the relevant documentation path from storekit-overview.md with the sosumi.ai Markdown mirror. For example, /documentation/storekit/product maps to https://sosumi.ai/documentation/storekit/product.

Navigation: StoreKit

Structure

Product

Available on: iOS 15.0+, iPadOS 15.0+, Mac Catalyst 15.0+, macOS 12.0+, tvOS 15.0+, visionOS 1.0+, watchOS 8.0+

Information about a product that you configure in App Store Connect.

struct Product

Overview

The Product type represents the in-app purchases that you configure in App Store Connect and make available for purchase within your app. Use Product to perform all product-related tasks in your app, from displaying in-app purchases and offers to making a purchase and getting transaction and subscription status information.

To get a Product instance, call products(for:)) and provide one or more in-app purchase product identifiers. Use a Product instance to display in-app purchases and subscription offers in your store, as follows:

• Show the localized name, description, and pricing information using displayName, description, and displayPrice, respectively.
• Determine whether a user is eligible for an introductory offer for the product using isEligibleForIntroOffer.
• Display your subscription offers using the subscription information in subscription.

When users initiate a purchase, call purchase(options:)) or purchase(confirmIn:options:)-3bivf) on the product instance. If your app uses SwiftUI, you can also use PurchaseAction. Set purchase options (Product.PurchaseOption) to define an optional app account token, apply a promotional offer, or set a product quantity. Purchase options can also simulate an Ask to Buy scenario when you’re testing your app in the sandbox environment.

Use a Product instance to learn whether a user is entitled to a product by checking currentEntitlement, which holds the transaction that entitles the user to the product. This transaction information, as well as the transaction in latestTransaction, are cryptographically signed by the App Store in JSON Web Signature (JWS) format.

If the product is an auto-renewable subscription, use the status and renewalInfo in the subscription information to help manage subscriptions and inform business decisions, such as presenting subscription offers.

For information about configuring In-App Purchases in App Store Connect, see Overview for configuring In-App Purchases.

Conforms To

• Copyable
• CustomDebugStringConvertible
• Equatable
• Escapable
• Hashable
• Identifiable
• Sendable
• SendableMetatype

Requesting products from the App Store

• products(for:)) Requests product data from the App Store.

Displaying a product description and price

• displayName The localized display name of the product, if it exists.
• description The localized description of the product.
• displayPrice The localized string representation of the product price, suitable for display.
• price The decimal representation of the cost of the product, in local currency.
• priceFormatStyle The format style for the numbers in the price of the product.
• subscriptionPeriodFormatStyle The format style for the date components related to a subscription’s duration.
• subscriptionPeriodUnitFormatStyle The format style for subscription period units, such as week, month, or year.

Purchasing a product

• purchase(options:)) Initiates a purchase for the product with the App Store and displays the confirmation sheet.
• purchase(confirmIn:options:)-6dj6y) Initiates a purchase for the product with the App Store and displays the confirmation sheet.
• purchase(confirmIn:options:)-3bivf) Processes a purchase for the product.
• purchase(confirmIn:options:)-8eai6) Processes a purchase for the product.
• Product.PurchaseOption Optional settings for a product purchase that add account information, purchase details, and offers, or that specify behaviors.
• Product.PurchaseResult The result of a purchase.
• Product.PurchaseError Error information for product purchase errors.

Receiving current entitlement information

• currentEntitlements

Getting the latest transaction

• latestTransaction The most recent transaction for the product.

Getting subscription information

• subscription The subscription information for an auto-renewable subscripton.
• Product.SubscriptionInfo Information about an auto-renewable subscription, such as its status, period, subscription group, and subscription offer details.
• Product.SubscriptionPeriod Values that represent the duration of time between subscription renewals.
• Product.SubscriptionOffer Information about a subscription offer that you configure in App Store Connect.
• Product.SubscriptionInfo.Status The renewal status information for an auto-renewable subscription.

Getting product identifiers and type

• id The unique product identifier.
• type The in-app purchase product type.
• Product.ProductType The types of in-app purchases.

Getting Family Sharing status

• isFamilyShareable A Boolean value that indicates whether the product is available for Family Sharing in App Store Connect.

Managing promoted in-app purchases

• Product.PromotionInfo Information about a promoted In-App Purchase that customizes its order and visibility on the device.

Loading products

• Product.CollectionTaskState The state of a task that loads a collection of products in the background.
• Product.TaskState The state of a task that loads a product in the background.

Getting product info in JSON format

• jsonRepresentation The JSON representation of the product information.

Getting subscription relationship

• Product.SubscriptionRelationship

Deprecated

• currentEntitlement The transaction that entitles the user to the product.

Product and subscription information

• Implementing a store in your app using the StoreKit API Offer In-App Purchases and manage entitlements using signed transactions and status information.
• Supporting monthly subscriptions with a 12-month commitment Configure, merchandise, and grant access to a monthly subscription with a 12-month commitment.
• Managing the life cycle of monthly subscriptions with a 12-month commitment Handle renewals, cancellations, billing issues, refund requests, and price changes, and test subscriptions with a commitment plan.
• Product.SubscriptionInfo Information about an auto-renewable subscription, such as its status, period, subscription group, and subscription offer details.
• SubscriptionInfo Information about an auto-renewable subscription.
• SubscriptionStatus Represents the renewal status information for an auto-renewable subscription.

---

Extracted from Apple DocC JSON by apple-skills tooling. This is unofficial content. All documentation belongs to Apple Inc.

Navigation: StoreKit

Structure

StoreView

Available on: iOS 17.0+, iPadOS 17.0+, Mac Catalyst 17.0+, macOS 14.0+, tvOS 17.0+, visionOS 1.0+, watchOS 10.0+

A view that merchandises a collection of In-App Purchase products.

@MainActor @preconcurrency struct StoreView<Icon, PlaceholderIcon> where Icon : View, PlaceholderIcon : View

Overview

A StoreView displays a collection of in-app purchase products, including their localized names, descriptions, and prices, and displays a purchase button.

Create a store view by providing a collection of product identifiers for the view to load from the App Store, or a collection of Product values you previously loaded. If you provide product identifiers, the store view automatically loads the product information from the App Store, and updates the view when the products are available.

You can provide a view to use as an icon or image for each individual product. If you provide product identifiers, you can optionally provide placeholder icons for the system to use instead of the automatic placeholder icon.

If you set up promoted images for your products in App Store Connect, you can choose to display those images for your products.

Manage the store layout

The StoreView arranges products in rows. If the view has enough horizontal space available, the store adds columns. In tvOS, the view arranges the products in columns and adds rows as space permits.

The store view grows to fit its container, and scrolls when the container doesn’t have enough space to display all the products. Use the fixedSize(horizontal:vertical:)) modifier to change this behavior.

To achieve a custom layout, you can compose ProductView instances with other container views instead of using the StoreView.

Customize the store

You can customize the store by displaying additional buttons, and applying styles.

To display a button that syncs in-app purchase entitlements with the App Store, modify the in-app store view or an ancestor view using the storeButton(_:for:) modifier with the parameters Visibility.visible and restorePurchases. The app calls the sync()) method when people use this button.

You can customize the appearance of the products using product view styles, such as CompactProductViewStyle, LargeProductViewStyle, and RegularProductViewStyle. To apply the style, call the productViewStyle(_:)) modifier.

Conforms To

• Sendable
• SendableMetatype
• View

Creating store views that load products

• init(ids:prefersPromotionalIcon:)) Creates a view to load and merchandise a collection of products from the App Store using product identifiers.
• init(ids:prefersPromotionalIcon:icon:)) Creates a view to load a collection of products from the App Store using product identifiers, and merchandise them using a custom image.
• init(ids:prefersPromotionalIcon:icon:placeholderIcon:)) Creates a view to load a collection of products from the App Store using product identifiers, and merchandise them using an image and a custom placeholder icon.
• init(ids:icon:placeholderIcon:)) Creates a view to load a collection of products from the App Store using product identifiers, and merchandise them using their promotional images and a custom placeholder icon.

Creating store views with preloaded products

• init(products:prefersPromotionalIcon:)) Creates a view to load and merchandise a collection of products from the App Store.
• init(products:prefersPromotionalIcon:icon:)) Creates a view to merchandise a collection of products using a custom icon.
• init(products:icon:)) Creates a view to merchandise a collection of products with promotional images.

Loading promotional images

• ProductIconPhase The current phase of the asynchronous loading operation of a product’s promotional image.

Merchandising In-App Purchases, subscriptions, and offers

• ProductView A view that merchandises an individual In-App Purchase product.
• SubscriptionStoreView A view that merchandises a collection of auto-renewable subscription options that belong to the same subscription group.
• SubscriptionOfferView
• Backyard Birds: Building an app with SwiftData and widgets Create an app with persistent data, interactive widgets, and an all new in-app purchase experience.

---

Extracted from Apple DocC JSON by apple-skills tooling. This is unofficial content. All documentation belongs to Apple Inc.

Navigation: StoreKit › Product

Structure

Product.SubscriptionInfo

Available on: iOS 15.0+, iPadOS 15.0+, Mac Catalyst 15.0+, macOS 12.0+, tvOS 15.0+, visionOS 1.0+, watchOS 8.0+

Information about an auto-renewable subscription, such as its status, period, subscription group, and subscription offer details.

struct SubscriptionInfo

Conforms To

• Equatable
• Hashable
• Sendable
• SendableMetatype

Determining the subscription status

• status An array that contains status information for a subscription group, including renewal and transaction information.
• status(for:)) Gets the subscription status for a subscription group identifier.
• status(transactionID:)) Gets the subscription status for a transaction ID.
• Product.SubscriptionInfo.Status The renewal status information for an auto-renewable subscription.

Identifying the subscription group

• subscriptionGroupID The subscription group identifier for this subscription.
• groupDisplayName The localized name of the subscription group, suitable for display.
• groupLevel The rank of the subscription relative to other subscriptions in the same subscription group.

Getting the subscription period

• subscriptionPeriod The duration of time between subscription renewals.
• Product.SubscriptionPeriod Values that represent the duration of time between subscription renewals.

Getting introductory offer details

• isEligibleForIntroOffer A Boolean value that indicates whether the customer is eligible for an introductory offer.
• isEligibleForIntroOffer(for:)) Returns a Boolean value that determines the customer’s eligibility for an introductory offer within the provided subscription group.
• introductoryOffer Information about the introductory offer available for the auto-renewable subscription.
• Product.SubscriptionOffer Information about a subscription offer that you configure in App Store Connect.

Getting win-back offer details

• winBackOffers An array of available win-back offers for the auto-renewable subscription that you configured in App Store Connect.

Getting promotional offer details

• promotionalOffers An array of promotional offers available for the auto-renewable subscription.

Getting subscription renewal information

• Product.SubscriptionInfo.RenewalInfo The renewal information for an auto-renewable subscription.
• Product.SubscriptionInfo.RenewalState The renewal states of auto-renewable subscriptions.

Structures

• Product.SubscriptionInfo.BillingPlanType
• Product.SubscriptionInfo.CommitmentInfo
• Product.SubscriptionInfo.PricingTerms

Instance Properties

• pricingTerms

Type Aliases

• Product.SubscriptionInfo.BillingPeriod

Product and subscription information

• Implementing a store in your app using the StoreKit API Offer In-App Purchases and manage entitlements using signed transactions and status information.
• Supporting monthly subscriptions with a 12-month commitment Configure, merchandise, and grant access to a monthly subscription with a 12-month commitment.
• Managing the life cycle of monthly subscriptions with a 12-month commitment Handle renewals, cancellations, billing issues, refund requests, and price changes, and test subscriptions with a commitment plan.
• Product Information about a product that you configure in App Store Connect.
• SubscriptionInfo Information about an auto-renewable subscription.
• SubscriptionStatus Represents the renewal status information for an auto-renewable subscription.

---

Extracted from Apple DocC JSON by apple-skills tooling. This is unofficial content. All documentation belongs to Apple Inc.

Navigation: StoreKit

Structure

SubscriptionStoreView

Available on: iOS 17.0+, iPadOS 17.0+, Mac Catalyst 17.0+, macOS 14.0+, tvOS 17.0+, visionOS 1.0+, watchOS 10.0+

A view that merchandises a collection of auto-renewable subscription options that belong to the same subscription group.

@MainActor @preconcurrency struct SubscriptionStoreView<Content> where Content : View

Overview

A SubscriptionStoreView displays localized information about auto-renewable subscriptions, including their localized names, descriptions, and prices, as well as a purchase button.

Create a subscription store view by using one of the initializers and providing the following information:

• A subscription group identifier
• A collection of product identifiers
• A collection of product values you previously loaded from the App Store

If you provide a subscription group identifier or a collection of product identifiers, the subscription store view automatically loads the subscription data from the App Store, and updates the view when the data is available.

Provide a background and a decorative icon

The subscription store view doesn’t draw a background by default. You can add a background as follows:

• To layer a background behind the view, use a view modifier, such as background(alignment:content:).
• To set the container background of the subscription store using a view, use the containerBackground(_:for:) or containerBackground(for:alignment:content:) view modifier and specify a ContainerBackgroundPlacement, such as subscriptionStoreHeader.

You can optionally provide a view as a decorative icon next to each subscription option. Use the subscriptionStoreControlIcon(icon:)) view modifier to set a view that decorates individual subscription options within a subscription store.

Order and filter subscriptions

If you create the subscription store view by providing a subscription group identifier, the system orders the subscription options according to their rank. If the customer is already subscribed, you may want to merchandise upgrade or crossgrade options. By default, the subscription store view lists all the subscriptions in the group. To hide certain subscription options, provide the visibleRelationships parameter in the initializer. For more information about the visible relationships, see Product.SubscriptionRelationship.

If you create the subscription store view using one of the other initializers, the view orders the subscriptions according to the collection parameter’s order. The view excludes subscriptions that you don’t include in the collection parameter.

Add terms of service and privacy policies

The SubscriptionStoreView automatically displays buttons for the terms of service and privacy policy that you submit in App Store Connect. To override the destination of these buttons with a URL to custom terms of service and privacy policy pages, or a custom view, use the modifiers subscriptionStorePolicyDestination(url:for:)) and subscriptionStorePolicyDestination(for:destination:)).

Use modifiers, such as subscriptionStorePolicyForegroundStyle(_:)), to customize the button’s style, for example, to make the text more readable against your store’s background.

Add auxiliary buttons

You can show auxiliary buttons in the subscription store using view modifiers. Specify the button’s visibility within the subscription store by using the storeButton(_:for:)) view modifier.

If you offer your subscription through other services, you can configure the subscription store view to display a sign-in button. Use the subscriptionStoreSignInAction(_:)) modifier to set the function your app calls when someone uses the sign-in button.

The subscription store view automatically shows a Close button. To override this behavior, use the storeButton(_:for:) modifier to unconditionally show, or hide, the Close button.

Style the subscription store view

You can further customize the subscription store’s appearance using control styles. Use subscription store control styles to customize the display of subscription options, and how people interact with your store. To try out standard styles, such as PickerSubscriptionStoreControlStyle, apply the style using the subscriptionStoreControlStyle(_:)) modifier.

Conforms To

• Sendable
• SendableMetatype
• View

Creating subscription store views with automatic marketing content

• init(groupID:visibleRelationships:)) Creates a view that loads all subscriptions in a subscription group from the App Store, and merchandises them with automatic marketing content.
• init(productIDs:)) Creates a view that loads subscriptions based on a collection of product identifiers, and merchandises them with automatic marketing content.
• init(subscriptions:)) Creates a view that displays a collection of subscription options, and merchandises them with automatic marketing content.

Creating subscription store views with custom marketing content

• init(groupID:visibleRelationships:marketingContent:)) Creates a view that loads all the subscriptions in a subscription group from the App Store, and merchandises them with custom marketing content.
• init(productIDs:marketingContent:)) Creates a view that loads a collection of subscriptions from the App Store, and merchandises them with custom marketing content.
• init(subscriptions:marketingContent:)) Creates a view that displays a collection of subscription options, and merchandises them with custom marketing content.

Creating subscription store views with a hierarchichal structure

• init(groupID:visibleRelationships:content:))
• init(productIDs:content:))
• init(subscriptions:content:))

Supporting types

• AutomaticSubscriptionStoreMarketingContent A view that represents the default marketing content for a subscription store.
• SubscriptionStoreContentView

Merchandising In-App Purchases, subscriptions, and offers

• ProductView A view that merchandises an individual In-App Purchase product.
• StoreView A view that merchandises a collection of In-App Purchase products.
• SubscriptionOfferView
• Backyard Birds: Building an app with SwiftData and widgets Create an app with persistent data, interactive widgets, and an all new in-app purchase experience.

---

Extracted from Apple DocC JSON by apple-skills tooling. This is unofficial content. All documentation belongs to Apple Inc.

Navigation: StoreKit

Structure

Transaction

Available on: iOS 15.0+, iPadOS 15.0+, Mac Catalyst 15.0+, macOS 12.0+, tvOS 15.0+, visionOS 1.0+, watchOS 8.0+

Information that represents the customer’s purchase of a product in your app.

struct Transaction

Overview

A transaction represents a successful In-App Purchase. The App Store generates a transaction each time a customer purchases an In-App Purchase product or renews a subscription. For each transaction that represents a current purchase, your app unlocks the purchased content or service and finishes the transaction.

Use the Transaction type to perform these transaction-related tasks:

• Get the customer’s transaction history, latest transactions, and current entitlements to unlock content and services.
• Access transaction properties.
• Finish a transaction after your app delivers the purchased content or service.
• Access the raw JSON Web Signature (JWS) string and supporting values to verify the transaction information.
• Listen for new transactions while the app is running.
• Begin a refund request from within your app.

Access transaction history and current entitlements

Your app doesn’t create transaction objects. Instead, StoreKit automatically makes up-to-date transactions available to your app, including when someone launches the app for the first time.

Related sessions from WWDC22: Session 110404: Implement proactive in-app purchase restore

You access transactions in several ways:

• Get transaction history anytime by accessing the static all sequence, or get just the most recent transaction for a product with the latestTransaction property of Product.
• Receive notifications for new transactions while your app is running when customers complete a purchase outside of the app, including on another device, through the transaction listener, updates.
• Access the latest transaction for a subscription group through the subscription status API, using transaction.
• After a successful In-App Purchase, StoreKit returns the transaction through Product.PurchaseResult.success(_:)).

The most important use of transaction information is for determining which In-App Purchases the customer has paid access to, so your app can unlock the content or service. The currentEntitlements API provides the information you need to unlock all of the customer’s paid content in your app. Use currentEntitlements to get a list of transactions for all the products the customer is currently entitled to, including non-consumable In-App Purchases and currently active subscriptions.

Verify transactions

The App Store cryptographically signs transaction information in JWS format. StoreKit automatically validates and returns the signed information, wrapped in a VerificationResult. When the VerificationResult wraps a Transaction value, it provides the raw JWS string in the jwsRepresentation property. If you get a transaction through VerificationResult.verified(_:)), the information passed validation. If you get it through VerificationResult.unverified(_:_:)), the information didn’t pass StoreKit’s automatic validation. Your app can immediately access the transaction information in the Transaction properties.

To perform your own validation on the device, use the verification result’s jwsRepresentation string, and use the provided convenience properties headerData, payloadData, and signatureData. For added control and security, send the jwsRepresentation to your server to verify. Consider using the App Store Server Library to implement your verification. The library provides the functions verifyAndDecodeTransaction and verifyAndDecodeRenewalInfo in each language the library supports. For more information, see Simplifying your implementation by using the App Store Server Library.

Tip: The jwsRepresentation is the same as the JWSTransaction that the App Store Server API returns and to the JWSTransaction that you receive in App Store Server Notifications V2. You can validate them on your server in the same way.

If StoreKit returns a transaction as verified, the transaction is valid for the device. For information about performing your own verification for a device, see deviceVerification.

For more information about JWS, see the IETF RFC 7515 specification.

Access purchases made with the original API

All In-App Purchases that customers make are equally available to your app in this Transaction API, and in receipts using the Original API for In-App Purchase, as follows:

• New purchases that customers make with the original API are available immediately using the Transaction API.
• Purchases that customers make with the purchase(options:)) method are available in the original API when your app refreshes the receipt. For more information, see SKReceiptRefreshRequest.

Conforms To

• Copyable
• CustomDebugStringConvertible
• Equatable
• Escapable
• Hashable
• Identifiable
• Sendable
• SendableMetatype

Transaction properties

• Transaction properties The properties of a transaction, including identifiers, purchase and revocation dates and details, status, and offer details.
• appTransactionID The unique identifier of the app download transaction.

Monitoring transaction-related changes

• updates The asynchronous sequence that emits a transaction when the system creates or updates transactions that occur outside the app or on other devices.
• Transaction.Transactions An asynchronous sequence of transactions.

Getting transaction history

• latest(for:)) Gets the customer’s most recent transaction for an In-App Purchase.
• all A sequence that emits all the customer’s transactions for your app.
• unfinished A sequence that emits unfinished transactions for the customer.
• SKIncludeConsumableInAppPurchaseHistory A Boolean value that determines whether StoreKit includes finished consumable In-App Purchases in transaction information.

Getting current entitlements

• currentEntitlements A sequence of the latest transactions that entitle a customer to In-App Purchases and subscriptions.

Getting transactions for a product

• all(for:)) Gets all the transactions associated with this product ID.

Finishing the transaction

• finish()) Indicates to the App Store that the app delivered the purchased content or enabled the service to finish the transaction.
• unfinished A sequence that emits unfinished transactions for the customer.

Verifying transactions

• deviceVerification The device verification value you use to verify whether the transaction belongs to the device.
• deviceVerificationNonce The UUID for computing the device verification value.
• signedDate The date that the App Store signed the JWS transaction.

Getting transaction info in JSON format

• jsonRepresentation The JSON representation of the transaction information.

Requesting refunds

• Testing refund requests Test your app’s implementation of refund requests, and your app’s and server’s handling of approved and declined refunds.
• beginRefundRequest(in:)-9k0pj) Presents the refund request sheet for the transaction in a window scene.
• beginRefundRequest(in:)-63bvd) Presents the refund request sheet for the transaction in a view controller.
• beginRefundRequest(for:in:)-65tph) Presents the refund request sheet for the specified transaction in a window scene.
• beginRefundRequest(for:in:)-9mscy) Presents the refund request sheet for the specified transaction in a view controller.
• Transaction.RefundRequestError The error codes for refund requests.
• Transaction.RefundRequestStatus The status codes for refund requests.

Advanced Commerce transaction data

• advancedCommerceInfo Metadata for transactions that use the Advanced Commerce API.
• Transaction.AdvancedCommerceInfo Metadata for transactions that use the Advanced Commerce API.

Getting offer types

• Transaction.OfferType The types of offers that apply to a transaction.

Deprecated

• currentEntitlement(for:)) Gets the latest transactions that entitle the customer to a specified product.
• currentEntitlements(for:)) Gets the transactions that entitle the user to items purchased under a product ID.
• offerPeriodStringRepresentation The string representation of the offer period applied to the subscription offer for this transaction.

Structures

• Transaction.CommitmentInfo
• Transaction.RevocationType

Instance Properties

• billingPlanType
• commitmentInfo
• revocationPercentage The percentage of the transaction amount that the App Store has refunded or revoked, expressed as a decimal.
• revocationType The type of refund or revocation that applies to the transaction.
• revocationTypeStringRepresentation The string representation of the revocationType, or nil if the transaction was not revoked.

Transaction history and entitlements

• updates The asynchronous sequence that emits a transaction when the system creates or updates transactions that occur outside the app or on other devices.
• all A sequence that emits all the customer’s transactions for your app.
• currentEntitlements A sequence of the latest transactions that entitle a customer to In-App Purchases and subscriptions.

---

Extracted from Apple DocC JSON by apple-skills tooling. This is unofficial content. All documentation belongs to Apple Inc.