Package dev.hyo.openiap
See: Description
-
-
Class Summary Class Description ProductNotFound PurchaseFailed BillingError PurchaseVerificationFailed Purchase verification failed with a specific error from the verification provider (e.g. UnknownError QueryProduct SkuNotFound UserCancelled ItemAlreadyOwned ItemNotOwned ServiceUnavailable BillingUnavailable ItemUnavailable DeveloperError FeatureNotSupported ServiceDisconnected ServiceTimeout AlternativeBillingUnavailable OpenIapError OpenIAP specific exceptions OpenIapViewModel Android ViewModel wrapper around OpenIapStore for easy integration ActiveSubscription AdvancedCommerceInfoIOS Advanced Commerce metadata from a transaction (iOS 18.4+). AdvancedCommerceItemDetailsIOS Details of an Advanced Commerce item (iOS 18.4+). AdvancedCommerceItemIOS An item purchased through the Advanced Commerce API (iOS 18.4+). AdvancedCommerceRefundIOS Refund information for an Advanced Commerce item (iOS 18.4+). AppTransaction BillingChoiceInfoAndroid Display information for developer-rendered Billing Choice screens (Android) Available in OpenIAP Spec 2.1.0 / openiap-google 2.3.0 (requires Play Billing 9.1.0+). BillingProgramAvailabilityResultAndroid Result of checking billing program availability (Android) Available in Google Play Billing Library 8.2. BillingProgramReportingDetailsAndroid Reporting details for transactions made outside of Google Play Billing (Android) Contains the external transaction token needed for reporting Available in Google Play Billing Library 8.2. BillingResultAndroid Extended billing result with sub-response code (Android) Available in Google Play Billing Library 8.0. BundledSubscriptionIOS Metadata for one auto-renewable subscription included in an Apple subscription bundle (Apple 27+ beta). DeveloperProvidedBillingDetailsAndroid Details provided when user selects developer billing option (Android) Received via DeveloperProvidedBillingListener callback Available in Google Play Billing Library 8.3. DeveloperProvidedBillingProductAndroid Product selected for developer-provided billing (Android 9.0+). DiscountAmountAndroid Discount amount details for one-time purchase offers (Android) Available in Google Play Billing Library 8. DiscountDisplayInfoAndroid Discount display information for one-time purchase offers (Android) Available in Google Play Billing Library 8. DiscountOffer Standardized one-time product discount offer. EntitlementIOS ExternalPurchaseCustomLinkNoticeResultIOS Result of showing ExternalPurchaseCustomLink notice (iOS 18.1+). ExternalPurchaseCustomLinkTokenResultIOS Result of requesting an ExternalPurchaseCustomLink token (iOS 18.1+). ExternalPurchaseLinkResultIOS Result of presenting an external purchase link ExternalPurchaseNoticeResultIOS Result of presenting external purchase notice sheet (iOS 17.4+) Returns the token when user continues to external purchase. FetchProductsResultAll FetchProductsResultProducts FetchProductsResultSubscriptions IapkitProductClientPayload Public app-facing data attached to one store product in IAPKit. InAppMessageResultAndroid Result from showing Play billing in-app messages (Android) Available in OpenIAP Spec 2.1.0 / openiap-google 2.3.0 (upstream API available since Play Billing 4.1.0). InstallmentPlanDetailsAndroid Installment plan details for subscription offers (Android) Contains information about the installment plan commitment. LimitedQuantityInfoAndroid Limited quantity information for one-time purchase offers (Android) Available in Google Play Billing Library 8. PendingPurchaseUpdateAndroid Pending purchase update for subscription upgrades/downgrades (Android) When a user initiates a subscription change (upgrade/downgrade), the new purchase may be pending until the current billing period ends. PreorderDetailsAndroid Pre-order details for one-time purchase products (Android) Available in Google Play Billing Library 8.1. PricingPhaseAndroid PricingPhasesAndroid ProductAndroid ProductIOS ProductSubscriptionAndroid ProductSubscriptionIOS PurchaseAndroid PurchaseError PurchaseIOS PurchaseOfferIOS RefundResultIOS RenewalCommitmentInfoIOS RenewalInfoIOS Subscription renewal information from Product.SubscriptionInfo.RenewalInfo https://developer.apple. RentalDetailsAndroid Rental details for one-time purchase products that can be rented (Android) Available in Google Play Billing Library 8. RequestPurchaseResultPurchase RequestPurchaseResultPurchases RequestVerifyPurchaseWithIapkitResult SubscriptionCommitmentInfoIOS SubscriptionOffer Standardized subscription discount/promotional offer. SubscriptionPeriod Subscription period value combining unit and count. SubscriptionPeriodValueIOS SubscriptionPricingTermsIOS SubscriptionStatusIOS TransactionCommitmentInfoIOS UserChoiceBillingDetails User Choice Billing event details (Android) Fired when a user selects alternative billing in the User Choice Billing dialog ValidTimeWindowAndroid Valid time window for when an offer is available (Android) Available in Google Play Billing Library 8. VerifyPurchaseResultAndroid VerifyPurchaseResultHorizon Result from Meta Horizon verify_entitlement API. VerifyPurchaseResultIOS VerifyPurchaseWithProviderError VerifyPurchaseWithProviderResult AndroidSubscriptionOfferInput BillingProgramInformationDialogParamsAndroid Parameters for showing a billing program information dialog (Android) Available in OpenIAP Spec 2.1.0 / openiap-google 2.3.0 (requires Play Billing 9.1.0+). DeepLinkOptions DeveloperBillingOptionParamsAndroid Parameters for a developer billing option in a purchase flow (Android). DiscountOfferInputIOS GetBillingChoiceInfoParamsAndroid Parameters for fetching Billing Choice display information (Android) Available in OpenIAP Spec 2.1.0 / openiap-google 2.3.0 (requires Play Billing 9.1.0+). InAppMessageParamsAndroid Parameters for showing Play billing in-app messages (Android) Available in OpenIAP Spec 2.1.0 / openiap-google 2.3.0 (upstream API available since Play Billing 4.1.0). InitConnectionConfig Connection initialization configuration LaunchExternalLinkParamsAndroid Parameters for launching an external link (Android) Used with launchExternalLink to initiate external offer, app install, or developer-rendered Billing Choice flows Available in Google Play Billing Library 8.2. ProductRequest PromotionalOfferJWSInputIOS JWS promotional offer input for iOS 15+ (StoreKit 2, WWDC 2025). PurchaseOptions PurchaseUpdatedListenerOptions RequestPurchaseAndroidProps RequestPurchaseIosProps Purchase Per-platform purchase request props Subscription Per-platform subscription request props Request RequestPurchaseProps RequestPurchasePropsByPlatforms Platform-specific purchase request parameters. RequestSubscriptionAndroidProps RequestSubscriptionIosProps RequestSubscriptionPropsByPlatforms Platform-specific subscription request parameters. RequestVerifyPurchaseWithIapkitAmazonProps RequestVerifyPurchaseWithIapkitAppleProps RequestVerifyPurchaseWithIapkitGoogleProps RequestVerifyPurchaseWithIapkitProps Platform-specific verification parameters for IAPKit. SubscriptionProductReplacementParamsAndroid Product-level subscription replacement parameters (Android) Used with setSubscriptionProductReplacementParams in BillingFlowParams.ProductDetailsParams Available in Google Play Billing Library 8.1. VerifyPurchaseAppleOptions Apple App Store verification parameters. VerifyPurchaseGoogleOptions Google Play Store verification parameters. VerifyPurchaseHorizonOptions Meta Horizon (Quest) verification parameters. VerifyPurchaseProps Platform-specific purchase verification parameters. VerifyPurchaseWithProviderProps WinBackOfferInputIOS Win-back offer input for iOS 18+ (StoreKit 2) Win-back offers are used to re-engage churned subscribers. ProductItem ProductSubscriptionItem MutationHandlers QueryHandlers SubscriptionHandlers OpenIapModule Main OpenIapModule implementation for Android OpenIapErrorExtensionsKt -
Enum Summary Enum Description Level BillingChoiceImageLayoutAndroid Play Billing choice image layout (Android) Available in OpenIAP Spec 2.1.0 / openiap-google 2.3.0 (requires Play Billing 9.1.0+). BillingChoiceScreenTypeAndroid Choice screen renderer for Billing Choice availability (Android) Available in OpenIAP Spec 2.1.0 / openiap-google 2.3.0 (requires Play Billing 9.1.0+). BillingProgramAndroid Billing program types for Google Play Billing Programs (Android) Available in Google Play Billing Library 8.2.0 (External Offer and External Content Link integrations require 8.2.1+), EXTERNAL_PAYMENTS added in 8.3.0, BILLING_CHOICE added in OpenIAP Spec 2.1.0 / openiap-google 2.3.0 (requires Play Billing 9.1.0+). DeveloperBillingLaunchModeAndroid Launch mode for developer billing option (Android) Determines how the external payment URL is launched Available in Google Play Billing Library 8.3. DeveloperBillingTypeAndroid Developer-provided billing destination type for Billing Program reporting details (Android) Available in OpenIAP Spec 2.1.0 / openiap-google 2.3.0 (requires Play Billing 9.1.0+). DiscountOfferType Discount offer type enumeration. ErrorCode ExternalLinkLaunchModeAndroid Launch mode for external link flow (Android) Determines how the external URL is launched Introduced in Google Play Billing Library 8.2.0. ExternalLinkTypeAndroid Link type for external link flow (Android) Specifies the type of external link destination Available in Google Play Billing Library 8.2. ExternalPurchaseCustomLinkNoticeTypeIOS Notice types for ExternalPurchaseCustomLink (iOS 18.1+). ExternalPurchaseCustomLinkTokenTypeIOS Token types for ExternalPurchaseCustomLink (iOS 18.1+). ExternalPurchaseNoticeAction User actions on external purchase notice sheet (iOS 17. IapEvent IapkitClientPayloadFormat Serialization format of a public IAPKit product client payload. IapkitPurchaseState Unified purchase states from IAPKit verification response. IapPlatform IapStore InAppMessageCategoryAndroid High-level in-app message category (Android) Available in OpenIAP Spec 2.1.0 / openiap-google 2.3.0 (upstream API available since Play Billing 4.1.0). InAppMessageResponseCodeAndroid Response code from Play billing in-app messages (Android) Available in OpenIAP Spec 2.1.0 / openiap-google 2.3.0 (upstream API available since Play Billing 4.1.0). PaymentMode Payment mode for subscription offers. PaymentModeIOS ProductQueryType ProductStatusAndroid Status code for individual products returned from queryProductDetailsAsync (Android) Prior to 8.0, products that couldn't be fetched were simply not returned. ProductType ProductTypeIOS PurchaseState PurchaseVerificationProvider SubResponseCodeAndroid Sub-response codes for more granular purchase error information (Android) Available in Google Play Billing Library 8.0. SubscriptionBillingPlanTypeIOS SubscriptionOfferTypeIOS SubscriptionPeriodIOS SubscriptionPeriodUnit Subscription period unit for cross-platform use. SubscriptionReplacementModeAndroid Replacement mode for subscription changes (Android) These modes determine how the subscription replacement affects billing. -
Interface Summary Interface Description OpenIapProtocol Shared contract implemented by platform-specific OpenIAP billing modules. ProductCommon PurchaseCommon FetchProductsResult RequestPurchaseResult Product ProductOrSubscription ProductSubscription Purchase VerifyPurchaseResult MutationResolver GraphQL root mutation operations. QueryResolver GraphQL root query operations. SubscriptionResolver GraphQL root subscription operations.