flutter_inapp_purchase

Pub Version Build Status License Coverage Status

Sun Rise :sunrise:

Since many one of you wanted me to keep working on this plugin in #93, I've decided to keep working on current project. I hope many one of you can help me maintain this. Thank you for all your supports in advance :tada:.

## Deprecated I've been maintaining this plugin since there wasn't an official plugin out when I implemented it. I saw in flutter github issue #9591 that many people have been waiting for this plugin for more than a year before I've thought of building one. However, there has been an official Google plugin rised today which is in_app_purchase. Please try to use an official one because you might want to get much prompt support from giant Google. Also, thanks for all your supports that made me stubborn to work hard on this plugin. I've had great experience with all of you and hope we can meet someday with other projects. I'll leave this project as live for those who need time. I'll also try to merge the new PR's and publish to pub if there's any further work given to this repo.

What this plugin do

This is an In App Purchase plugin for flutter. This project has been forked from react-native-iap. We are trying to share same experience of in-app-purchase in flutter as in react-native. We will keep working on it as time goes by just like we did in react-native-iap.

PR is always welcomed.

Breaking Changes

  • Sunrise in 2.0.0 for highly requests from customers on discomfort in what's called an official plugin in_app_purchase.
  • Migrated to Android X in 0.9.0. Please check the Migration Guide.
  • There was parameter renaming in 0.5.0 to identify different parameters sent from the device. Please check the readme.

Migration Guide

To migrate to 0.9.0 you must migrate your Android app to Android X by following the Migrating to AndroidX Guide.

Getting Started

Follow the Medium Blog for the configuration.

For help getting started with Flutter, view our online documentation.

For help on editing plugin code, view the documentation.

Methods

FuncParamReturnDescription
initConnectionStringPrepare IAP module. Must be called on Android before any other purchase flow methods. In ios, it will simply call canMakePayments method and return value.
getProductsList<String> Product IDs/skusList<IAPItem>Get a list of products (consumable and non-consumable items, but not subscriptions). Note: On iOS versions earlier than 11.2 this method will return subscriptions if they are included in your list of SKUs. This is because we cannot differentiate between IAP products and subscriptions prior to 11.2.
getSubscriptionsList<String> Subscription IDs/skusList<IAPItem>Get a list of subscriptions. Note: On iOS this method has the same output as getProducts. Because iOS does not differentiate between IAP products and subscriptions.
getPurchaseHistoryList<IAPItem>Gets an invetory of purchases made by the user regardless of consumption status (where possible)
getAvailablePurchasesList<PurchasedItem>(aka restore purchase) Get all purchases made by the user (either non-consumable, or haven't been consumed yet)
getAppStoreInitiatedProductsList<IAPItem>If the user has initiated a purchase directly on the App Store, the products that the user is attempting to purchase will be returned here. (iOS only) Note: On iOS versions earlier than 11.0 this method will always return an empty list, as the functionality was introduced in v11.0. See Apple Docs for more info Always returns an empty list on Android.
requestSubscriptionString sku, String oldSkuAndroid?, int prorationModeAndroid?, String developerIdAndroid, String accountIdAndroidNullCreate (request) a subscription to a sku. For upgrading/downgrading subscription on Android pass second parameter with current subscription ID, on iOS this is handled automatically by store. purchaseUpdatedListener will receive the result.
requestPurchaseString sku, String developerIdAndroid, String accoundIdAndroidNullRequest a purchase. purchaseUpdatedListener will receive the result.
finishTransactionIOSString purchaseTokenPurchaseResultSend finishTransaction call to Apple IAP server. Call this function after receipt validation process
acknowledgePurchaseAndroidString purchaseToken, String developerPayload?PurchaseResultAcknowledge a product (on Android) for non-consumable and subscription purchase. No-op on iOS.
consumePurchaseAndroidString purchaseToken, String developerPayload?PurchaseResultConsume a product (on Android) for consumable purchase. No-op on iOS.
finishTransactionString purchaseToken, String deveoperPayloadAndroid?, bool isConsumable? }PurchaseResultSend finishTransaction call that abstracts all acknowledgePurchaseAndroid, finishTransactionIOS, consumePurchaseAndroid methods.
endConnectionStringEnd billing connection (on Android.) No-op on iOS.
consumeAllItemsStringManually consume all items in android. Do NOT call if you have any non-consumables (one time purchase items). No-op on iOS.
validateReceiptIosMap<String,String> receiptBody, bool isTesthttp.ResponseValidate receipt for ios.
validateReceiptAndroidString packageName, String productId, String productToken, String accessToken, bool isSubscriptionhttp.ResponseValidate receipt for android.

