types library

Classes

ActiveSubscription
AndroidSubscriptionOfferInput
AppTransaction
BillingProgramAvailabilityResultAndroid
Result of checking billing program availability (Android) Available in Google Play Billing Library 8.2.0+
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.0+
DeepLinkOptions
DiscountAmountAndroid
Discount amount details for one-time purchase offers (Android) Available in Google Play Billing Library 7.0+
DiscountDisplayInfoAndroid
Discount display information for one-time purchase offers (Android) Available in Google Play Billing Library 7.0+
DiscountIOS
DiscountOfferInputIOS
DiscountOfferIOS
EntitlementIOS
ExternalOfferAvailabilityResultAndroid
External offer availability result (Android) @deprecated Use BillingProgramAvailabilityResultAndroid with isBillingProgramAvailableAsync instead Available in Google Play Billing Library 6.2.0+, deprecated in 8.2.0
ExternalOfferReportingDetailsAndroid
External offer reporting details (Android) @deprecated Use BillingProgramReportingDetailsAndroid with createBillingProgramReportingDetailsAsync instead Available in Google Play Billing Library 6.2.0+, deprecated in 8.2.0
ExternalPurchaseLinkResultIOS
Result of presenting an external purchase link (iOS 18.2+)
ExternalPurchaseNoticeResultIOS
Result of presenting external purchase notice sheet (iOS 18.2+)
FetchProductsResult
FetchProductsResultAll
FetchProductsResultProducts
FetchProductsResultSubscriptions
InitConnectionConfig
Connection initialization configuration
LaunchExternalLinkParamsAndroid
Parameters for launching an external link (Android) Used with launchExternalLink to initiate external offer or app install flows Available in Google Play Billing Library 8.2.0+
LimitedQuantityInfoAndroid
Limited quantity information for one-time purchase offers (Android) Available in Google Play Billing Library 7.0+
MutationHandlers
MutationResolver
GraphQL root mutation operations.
PreorderDetailsAndroid
Pre-order details for one-time purchase products (Android) Available in Google Play Billing Library 8.1.0+
PricingPhaseAndroid
PricingPhasesAndroid
Product
ProductAndroid
ProductAndroidOneTimePurchaseOfferDetail
One-time purchase offer details (Android) Available in Google Play Billing Library 7.0+
ProductCommon
ProductIOS
ProductOrSubscription
ProductOrSubscriptionProduct
ProductOrSubscriptionProductSubscription
ProductRequest
ProductSubscription
ProductSubscriptionAndroid
ProductSubscriptionAndroidOfferDetails
ProductSubscriptionIOS
Purchase
PurchaseAndroid
PurchaseCommon
PurchaseError
PurchaseIOS
PurchaseOfferIOS
PurchaseOptions
QueryHandlers
QueryResolver
GraphQL root query operations.
RefundResultIOS
RenewalInfoIOS
Subscription renewal information from Product.SubscriptionInfo.RenewalInfo https://developer.apple.com/documentation/storekit/product/subscriptioninfo/renewalinfo
RentalDetailsAndroid
Rental details for one-time purchase products that can be rented (Android) Available in Google Play Billing Library 7.0+
RequestPurchaseAndroidProps
RequestPurchaseIosProps
RequestPurchaseProps
RequestPurchasePropsByPlatforms
Platform-specific purchase request parameters.
RequestPurchaseResult
RequestPurchaseResultPurchase
RequestPurchaseResultPurchases
RequestSubscriptionAndroidProps
RequestSubscriptionIosProps
RequestSubscriptionPropsByPlatforms
Platform-specific subscription request parameters.
RequestVerifyPurchaseWithIapkitAppleProps
RequestVerifyPurchaseWithIapkitGoogleProps
RequestVerifyPurchaseWithIapkitProps
Platform-specific verification parameters for IAPKit.
RequestVerifyPurchaseWithIapkitResult
SubscriptionHandlers
SubscriptionInfoIOS
SubscriptionOfferIOS
SubscriptionPeriodValueIOS
SubscriptionProductReplacementParamsAndroid
Product-level subscription replacement parameters (Android) Used with setSubscriptionProductReplacementParams in BillingFlowParams.ProductDetailsParams Available in Google Play Billing Library 8.1.0+
SubscriptionResolver
GraphQL root subscription operations.
SubscriptionStatusIOS
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 7.0+
VerifyPurchaseAppleOptions
Apple App Store verification parameters. Used for server-side receipt validation via App Store Server API.
VerifyPurchaseGoogleOptions
Google Play Store verification parameters. Used for server-side receipt validation via Google Play Developer API.
VerifyPurchaseHorizonOptions
Meta Horizon (Quest) verification parameters. Used for server-side entitlement verification via Meta's S2S API. POST https://graph.oculus.com/$APP_ID/verify_entitlement
VerifyPurchaseProps
Platform-specific purchase verification parameters.
VerifyPurchaseResult
VerifyPurchaseResultAndroid
VerifyPurchaseResultHorizon
Result from Meta Horizon verify_entitlement API. Returns verification status and grant time for the entitlement.
VerifyPurchaseResultIOS
VerifyPurchaseWithProviderError
VerifyPurchaseWithProviderProps
VerifyPurchaseWithProviderResult

Enums

