Skip to content
In-App Purchase for Cordova on iOS, Android and Windows
JavaScript Objective-C Java Shell Makefile CSS HTML
Branch: master
Clone or download

Latest commit

Latest commit 8861bd2 May 25, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create FUNDING.yml May 28, 2019
doc Update ios.md May 25, 2020
src 10.2.0 May 16, 2020
test Update "make test-js" Sep 23, 2019
tools Add maintainer scripts May 27, 2019
www Make all May 16, 2020
.editorconfig (android) Add support for developerPayload (and friends) Aug 16, 2019
.eslintrc (android) Reimplement using the Billing Library v2 Aug 15, 2019
.gitignore (android) Reimplement using the Billing Library v2 Aug 15, 2019
.gitmodules Remove android_iap submodule Feb 7, 2015
.jshintrc Add ESLint + Fix raised issues Oct 30, 2014
.travis.yml Update .travis.yml Mar 30, 2020
Makefile Update "make test-js" Sep 23, 2019
README.md Make all Oct 4, 2019
package-lock.json 10.2.0 May 16, 2020
package.json 10.2.0 May 16, 2020
plugin.xml 10.2.0 May 16, 2020
versions v10.0.1 Dec 12, 2019

README.md

Cordova Purchase Plugin

In-App Purchases for Cordova

Build Status


Need professional help and support? Contact Me.

I dedicate a considerable amount of my free time to developing and maintaining this Cordova plugin, along with my other Open Source software. To help ensure this plugin is kept updated, new features are added and bugfixes are implemented quickly, please donate a couple of dollars (or a little more if you can stretch) as this will help me to afford to dedicate time to its maintenance. Please consider donating if you're using this plugin in an app that makes you money, if you're being paid to make the app, if you're asking for new features or priority bug fixes. Thank you!

Summary

This plugin allows In-App Purchases to be made from Cordova, PhoneGap and Ionic applications.

It lets you handle in-app purchases on many platforms with a single codebase.

Features

ios android win-8 win-10/uwp mac
consumables
non consumables
subscriptions
restore purchases
receipt validations
downloadable content
introductory prices

Supported platforms

  • iOS version 6.0 or higher.
  • Android version 2.2 (API level 8) or higher
    • with Google Play client version 3.9.16 or higher
  • Windows Store/Phone 8.1 or higher
  • Windows 10 Mobile
  • macOS version 10
  • Xbox One
    • (and any platform supporting Microsoft's UWP)

Installation

Install the plugin (Cordova)

cordova plugin add cordova-plugin-purchase

Install the plugin (PhoneGap)

Add the following to your config.xml file:

<gap:plugin name="cordova-plugin-purchase" source="npm" version="9.0.0"></gap:plugin>

Install recommended plugins

Install cordova-plugin-network-information (click for details).

Sometimes, the plugin cannot connect to the app store because it has no network connection. It will then retry either:

  • periodically after a certain amount of time;
  • when the device fires an 'online' event.

The cordova-plugin-network-information plugin is required in order for the 'online' event to be properly received in the Cordova application. Without it, this plugin will only be able to use the periodic check to determine if the device is back online.

Setup your Application

See Setup iOS Applications and Setup Android Applications.

Getting Started

If you don't know much about In-App Purchases, you'll find a good overview on the subject from those guys:

They all share the same concepts, so they are a good reads in all cases, with some advice that apply to all platforms.

To ease the beggining of your journey into the intimidating world of In-App Purchase with Cordova, we wrote a guide which hopefully will help you get things done: https://purchase.cordova.fovea.cc/

In short, you'll have two main tasks to accomplish:

  1. Setup your application and In-App Products on AppStore, Play or Azure platforms using their respective web interfaces.
  2. Add In-App Purchase code to your application.

For platform setup, the wiki contains good information.

For the code itself, the API Documentation is a definitely a recommended read.

Documentation

Extra Resources

For iOS

Extensions

Have a very simple need? Maybe this will help.

Subscriptions

For proper subscription support, you need a receipt validation server. You can implement your own or use Fovea's receipt validation service.

Contribute

Contributors:

  • Jean-Christophe Hoelt, Author
  • Josef Fröhle, Support
  • Guillaume Charhon, (now defunct) v1 for android
  • Matt Kane, initial iOS code
  • Mohammad Naghavi, original unification attempt
  • Dave Alden @dpa99c (Apple-hosted IAPs for iOS)

Sponsors

Licence

The MIT License

Copyright (c) 2014-2019, Jean-Christophe Hoelt and contributors

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.
You can’t perform that action at this time.