Documentation

Apple product details reference

Explore the methods you can use to read Apple App Store product details and check whether a player can redeem an introductory offer.
Read time 2 minutesLast updated 8 days ago

On the Apple App Store,
IAppleStoreExtendedProductService
returns the details of the products that Unity IAP has fetched, including introductory offers for subscriptions. To access the service, use
StoreController.AppleStoreExtendedProductService
, or in IAP 5.5 and later,
PurchasingController.AppleStoreExtendedProductService
. On other platforms, these properties return
null
.

Product details methods

The following methods each return a dictionary keyed by product ID, where each value is a JSON string with that product's details:

Method

Description

public Dictionary<string, string> GetProductDetails()
Returns the details of each fetched product, such as its localized title, description, and price. For subscription products, the details include the introductory offer.
public Dictionary<string, string> GetIntroductoryPriceDictionary()
Returns the introductory offer details of each fetched product, such as the introductory price and the number of periods it applies to.
Unity IAP uses StoreKit 2 on iOS 15 and later, tvOS 15 and later, macOS 12 and later, and visionOS. With StoreKit 2, the details of each subscription product in both dictionaries also include
isEligibleForIntroOffer
. Its value is
"true"
when the player can redeem the introductory offer. Both methods return the introductory offer even when the player isn't eligible, so check
isEligibleForIntroOffer
before you present the offer.
Both methods return the products from every fetch, not only the most recent one. If you fetch a product again, its entry contains the latest details. When the signed-in player changes, Unity IAP clears both dictionaries if you've attached an
OnAuthAccountChanged
handler to the store. For more information, refer to Handle an account change.