In-app purchase plugin for NativeScript

Installation

Run the following command from the root of your project:

ns plugin add nativescript-iap

Configuration

In order for your in-app purchases to be recognized by the plugin, you must configure those on the Google/AppStore side.

Usage

Setup hook

Before starting purchase you need hook up to the purchaseUpdated event. This way you will receive information about the transaction state while it is executing and take necessary action when the transaction completes. You can set the hook once as global handler to process the all incoming purchases.

import inAppPurchase, { PurchaseEventData } from "nativescript-iap";

inAppPurchase.on("purchaseUpdated", async (data: PurchaseEventData) => {
    for (const transaction of data.transactions) {
        switch (transaction.state) {
            case TransactionState.purchasing:
                // ...
                break;
            case TransactionState.purchased:
            case TransactionState.restored:
                // Delivering the content
                break;
            case TransactionState.deferred:
                // ...
                break;
            case TransactionState.refunded:
                // ...
                break;
        }

        // You must finish transaction otherwise the purchase being refunded
        await inAppPurchase.finishTransaction(transaction);
    }
});

Getting the products

To get the actual products call getProducts with array of the products identifiers (in Google Play products ID calls SKU):

import inAppPurchase from "nativescript-iap";

const products = await inAppPurchase.getProducts(["your.product.id.1", "your.product.id.2"]);

Purchasing the product

import inAppPurchase, { PurchaseError } from "nativescript-iap";

try {
    await inAppPurchase.purchase(product);
} catch (error) {
    if (error instanceof PurchaseError) {
        switch (error.code) {
            switch (error.code) {
                case PurchaseErrorCode.canceled:
                    // ...
                    break;
                case PurchaseErrorCode.productAlreadyOwned:
                    // ...
                    break;
                case PurchaseErrorCode.productNotAvailable:
                    // ...
                    break;
                case PurchaseErrorCode.userNotAuthorized: // On iOS only
                    // ...
                    break;
                default: //Unknow error
                    // ...
                    break;
            }
        }
    }

    // Handle the error
}

Restoring the purchased products

import inAppPurchase from "nativescript-iap";
// All restored purchases will be handled by the "purchaseUpdated" hook.
await inAppPurchase.restorePurchases();

(ANDROID ONLY) Consuming the purchased product

import inAppPurchase from "nativescript-iap";

await inAppPurchase.consumePurchase(transaction);

Showing the price consent dialog

import inAppPurchase from "nativescript-iap";

const products = await inAppPurchase.getProducts(["product_id_with_updated_price"]);

await inAppPurchase.showPriceConsent(product[0]);

(iOS only) Listen for revoked family-shared purchases.

import inAppPurchase from "nativescript-iap";

inAppPurchase.on("productsRevoked", async (data: ProductsRevokedEventData) => {
    data.productIds.foreach((productId) => {
        // Notify user
    });
});

API

InAppPurchase - class Represents the class for making in-app purchase.

Product - class Represents information about a product.

ProductType - enum Represents the product type.

PurchaseError - class Represents the error class wich can throws in purchase method.

PurchaseErrorCode - enum Represents the error codes for PurchaseError.

PurchaseEventData - interface Represents the data of the purchaseUpdated event.

SubscriptionPeriod - enum Represents the subscription period duration.

Transaction - class Represents an in-app purchase transaction.

TransactionState - enum Represents the states of the transaction.