Purchase flow in `flutter_inapp_purchase@2.0.0+

purchase-flow-sequence

When you've successfully received result from purchaseUpdated listener, you'll have to verify the purchase either by acknowledgePurchaseAndroid, consumePurchaseAndroid, finishTransactionIOS depending on the purchase types or platforms. You'll have to use consumePurchasAndroid for consumable products and android and acknowledgePurchaseAndroid for non-consumable products either subscription. For ios, there is no differences in verifying purchases. You can just call finishTransaction. If you do not verify the purchase, it will be refunded within 3 days to users. We recommend you to verifyReceipt first before actually finishing transaction. Lastly, if you want to abstract three different methods into one, consider using finishTransaction method.

Data Types

  • IAPItem

    final String productId;
    final String price;
    final String currency;
    final String localizedPrice;
    final String title;
    final String description;
    final String introductoryPrice;
    
    /// ios only
    final String subscriptionPeriodNumberIOS;
    final String subscriptionPeriodUnitIOS;
    final String introductoryPricePaymentModeIOS;
    final String introductoryPriceNumberOfPeriodsIOS;
    final String introductoryPriceSubscriptionPeriodIOS;
    
    /// android only
    final String subscriptionPeriodAndroid;
    final String introductoryPriceCyclesAndroid;
    final String introductoryPricePeriodAndroid;
    final String freeTrialPeriodAndroid;
    final String signatureAndroid;
    
    final String iconUrl;
    final String originalJson;
    final String originalPrice;
    
  • PurchasedItem

    final String productId;
    final String transactionId;
    final DateTime transactionDate;
    final String transactionReceipt;
    final String purchaseToken;
    final String orderId;
    
    // Android only
    final String dataAndroid;
    final String signatureAndroid;
    final bool autoRenewingAndroid;
    final bool isAcknowledgedAndroid;
    final int purchaseStateAndroid;
    final String developerPayloadAndroid;
    final String originalJsonAndroid;
    
    // iOS only
    final DateTime originalTransactionDateIOS;
    final String originalTransactionIdentifierIOS;
    

Install

Add flutter_inapp_purchase as a dependency in pubspec.yaml

For help on adding as a dependency, view the documentation.

Configuring in app purchase

Usage Guide

Android connect and endConnection

  • You should start the billing service in android to use its funtionalities. We recommend you to use initConnection getter method in initState(). Note that this step is necessary in ios also from flutter_inapp_purchase@2.0.0+ which will also register the purchaseUpdated and purchaseError Stream.

      /// start connection for android
      @override
      void initState() {
        super.initState();
        asyncInitState(); // async is not allowed on initState() directly
      }
    
      void asyncInitState() async {
        await FlutterInappPurchase.initConnection;
      }
    
  • You should end the billing service in android when you are done with it. Otherwise it will be keep running in background. We recommend to use this feature in dispose().

  • Additionally, we've added connectionUpdated stream just in case if you'd like to monitor the connection more thoroughly form 2.0.1.

    _conectionSubscription = FlutterInappPurchase.connectionUpdated.listen((connected) {
      print('connected: $connected');
    });
    

    You can see how you can use this in detail in example project.

      /// start connection for android
      @override
      void dispose() async{
        super.dispose();
        await FlutterInappPurchase.endConnection;
      }
    

Get IAP items

  void getItems () async {
    List<IAPItem> items = await FlutterInappPurchase.getProducts(_productLists);
    for (var item in items) {
      print('${item.toString()}');
      this._items.add(item);
    }
  }

Purchase Item

  void purchase() {
    FlutterInappPurchase.instance.requestPurchase(item.productId);
  }

Register listeners to receive purchase

  StreamSubscription _purchaseUpdatedSubscription = FlutterInappPurchase.purchaseUpdated.listen((productItem) {
    print('purchase-updated: $productItem');
  });

  StreamSubscription _purchaseErrorSubscription = FlutterInappPurchase.purchaseError.listen((purchaseError) {
    print('purchase-error: $purchaseError');
  });

Remove listeners when ending connection

  _purchaseUpdatedSubscription.cancel();
  _purchaseUpdatedSubscription = null;
  _purchaseErrorSubscription.cancel();
  _purchaseErrorSubscription = null;

Receipt validation

From 0.7.1, we support receipt validation. For Android, you need separate json file from the service account to get the access_token from google-apis, therefore it is impossible to implement serverless. You should have your own backend and get access_token. With access_token you can simply call validateReceiptAndroid method we implemented. Further reading is here. Currently, serverless receipt validation is possible using validateReceiptIos method. The first parameter, you should pass transactionReceipt which returns after requestPurchase. The second parameter, you should pass whether this is test environment. If true, it will request to sandbox and false it will request to production.

  validateReceipt() async {
    var receiptBody = {
      'receipt-data': purchased.transactionReceipt,
      'password': '******'
    };
    const result = await validateReceiptIos(receiptBody, false);
    console.log(result);
  }

For further information, please refer to guide.

App Store initiated purchases

When the user starts an in-app purchase in the App Store, the transaction continues in your app, the product will then be added to a list that you can access through the method getAppStoreInitiatedProducts. This means you can decide how and when to continue the transaction. To continue the transaction simple use the standard purchase flow from this plugin.

void checkForAppStoreInitiatedProducts() async {
  List<IAPItem> appStoreProducts = await FlutterInappPurchase.getAppStoreInitiatedProducts(); // Get list of products
  if (appStoreProducts.length > 0) {
    _requestPurchase(appStoreProducts.last); // Buy last product in the list
  }
}

Example

Direct to example readme which is just a cp from example project. You can test this in real example project.

ProGuard

If you have eneabled proguard you will need to add the following rules to your proguard-rules.pro

#In app Purchase
-keep class com.amazon.** {*;}
-keep class com.dooboolab.** { *; }
-keep class com.android.vending.billing.**
-dontwarn com.amazon.**
-keepattributes *Annotation*

Q & A

Can I buy product right away skipping fetching products if I already know productId?

  • You can in Android but not in ios. In ios you should always fetchProducts first. You can see more info here.

How do I validate receipt in ios?

  • Official doc is here.

How do I validate receipt in android?

  • Offical doc is here.
  • I've developed this feature for other developers to contribute easily who are aware of these things. The doc says you can also get the accessToken via play console without any of your backend server. You can get this by following process.
    • Select your app > Services & APIs > "YOUR LICENSE KEY FOR THIS APPLICATION Base64-encoded RSA public key to include in your binary". reference.

Invalid productId in ios.

  • Please try below and make sure you've done belows.
    • Steps
      1. Completed an effective "Agreements, Tax, and Banking."
      2. Setup sandbox testing account in "Users and Roles."
      3. Signed into iOS device with sandbox account.
      4. Set up three In-App Purchases with the following status: i. Ready to Submit ii. Missing Metadata iii. Waiting for Review
      5. Enable "In-App Purchase" in Xcode "Capabilities" and in Apple Developer -> "App ID" setting. Delete app / Restart device / Quit "store" related processes in Activity Monitor / Xcode Development Provisioning Profile -> Clean -> Build.

Help Maintenance

I've been maintaining quite many repos these days and burning out slowly. If you could help me cheer up, buying me a cup of coffee will make my life really happy and get much energy out of it.

Paypal Buy Me A Coffee

Libraries

flutter_inapp_purchase
modules
utils