A storefront-independent API for purchases in Flutter apps.
This plugin supports in-app purchases (IAP) through an underlying store, which can be the App Store (on iOS) or Google Play (on Android).
Use this plugin in your Flutter app to:
This plugin relies on the App Store and Google Play for making in-app purchases. It exposes a unified surface, but you still need to understand and configure your app with each store. Both stores have extensive guides:
For a list of steps for configuring in-app purchases in both stores, see the example app README.
Once you've configured your in-app purchases in their respective stores, you can start using the plugin. Two basic options are available:
A generic, idiomatic Flutter API: in_app_purchase. This API supports most use cases for loading and making purchases.
Platform-specific Dart APIs: store_kit_wrappers and billing_client_wrappers. These APIs expose platform-specific behavior and allow for more fine-tuned control when needed. However, if you use one of these APIs, your purchase-handling logic is significantly different for the different storefronts.
See also the codelab for in-app purchases in Flutter for a detailed guide on adding in-app purchase support to a Flutter App.
This section has examples of code for the following tasks:
The following initialization code is required for Google Play:
// Import `in_app_purchase_android.dart` to be able to access the // `InAppPurchaseAndroidPlatformAddition` class. import 'package:in_app_purchase_android/in_app_purchase_android.dart'; void main() { // Inform the plugin that this app supports pending purchases on Android. // An error will occur on Android if you access the plugin `instance` // without this call. if (defaultTargetPlatform == TargetPlatform.android) { InAppPurchaseAndroidPlatformAddition.enablePendingPurchases(); } runApp(MyApp()); }
Note: It is not necessary to depend on com.android.billingclient:billing
in your own app's android/app/build.gradle
file. If you choose to do so know that conflicts might occur.
In your app's initState
method, subscribe to any incoming purchases. These can propagate from either underlying store. You should always start listening to purchase update as early as possible to be able to catch all purchase updates, including the ones from the previous app session. To listen to the update:
class _MyAppState extends State<MyApp> { StreamSubscription<List<PurchaseDetails>> _subscription; @override void initState() { final Stream purchaseUpdated = InAppPurchase.instance.purchaseStream; _subscription = purchaseUpdated.listen((purchaseDetailsList) { _listenToPurchaseUpdated(purchaseDetailsList); }, onDone: () { _subscription.cancel(); }, onError: (error) { // handle error here. }); super.initState(); } @override void dispose() { _subscription.cancel(); super.dispose(); }
Here is an example of how to handle purchase updates:
void _listenToPurchaseUpdated(List<PurchaseDetails> purchaseDetailsList) { purchaseDetailsList.forEach((PurchaseDetails purchaseDetails) async { if (purchaseDetails.status == PurchaseStatus.pending) { _showPendingUI(); } else { if (purchaseDetails.status == PurchaseStatus.error) { _handleError(purchaseDetails.error!); } else if (purchaseDetails.status == PurchaseStatus.purchased || purchaseDetails.status == PurchaseStatus.restored) { bool valid = await _verifyPurchase(purchaseDetails); if (valid) { _deliverProduct(purchaseDetails); } else { _handleInvalidPurchase(purchaseDetails); return; } } if (purchaseDetails.pendingCompletePurchase) { await InAppPurchase.instance .completePurchase(purchaseDetails); } } }); }
final bool available = await InAppPurchase.instance.isAvailable(); if (!available) { // The store cannot be reached or accessed. Update the UI accordingly. }
// Set literals require Dart 2.2. Alternatively, use // `Set<String> _kIds = <String>['product1', 'product2'].toSet()`. const Set<String> _kIds = <String>{'product1', 'product2'}; final ProductDetailsResponse response = await InAppPurchase.instance.queryProductDetails(_kIds); if (response.notFoundIDs.isNotEmpty) { // Handle the error. } List<ProductDetails> products = response.productDetails;
Restored purchases will be emitted on the InAppPurchase.purchaseStream
, make sure to validate restored purchases following the best practices for each underlying store:
await InAppPurchase.instance.restorePurchases();
Note that the App Store does not have any APIs for querying consumable products, and Google Play considers consumable products to no longer be owned once they‘re marked as consumed and fails to return them here. For restoring these across devices you’ll need to persist them on your own server and query that as well.
Both underlying stores handle consumable and non-consumable products differently. If you're using InAppPurchase
, you need to make a distinction here and call the right purchase method for each type.
final ProductDetails productDetails = ... // Saved earlier from queryProductDetails(). final PurchaseParam purchaseParam = PurchaseParam(productDetails: productDetails); if (_isConsumable(productDetails)) { InAppPurchase.instance.buyConsumable(purchaseParam: purchaseParam); } else { InAppPurchase.instance.buyNonConsumable(purchaseParam: purchaseParam); } // From here the purchase flow will be handled by the underlying store. // Updates will be delivered to the `InAppPurchase.instance.purchaseStream`.
The InAppPurchase.purchaseStream
will send purchase updates after you initiate the purchase flow using InAppPurchase.buyConsumable
or InAppPurchase.buyNonConsumable
. After delivering the content to the user, call InAppPurchase.completePurchase
to tell the App Store and Google Play that the purchase has been finished.
Warning: Failure to call
InAppPurchase.completePurchase
and get a successful response within 3 days of the purchase will result a refund.
To upgrade/downgrade an existing in-app subscription in Google Play, you need to provide an instance of ChangeSubscriptionParam
with the old PurchaseDetails
that the user needs to migrate from, and an optional ProrationMode
with the GooglePlayPurchaseParam
object while calling InAppPurchase.buyNonConsumable
.
The App Store does not require this because it provides a subscription grouping mechanism. Each subscription you offer must be assigned to a subscription group. Grouping related subscriptions together can help prevent users from accidentally purchasing multiple subscriptions. Refer to the Creating a Subscription Group section of Apple's subscription guide.
final PurchaseDetails oldPurchaseDetails = ...; PurchaseParam purchaseParam = GooglePlayPurchaseParam( productDetails: productDetails, changeSubscriptionParam: ChangeSubscriptionParam( oldPurchaseDetails: oldPurchaseDetails, prorationMode: ProrationMode.immediateWithTimeProration)); InAppPurchase.instance .buyNonConsumable(purchaseParam: purchaseParam);
The following code brings up a sheet that enables the user to redeem offer codes that you've set up in App Store Connect. For more information on redeeming offer codes, see Implementing Offer Codes in Your App.
InAppPurchaseIosPlatformAddition iosPlatformAddition = InAppPurchase.getPlatformAddition<InAppPurchaseIosPlatformAddition>(); iosPlatformAddition.presentCodeRedemptionSheet();
note: The
InAppPurchaseIosPlatformAddition
is defined in thein_app_purchase_ios.dart
file so you need to import it into the file you will be usingInAppPurchaseIosPlatformAddition
:import 'package:in_app_purchase_ios/in_app_purchase_ios.dart';
If you would like to contribute to the plugin, check out our contribution guide.