Plugin.InAppBilling
8.0.5
See the version list below for details.
dotnet add package Plugin.InAppBilling --version 8.0.5
NuGet\Install-Package Plugin.InAppBilling -Version 8.0.5
<PackageReference Include="Plugin.InAppBilling" Version="8.0.5" />
paket add Plugin.InAppBilling --version 8.0.5
#r "nuget: Plugin.InAppBilling, 8.0.5"
// Install Plugin.InAppBilling as a Cake Addin #addin nuget:?package=Plugin.InAppBilling&version=8.0.5 // Install Plugin.InAppBilling as a Cake Tool #tool nuget:?package=Plugin.InAppBilling&version=8.0.5
In-App Billing Plugin for .NET MAUI and Windows
A simple In-App Purchase plugin for .NET MAUI and Windows to query item information, purchase items, restore items, and more.
Subscriptions are supported on iOS, Android, and Mac. Windows/UWP/WinUI 3 - does not support subscriptions at this time.
Important Version Information
- v8 now supports .NET 8+ .NET MAUI and Windows Apps.
- v7 now supports .NET 6+, .NET MAUI, UWP, and Xamarin/Xamarin.Forms projects
- v7 is built against Android Billing Library 6.0
- See migration guides below
Documentation
Get started by reading through the In-App Billing Plugin documentation.
NuGet
- NuGet: Plugin.InAppBilling
Platform Support
Platform | Version |
---|---|
iOS for .NET | 10+ |
macCatlyst for .NET | All |
tvOS for .NET | 10.13.2 |
Android for .NET | 21+ |
Windows App SDK (WinUI 3) | 10+ |
.NET MAUI | All |
Created By: @JamesMontemagno
- Twitter: @JamesMontemagno
- Blog: Montemagno.com
- Podcast: Merge Conflict
- Videos: James's YouTube Channel
Version 8 Major Updates
- Nice new re-write and re-implementation of APIs!
- Built against .NET 8
- Now using latest Android Billing v6.2.1
Version 7 Major Updates
- Android: You must compile and target against Android 12 or higher (or Android 13 if v7.1)
- Android: Now using Android Billing v6
- Android: Major changes to Android product details, subscriptions, and more
- Android: Please read through: https://developer.android.com/google/play/billing/migrate-gpblv6
- Android:
AcknowledgePurchaseAsync
is nowFinalizePurchaseAsync
- All: There are now "Extras" for all products that give you back tons of info for each platform
If you receive an error in Google Play you may need to add this to your AndroidManifest.xml inside the application node:
<meta-data
android:name="com.google.android.play.billingclient.version"
android:value="6.1.0" />
If you are building against .NET 8 for Android you will need to add the following packages when using v7:
<ItemGroup Condition="'$(TargetFramework)' == 'net8.0-android'">
<PackageReference Include="Xamarin.AndroidX.Activity" Version="1.9.0.3" />
<PackageReference Include="Xamarin.AndroidX.Activity.Ktx" Version="1.9.0.3" />
<PackageReference Include="Xamarin.AndroidX.Collection" Version="1.4.0.5" />
<PackageReference Include="Xamarin.AndroidX.Collection.Ktx" Version="1.4.0.4" />
<PackageReference Include="Xamarin.GooglePlayServices.Base" Version="118.4.0" />
</ItemGroup>
Pending Transactions:
- If the result of PurchaseAsync is PurchaseState.PaymentPending, store the order details locally and inform the user that they will have access to the product when the payment completes
- When the user starts the app (and/or visits a particular page), if the stored PurchaseState is PaymentPending, call GetPurchasesAsync and query the result for a purchase that matches the stored purchase.
- If the PurchaseState for this purchase is still PaymentPending, show the same no-access message
- If the PurchaseState is Purchased, call ConsumePurchaseAsync or AcknowledgePurchaseAsync, depending on the product type
To respond to pending transactions you can subscribe to a listener in your Android project startup:
// Connect to the service here
await CrossInAppBilling.Current.ConnectAsync();
// Check if there are pending orders, if so then subscribe
var purchases = await CrossInAppBilling.Current.GetPurchasesAsync(ItemType.InAppPurchase);
if (purchases?.Any(p => p.State == PurchaseState.PaymentPending) ?? false)
{
Plugin.InAppBilling.InAppBillingImplementation.OnAndroidPurchasesUpdated = (billingResult, purchases) =>
{
// decide what you are going to do here with purchases
// probably acknowledge
// probably disconnect
};
}
else
{
await CrossInAppBilling.Current.DisconnectAsync();
}
If you do connect the IsConnected
propety will be true
and when you make purchases or check purchases again you should check ahead of time and not re-connect or disconnect if there are pending purchases
I highly recommend reading the entire Google Play Billing System docs.
Consumable vs Non-consumables on Android
On Android if you purchase anything you must first Acknowledge a purchase else it will be refunded. See the android documentation.
https://developer.android.com/google/play/billing/integrate#process https://developer.android.com/google/play/billing/integrate#pending
For consumables, the consumeAsync() method fulfills the acknowledgement requirement and indicates that your app has granted entitlement to the user. This method also enables your app to make the one-time product available for purchase again.
So, if you have a consumable... ConsumePurchaseAsync
will also acknowledge it, if you have a non-consumable you will need to call AcknowledgePurchaseAsync
.
Version 4+ Linker Settings
For linking if you are setting Link All you may need to add:
Android:
Plugin.InAppBilling;Xamarin.Android.Google.BillingClient
Android Progaurd Rules
-keep class com.android.billingclient.api.** { *; }
-keep class com.android.vending.billing.** { *; }
iOS:
--linkskip=Plugin.InAppBilling
License
The MIT License (MIT), see LICENSE file.
Want To Support This Project?
All I have ever asked is to be active by submitting bugs, features, and sending those pull requests down! Want to go further? Make sure to subscribe to my weekly development podcast Merge Conflict, where I talk all about awesome Xamarin goodies and you can optionally support the show by becoming a supporter on Patreon.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-android34.0 is compatible. net8.0-browser was computed. net8.0-ios was computed. net8.0-ios18.0 is compatible. net8.0-maccatalyst was computed. net8.0-maccatalyst18.0 is compatible. net8.0-macos was computed. net8.0-macos15.0 is compatible. net8.0-tvos was computed. net8.0-windows was computed. net8.0-windows10.0.19041 is compatible. |
-
net8.0
- No dependencies.
-
net8.0-android34.0
- Microsoft.Maui.Essentials (>= 8.0.82)
- Xamarin.Android.Google.BillingClient (>= 6.2.1)
- Xamarin.AndroidX.Activity (>= 1.9.0.4)
- Xamarin.AndroidX.Activity.Ktx (>= 1.9.0.4)
- Xamarin.AndroidX.Collection (>= 1.4.0.6)
- Xamarin.AndroidX.Collection.Ktx (>= 1.4.0.5)
- Xamarin.AndroidX.Lifecycle.LiveData (>= 2.8.3.1)
- Xamarin.AndroidX.Lifecycle.LiveData.Core (>= 2.8.3.1)
- Xamarin.AndroidX.Lifecycle.LiveData.Core.Ktx (>= 2.8.3.1)
- Xamarin.AndroidX.Lifecycle.LiveData.Ktx (>= 2.8.3.1)
- Xamarin.AndroidX.Lifecycle.Runtime (>= 2.8.3.1)
- Xamarin.AndroidX.Lifecycle.Runtime.Ktx (>= 2.8.3.1)
- Xamarin.AndroidX.Lifecycle.ViewModel (>= 2.8.3.1)
- Xamarin.AndroidX.Lifecycle.ViewModel.Ktx (>= 2.8.3.1)
- Xamarin.AndroidX.Lifecycle.ViewModelSavedState (>= 2.8.3.1)
-
net8.0-ios18.0
- No dependencies.
-
net8.0-maccatalyst18.0
- No dependencies.
-
net8.0-macos15.0
- No dependencies.
-
net8.0-windows10.0.19041
- No dependencies.
NuGet packages (6)
Showing the top 5 NuGet packages that depend on Plugin.InAppBilling:
Package | Downloads |
---|---|
Zebble.Billing
Zebble IAP plugin for Xamarin. |
|
VerticesEngine.Android
The Android port of the Cross Platform Vertices Engine. |
|
VerticesEngine.iOS
The iOS port of the cross platform engine Vertices Engine |
|
ContactManager.Core
Package Description |
|
RedCorners.IAP
In App Purchase Plugins |
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on Plugin.InAppBilling:
Repository | Stars |
---|---|
jamesmontemagno/app-ac-islandtracker
Animal Crossing Island Tracking Mobile App
|
|
jamesmontemagno/MyStreamTimer
A cool app to count up or down that writes text to file for streamers
|
Version | Downloads | Last updated | |
---|---|---|---|
9.0.2-beta | 187 | 10/18/2024 | |
9.0.1-beta | 110 | 10/8/2024 | |
9.0.0-beta | 67 | 10/3/2024 | |
8.0.5 | 854 | 10/18/2024 | |
8.0.5-beta | 87 | 10/18/2024 | |
8.0.4 | 505 | 10/3/2024 | |
8.0.3-beta | 355 | 8/9/2024 | |
8.0.2-beta | 152 | 7/23/2024 | |
8.0.1-beta | 90 | 7/23/2024 | |
8.0.0-beta | 137 | 7/16/2024 | |
7.1.3 | 11,163 | 7/15/2024 | |
7.1.2 | 594 | 7/12/2024 | |
7.1.2-beta | 211 | 5/11/2024 | |
7.1.1-beta | 3,109 | 12/13/2023 | |
7.1.0 | 54,029 | 10/30/2023 | |
7.1.0-beta | 803 | 10/4/2023 | |
7.0.5 | 25,168 | 8/4/2023 | |
7.0.5-beta | 2,972 | 6/4/2023 | |
7.0.4-beta | 613 | 6/3/2023 | |
7.0.3-beta | 621 | 6/3/2023 | |
7.0.2-beta | 627 | 6/1/2023 | |
7.0.1-beta | 643 | 6/1/2023 | |
7.0.0-beta | 646 | 5/31/2023 | |
6.7.1-beta | 663 | 5/12/2023 | |
6.7.0 | 51,692 | 10/20/2022 | |
6.6.2-beta | 827 | 9/25/2022 | |
6.6.1 | 4,061 | 9/22/2022 | |
6.6.1-beta | 680 | 9/22/2022 | |
6.6.0-beta | 657 | 9/22/2022 | |
6.5.0-beta | 726 | 9/20/2022 | |
6.4.0-beta | 671 | 9/1/2022 | |
6.3.3-beta | 2,626 | 5/11/2022 | |
6.3.2-beta | 713 | 3/7/2022 | |
6.3.1-beta | 642 | 2/15/2022 | |
6.3.0-beta | 163 | 2/13/2022 | |
6.0.0-beta | 1,401 | 1/14/2022 | |
5.7.1-beta | 681 | 5/12/2023 | |
5.6.2-beta | 783 | 9/25/2022 | |
5.6.1 | 12,468 | 9/22/2022 | |
5.6.1-beta | 672 | 9/22/2022 | |
5.6.0-beta | 681 | 9/22/2022 | |
5.5.0-beta | 644 | 9/20/2022 | |
5.4.0-beta | 636 | 9/1/2022 | |
5.3.3-beta | 7,155 | 5/11/2022 | |
5.3.2-beta | 2,576 | 3/7/2022 | |
5.3.1-beta | 1,827 | 2/15/2022 | |
5.3.0-beta | 928 | 2/13/2022 | |
5.2.0-beta | 1,546 | 1/14/2022 | |
5.1.1-beta | 982 | 12/26/2021 | |
5.1.0-beta | 14,094 | 11/21/2021 | |
5.0.1-beta | 7,598 | 7/18/2021 | |
5.0.0-beta | 866 | 7/13/2021 | |
4.4.0-beta | 1,124 | 7/13/2021 | |
4.2.0-beta | 2,407 | 5/6/2021 | |
4.1.2-beta | 13,673 | 2/8/2021 | |
4.1.1-beta | 835 | 2/8/2021 | |
4.1.0-beta | 778 | 2/7/2021 | |
4.0.2 | 93,001 | 1/2/2021 | |
4.0.2-beta | 835 | 1/2/2021 | |
4.0.1-beta | 5,139 | 11/4/2020 | |
4.0.0-beta | 6,935 | 8/20/2020 | |
2.1.0.187-beta | 20,562 | 2/4/2019 | |
2.0.0.173-beta | 3,262 | 9/29/2018 | |
2.0.0 | 183,002 | 5/23/2018 | |
1.4.1.157-beta | 1,400 | 5/9/2018 | |
1.2.5.145-beta | 1,409 | 5/2/2018 | |
1.2.5.144-beta | 1,334 | 5/2/2018 | |
1.2.5 | 3,863 | 5/1/2018 | |
1.2.4.140-beta | 1,358 | 4/24/2018 | |
1.2.4.138-beta | 1,508 | 4/2/2018 | |
1.2.4.137-beta | 1,322 | 3/29/2018 | |
1.2.4.136-beta | 1,447 | 3/27/2018 | |
1.2.4.133-beta | 1,855 | 3/17/2018 | |
1.2.4.130-beta | 1,501 | 2/26/2018 | |
1.2.4.123-beta | 1,542 | 1/26/2018 | |
1.2.4.122-beta | 1,371 | 1/25/2018 | |
1.2.4.116-beta | 1,647 | 1/10/2018 | |
1.2.4.113-beta | 1,454 | 1/6/2018 | |
1.2.4.112-beta | 1,615 | 12/20/2017 | |
1.2.4.111-beta | 1,412 | 12/20/2017 | |
1.2.4 | 28,181 | 1/18/2018 | |
1.2.3.107 | 24,778 | 10/11/2017 | |
1.2.3.98-beta | 1,520 | 10/9/2017 | |
1.2.2 | 5,266 | 7/13/2017 | |
1.2.2-beta72 | 1,405 | 7/9/2017 | |
1.2.1 | 10,302 | 7/3/2017 | |
1.2.0.54-alpha | 1,437 | 7/1/2017 | |
1.2.0.51-alpha | 1,441 | 6/28/2017 | |
1.2.0.50-alpha | 3,584 | 6/21/2017 | |
1.2.0.49-alpha | 1,387 | 6/20/2017 | |
1.1.0.46-beta | 2,750 | 6/15/2017 | |
1.1.0.35-beta | 3,518 | 4/18/2017 | |
1.1.0.34-beta | 2,833 | 3/23/2017 | |
1.1.0.33-beta | 1,322 | 3/23/2017 | |
1.1.0.32-beta | 1,379 | 3/22/2017 | |
1.1.0.23-beta | 1,931 | 2/10/2017 | |
1.1.0.15-beta | 1,433 | 2/6/2017 | |
1.1.0.9-beta | 1,466 | 1/23/2017 | |
1.1.0.3-beta | 1,317 | 1/21/2017 | |
1.1.0.2-beta | 1,341 | 1/21/2017 | |
1.0.0.31-beta | 1,339 | 1/16/2017 | |
1.0.0.30-beta | 1,408 | 1/15/2017 | |
1.0.0.27-beta | 1,323 | 1/14/2017 |