AlternativeBillingModeAndroid
Alternative billing mode for Android Controls which billing system is used
BillingProgramAndroid
Billing program types for external content links and external offers (Android) Available in Google Play Billing Library 8.2.0+
ErrorCode
ExternalLinkLaunchModeAndroid
Launch mode for external link flow (Android) Determines how the external URL is launched Available 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.0+
ExternalPurchaseNoticeAction
User actions on external purchase notice sheet (iOS 18.2+)
IapEvent
IapkitPurchaseState
Unified purchase states from IAPKit verification response.
IapPlatform
IapStore
PaymentModeIOS
ProductQueryType
ProductType
ProductTypeIOS
PurchaseState
PurchaseVerificationProvider
SubscriptionOfferTypeIOS
SubscriptionPeriodIOS
SubscriptionReplacementModeAndroid
Replacement mode for subscription changes (Android) These modes determine how the subscription replacement affects billing. Available in Google Play Billing Library 8.1.0+

Typedefs

MutationAcknowledgePurchaseAndroidHandler = Future<bool> Function(String purchaseToken)
MutationBeginRefundRequestIOSHandler = Future<String?> Function(String sku)
MutationCheckAlternativeBillingAvailabilityAndroidHandler = Future<bool> Function()
MutationClearTransactionIOSHandler = Future<bool> Function()
MutationConsumePurchaseAndroidHandler = Future<bool> Function(String purchaseToken)
MutationCreateAlternativeBillingTokenAndroidHandler = Future<String?> Function()
MutationDeepLinkToSubscriptionsHandler = Future<void> Function({String? packageNameAndroid, String? skuAndroid})
MutationEndConnectionHandler = Future<bool> Function()
MutationFinishTransactionHandler = Future<void> Function({bool? isConsumable, required PurchaseInput purchase})
MutationInitConnectionHandler = Future<bool> Function({AlternativeBillingModeAndroid? alternativeBillingModeAndroid})
MutationPresentCodeRedemptionSheetIOSHandler = Future<bool> Function()
MutationPresentExternalPurchaseLinkIOSHandler = Future<ExternalPurchaseLinkResultIOS> Function(String url)
MutationPresentExternalPurchaseNoticeSheetIOSHandler = Future<ExternalPurchaseNoticeResultIOS> Function()
MutationRequestPurchaseHandler = Future<RequestPurchaseResult?> Function(RequestPurchaseProps params)
MutationRequestPurchaseOnPromotedProductIOSHandler = Future<bool> Function()
MutationRestorePurchasesHandler = Future<void> Function()
MutationShowAlternativeBillingDialogAndroidHandler = Future<bool> Function()
MutationShowManageSubscriptionsIOSHandler = Future<List<PurchaseIOS>> Function()
MutationSyncIOSHandler = Future<bool> Function()
MutationValidateReceiptHandler = Future<VerifyPurchaseResult> Function({VerifyPurchaseAppleOptions? apple, VerifyPurchaseGoogleOptions? google, VerifyPurchaseHorizonOptions? horizon})
MutationVerifyPurchaseHandler = Future<VerifyPurchaseResult> Function({VerifyPurchaseAppleOptions? apple, VerifyPurchaseGoogleOptions? google, VerifyPurchaseHorizonOptions? horizon})
MutationVerifyPurchaseWithProviderHandler = Future<VerifyPurchaseWithProviderResult> Function({RequestVerifyPurchaseWithIapkitProps? iapkit, required PurchaseVerificationProvider provider})
PurchaseInput = Purchase
QueryCanPresentExternalPurchaseNoticeIOSHandler = Future<bool> Function()
QueryCurrentEntitlementIOSHandler = Future<PurchaseIOS?> Function(String sku)
QueryFetchProductsHandler = Future<FetchProductsResult> Function({required List<String> skus, ProductQueryType? type})
QueryGetActiveSubscriptionsHandler = Future<List<ActiveSubscription>> Function([List<String>? subscriptionIds])
QueryGetAppTransactionIOSHandler = Future<AppTransaction?> Function()
QueryGetAvailablePurchasesHandler = Future<List<Purchase>> Function({bool? alsoPublishToEventListenerIOS, bool? onlyIncludeActiveItemsIOS})
QueryGetPendingTransactionsIOSHandler = Future<List<PurchaseIOS>> Function()
QueryGetPromotedProductIOSHandler = Future<ProductIOS?> Function()
QueryGetReceiptDataIOSHandler = Future<String?> Function()
QueryGetStorefrontHandler = Future<String> Function()
QueryGetStorefrontIOSHandler = Future<String> Function()
QueryGetTransactionJwsIOSHandler = Future<String?> Function(String sku)
QueryHasActiveSubscriptionsHandler = Future<bool> Function([List<String>? subscriptionIds])
QueryIsEligibleForIntroOfferIOSHandler = Future<bool> Function(String groupID)
QueryIsTransactionVerifiedIOSHandler = Future<bool> Function(String sku)
QueryLatestTransactionIOSHandler = Future<PurchaseIOS?> Function(String sku)
QuerySubscriptionStatusIOSHandler = Future<List<SubscriptionStatusIOS>> Function(String sku)
QueryValidateReceiptIOSHandler = Future<VerifyPurchaseResultIOS> Function({VerifyPurchaseAppleOptions? apple, VerifyPurchaseGoogleOptions? google, VerifyPurchaseHorizonOptions? horizon})
SubscriptionPromotedProductIOSHandler = Future<String> Function()
SubscriptionPurchaseErrorHandler = Future<PurchaseError> Function()
SubscriptionPurchaseUpdatedHandler = Future<Purchase> Function()
SubscriptionUserChoiceBillingAndroidHandler = Future<UserChoiceBillingDetails> Function()
VoidResult = void