Method Detail

• acknowledgePurchaseAndroid

   abstract Boolean acknowledgePurchaseAndroid(String purchaseToken)

  Acknowledge a non-consumable purchase or subscription

• beginRefundRequestIOS

   abstract String beginRefundRequestIOS(String sku)

  Initiate a refund request for a product (iOS 15+)

• checkAlternativeBillingAvailabilityAndroid

   abstract Boolean checkAlternativeBillingAvailabilityAndroid()

  Check if alternative billing is available for this user/device Step 1 of alternative billing flow

  Returns true if available, false otherwise Throws OpenIapError.NotPrepared if billing client not ready

• clearTransactionIOS

   abstract Boolean clearTransactionIOS()

  Clear pending transactions from the StoreKit payment queue

• consumePurchaseAndroid

   abstract Boolean consumePurchaseAndroid(String purchaseToken)

  Consume a purchase token so it can be repurchased

• createAlternativeBillingTokenAndroid

   abstract String createAlternativeBillingTokenAndroid()

  Create external transaction token for Google Play reporting Step 3 of alternative billing flow Must be called AFTER successful payment in your payment system Token must be reported to Google Play backend within 24 hours

  Returns token string, or null if creation failed Throws OpenIapError.NotPrepared if billing client not ready

• createBillingProgramReportingDetailsAndroid

   abstract BillingProgramReportingDetailsAndroid createBillingProgramReportingDetailsAndroid(BillingProgramAndroid program)

  Create reporting details for a billing program Replaces the deprecated createExternalOfferReportingDetailsAsync API

  Available in Google Play Billing Library 8.2.0+ Returns external transaction token needed for reporting external transactions Throws OpenIapError.NotPrepared if billing client not ready

• deepLinkToSubscriptions

   abstract Unit deepLinkToSubscriptions(DeepLinkOptions options)

  Open the native subscription management surface

• endConnection

   abstract Boolean endConnection()

  Close the platform billing connection

• finishTransaction

   abstract Unit finishTransaction(Purchase purchase, Boolean isConsumable)

  Finish a transaction after validating receipts

• initConnection

   abstract Boolean initConnection(InitConnectionConfig config)

  Establish the platform billing connection

• isBillingProgramAvailableAndroid

   abstract BillingProgramAvailabilityResultAndroid isBillingProgramAvailableAndroid(BillingProgramAndroid program)

  Check if a billing program is available for the current user Replaces the deprecated isExternalOfferAvailableAsync API

  Available in Google Play Billing Library 8.2.0+ Returns availability result with isAvailable flag Throws OpenIapError.NotPrepared if billing client not ready

• launchExternalLinkAndroid

   abstract Boolean launchExternalLinkAndroid(LaunchExternalLinkParamsAndroid params)

  Launch external link flow for external billing programs Replaces the deprecated showExternalOfferInformationDialog API

  Available in Google Play Billing Library 8.2.0+ Shows Play Store dialog and optionally launches external URL Throws OpenIapError.NotPrepared if billing client not ready

• presentCodeRedemptionSheetIOS

   abstract Boolean presentCodeRedemptionSheetIOS()

  Present the App Store code redemption sheet

• presentExternalPurchaseLinkIOS

   abstract ExternalPurchaseLinkResultIOS presentExternalPurchaseLinkIOS(String url)

  Present external purchase custom link with StoreKit UI

• presentExternalPurchaseNoticeSheetIOS

   abstract ExternalPurchaseNoticeResultIOS presentExternalPurchaseNoticeSheetIOS()

  Present external purchase notice sheet (iOS 17.4+). Uses ExternalPurchase.presentNoticeSheet() which returns a token when user continues. Reference: https://developer.apple.com/documentation/storekit/externalpurchase/presentnoticesheet()

• requestPurchase

   abstract RequestPurchaseResult requestPurchase(RequestPurchaseProps params)

  Initiate a purchase flow; rely on events for final state

• requestPurchaseOnPromotedProductIOS

   abstract Boolean requestPurchaseOnPromotedProductIOS()

  Purchase the promoted product surfaced by the App Store.

• restorePurchases

   abstract Unit restorePurchases()

  Restore completed purchases across platforms

• showAlternativeBillingDialogAndroid

   abstract Boolean showAlternativeBillingDialogAndroid()

  Show alternative billing information dialog to user Step 2 of alternative billing flow Must be called BEFORE processing payment in your payment system

  Returns true if user accepted, false if user canceled Throws OpenIapError.NotPrepared if billing client not ready

• showExternalPurchaseCustomLinkNoticeIOS

   abstract ExternalPurchaseCustomLinkNoticeResultIOS showExternalPurchaseCustomLinkNoticeIOS(ExternalPurchaseCustomLinkNoticeTypeIOS noticeType)

  Show ExternalPurchaseCustomLink notice sheet (iOS 18.1+). Displays the system disclosure notice sheet for custom external purchase links. Call this after a deliberate customer interaction before linking out to external purchases. Reference: https://developer.apple.com/documentation/storekit/externalpurchasecustomlink/shownotice(type:)

• showManageSubscriptionsIOS

   abstract List<PurchaseIOS> showManageSubscriptionsIOS()

  Open subscription management UI and return changed purchases (iOS 15+)

• syncIOS

   abstract Boolean syncIOS()

  Force a StoreKit sync for transactions (iOS 15+)

• validateReceipt

   abstract VerifyPurchaseResult validateReceipt(VerifyPurchaseProps options)

  Validate purchase receipts with the configured providers

• verifyPurchase

   abstract VerifyPurchaseResult verifyPurchase(VerifyPurchaseProps options)

  Verify purchases with the configured providers

• verifyPurchaseWithProvider

   abstract VerifyPurchaseWithProviderResult verifyPurchaseWithProvider(VerifyPurchaseWithProviderProps options)

  Verify purchases with a specific provider (e.g., IAPKit)