Method Detail

• canPresentExternalPurchaseNoticeIOS

   abstract Boolean canPresentExternalPurchaseNoticeIOS()

  Check eligibility for the external purchase notice sheet (iOS 17.4+). Uses ExternalPurchase.canPresent. See: https://openiap.dev/docs/apis/ios/can-present-external-purchase-notice-ios

• currentEntitlementIOS

   abstract PurchaseIOS currentEntitlementIOS(String sku)

  Get the user's current entitlement for a product, using StoreKit 2 (iOS 15+). See: https://openiap.dev/docs/apis/ios/current-entitlement-ios

• fetchProducts

   abstract FetchProductsResult fetchProducts(ProductRequest params)

  Fetch products or subscriptions from the store. See: https://openiap.dev/docs/apis/fetch-products

• getActiveSubscriptions

   abstract List<ActiveSubscription> getActiveSubscriptions(List<String> subscriptionIds)

  Get details of all currently active subscriptions (filters by subscriptionIds when provided). See: https://openiap.dev/docs/apis/get-active-subscriptions

• getAllTransactionsIOS

   abstract List<PurchaseIOS> getAllTransactionsIOS()

  List every StoreKit transaction (finished + unfinished) for the current user. Requires the SKIncludeConsumableInAppPurchaseHistory Info.plist key in the host app for finished consumables to be included (iOS 18+). Unlike getAvailablePurchases, always returns the iOS-specific PurchaseIOS shape. See: https://openiap.dev/docs/apis/ios/get-all-transactions-ios

• getAppTransactionIOS

   abstract AppTransaction getAppTransactionIOS()

  Fetch the app transaction (iOS 16+). See: https://openiap.dev/docs/apis/ios/get-app-transaction-ios

• getAvailablePurchases

   abstract List<Purchase> getAvailablePurchases(PurchaseOptions options)

  List active purchases for the current user. See: https://openiap.dev/docs/apis/get-available-purchases

• getBillingChoiceInfoAndroid

   abstract BillingChoiceInfoAndroid getBillingChoiceInfoAndroid(GetBillingChoiceInfoParamsAndroid params)

  Fetch Play Billing assets and loyalty text for developer-rendered Billing Choice screens. OpenIAP availability: Spec 2.1.0 / openiap-google 2.3.0 (requires Play Billing 9.1.0+). Throws OpenIapError.NotPrepared if billing client is not ready. See: https://openiap.dev/docs/apis/android/get-billing-choice-info-android

• getExternalPurchaseCustomLinkTokenIOS

   abstract ExternalPurchaseCustomLinkTokenResultIOS getExternalPurchaseCustomLinkTokenIOS(ExternalPurchaseCustomLinkTokenTypeIOS tokenType)

  Fetch a token for Apple's External Purchase Server reporting API (iOS 18.1+). Use this token to report transactions made through ExternalPurchaseCustomLink. Reference: https://developer.apple.com/documentation/storekit/externalpurchasecustomlink/token(for:) See: https://openiap.dev/docs/apis/ios/get-external-purchase-custom-link-token-ios Parameter tokenType: Token type: acquisition (new customers) or services (existing customers)

• getPendingTransactionsIOS

   abstract List<PurchaseIOS> getPendingTransactionsIOS()

  List unfinished StoreKit transactions in the queue. See: https://openiap.dev/docs/apis/ios/get-pending-transactions-ios

• getPromotedProductIOS

   abstract ProductIOS getPromotedProductIOS()

  Read the App Store-promoted product, if any (iOS 11+). See: https://openiap.dev/docs/apis/ios/get-promoted-product-ios

• getReceiptDataIOS

   abstract String getReceiptDataIOS()

  Get base64-encoded receipt data (legacy validation). See: https://openiap.dev/docs/apis/ios/get-receipt-data-ios

• getStorefront

   abstract String getStorefront()

  Return the store-authoritative country code: ISO 3166-1 alpha-3 on Apple platforms and alpha-2 on Android. The operation fails when the store cannot provide a value; implementations must not synthesize a locale fallback. See: https://openiap.dev/docs/apis/get-storefront

• getTransactionJwsIOS

   abstract String getTransactionJwsIOS(String sku)

  Return the JWS string for a transaction (StoreKit 2). See: https://openiap.dev/docs/apis/ios/get-transaction-jws-ios

• hasActiveSubscriptions

   abstract Boolean hasActiveSubscriptions(List<String> subscriptionIds)

  Check whether the user has any active subscription. See: https://openiap.dev/docs/apis/has-active-subscriptions

• isEligibleForExternalPurchaseCustomLinkIOS

   abstract Boolean isEligibleForExternalPurchaseCustomLinkIOS()

  Check eligibility for the custom-link variant of external purchase (iOS 18.1+). Returns true if the app can use custom external purchase links. Reference: https://developer.apple.com/documentation/storekit/externalpurchasecustomlink/iseligible See: https://openiap.dev/docs/apis/ios/is-eligible-for-external-purchase-custom-link-ios

• isEligibleForIntroOfferIOS

   abstract Boolean isEligibleForIntroOfferIOS(String groupID)

  Check intro-offer eligibility for a subscription group. See: https://openiap.dev/docs/apis/ios/is-eligible-for-intro-offer-ios

• isTransactionVerifiedIOS

   abstract Boolean isTransactionVerifiedIOS(String sku)

  Check whether a transaction's JWS verification passed (StoreKit 2). See: https://openiap.dev/docs/apis/ios/is-transaction-verified-ios

• latestTransactionIOS

   abstract PurchaseIOS latestTransactionIOS(String sku)

  Get the latest verified transaction for a product, using StoreKit 2. See: https://openiap.dev/docs/apis/ios/latest-transaction-ios

• subscriptionStatusIOS

   abstract List<SubscriptionStatusIOS> subscriptionStatusIOS(String sku)

  Get subscription status objects from StoreKit 2 (iOS 15+). See: https://openiap.dev/docs/apis/ios/subscription-status-ios