cordova-plugin-inapppurchase-2
Advanced tools
A lightweight cordova plugin for in app purchases on iOS and Android with a simple promise based API.
A lightweight Cordova plugin for in app purchases on iOS/Android. See demo app and blog post.
The Android portion of this library was rewritten to work with Google Play Billing Library Version 4. This is because of the recent Google Store requirement that version 3 or above is implemented for IAP. The goal was to make minimal changes to the existing code, and to match the new code to the same coding conventions.
Old IAP code should work as-is with 1 caveat: Google now requires that all purchases either be consumed or acknowledge, or they will be automatically refunded. The existing consume functionality has been rewritten (but not tested yet!) and the acknowledge function has been added.
The repository was cherry-picked collection of all publicly available forks. Below is a list of forks on which this repo is directly or indirectly based:
$ cordova plugin add cordova-plugin-inapppurchase-2
No configuration is necessary.
You must create a manifest.json in your project's www folder with your Android Billing Key:
{ "play_store_key": "<Base64-encoded public key from the Google Play Store>" }
You can get this key from the Google Play Store (under "Services & APIs") after uploading your app.
All functions return a Promise.
Retrieves a list of full product data from Apple/Google. This function must be called before making purchases.
If successful, the promise resolves to an array of objects. Each object has the following attributes:
productId - SKU / product bundle id (such as 'com.yourapp.prod1')title - short localized titledescription - long localized descriptioncurrency - currency of the price (such as 'EUR', 'USD')price - localized pricepriceAsDecimal - price as a decimalExample:
inAppPurchase
.getProducts(['com.yourapp.prod1', 'com.yourapp.prod2', ...])
.then(function (products) {
console.log(products);
/*
[{ productId: 'com.yourapp.prod1', 'title': '...', description: '...', currency: '...', price: '...', priceAsDecimal: '...' }, ...]
*/
})
.catch(function (err) {
console.log(err);
});
If successful, the promise resolves to an object with the following attributes that you will need for the receipt validation:
transactionId - The transaction/order idreceipt - On iOS it will be the base64 string of the receipt, on Android it will be a string of a json with all the transaction details required for validation such as {"orderId":"...","packageName:"...","productId":"...","purchaseTime":"...", "purchaseState":"...","purchaseToken":"..."}signature - On Android it can be used to consume a purchase. On iOS it will be an empty string.productType - On Android it can be used to consume a purchase. On iOS it will be an empty string.Receipt validation: - To validate your receipt, you will need the receipt and signature on Android and the receipt and transactionId on iOS.
Example:
inAppPurchase
.buy('com.yourapp.prod1')
.then(function (data) {
console.log(data);
/*
{
transactionId: ...
receipt: ...
signature: ...
}
*/
})
.catch(function (err) {
console.log(err);
});
This function behaves the same as buy() but with subscriptions.
All 3 parameters are returned by the buy() or restorePurchases() functions.
Call this function after purchasing a "consumable" product to mark it as consumed.
NOTE: This function is only relevant to Android purchases.
On Android, you must consume products that you want to let the user purchase multiple times. If you will not consume the product after a purchase, the next time you will attempt to purchase it you will get the error message:
Unable to buy item / Item already owned.
On iOS there is no need to "consume" a product. However, in order to make your code cross platform, it is recommended to call it for iOS consumable purchases as well.
Example:
// first buy the product...
inAppPurchase
.buy('com.yourapp.consumable_prod1')
.then(function (data) {
// ...then mark it as consumed:
return inAppPurchase.consume(data.productType, data.receipt, data.signature);
})
.then(function () {
console.log('product was successfully consumed!');
})
.catch(function (err) {
console.log(err);
});
All 3 parameters are returned by the buy() or restorePurchases() functions.
Similar to consume, call this function after purchasing a product or subscription to mark it as acknowledged.
NOTE: This function is only relevant to Android purchases and subscriptions.
On Android, you must acknowledge products and subscriptions. You must acknowledge or consume each purchase or Google will refund after 3 days, currently.
On iOS there is no need to "acknowledge" a product. However, in order to make your code cross platform, it is recommended to call it for iOS purchases and subscriptions as well.
Example:
// first buy the product...
inAppPurchase
.buy('com.yourapp.prod1')
.then(function (data) {
// ...then mark it as consumed:
return inAppPurchase.acknowledge(data.productType, data.receipt, data.signature);
})
.then(function () {
console.log('product was successfully acknowledged!');
})
.catch(function (err) {
console.log(err);
});
If successful, the promise resolves to an array of objects with the following attributes:
productIdstate - the state of the product. On Android the statuses are: 0 - ACTIVE, 1 - CANCELLED, 2 - REFUNDEDtransactionIddate - timestamp of the purchaseproductType - On Android it can be used to consume a purchase. On iOS it will be an empty string.receipt - On Android it can be used to consume a purchase. On iOS it will be an empty string.signature - On Android it can be used to consume a purchase. On iOS it will be an empty string.Example:
inAppPurchase
.restorePurchases()
.then(function (data) {
console.log(data);
/*
[{
transactionId: ...
productId: ...
state: ...
date: ...
}]
*/
})
.catch(function (err) {
console.log(err);
});
See Differences Between Product Types
On iOS, you can get the receipt at any moment by calling the getReceipt() function. Note that on iOS the receipt can contain multiple transactions. If successful, the promise returned by this function will resolve to a string with the receipt.
On Android this function will always return an empty string since it's not needed for Android purchases.
Example:
inAppPurchase
.getReceipt()
.then(function (receipt) {
console.log(receipt);
})
.catch(function (err) {
console.log(err);
});
$ npm install
$ gulp watch
$ npm test
Or, if you would like to watch and re-run tests:
$ npm run watch
Coverage report:
$ nyc npm test
The MIT License
Copyright (c) 2016, Alex Disler
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
A lightweight cordova plugin for in app purchases on iOS and Android with a simple promise based API.
The npm package cordova-plugin-inapppurchase-2 receives a total of 5 weekly downloads. As such, cordova-plugin-inapppurchase-2 popularity was classified as not popular.
We found that cordova-plugin-inapppurchase-2 demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.