capacitor-purchases

In-app Subscriptions Made Easy with RevenueCat SDK

RevenueCat is a third-party tool, who handle all difficulty for us is Free until $10,000 Revenue by month

Capacitor implementation with lastes RevenueCat SDK v4

RevenueCat:

Tutorial step by step

https://capgo.app/blog/in-app-purchases-capacitor/

Install

npm install @capgo/capacitor-purchases
pnpm dlx cap sync

Android

Add this to your android manifest android/app/src/main/AndroidManifest.xml

<uses-permission android:name="com.android.vending.BILLING"/>

Variables

This plugin will use the following project variables (defined in your app's variables.gradle file):

• $kotlinVersion version of org.jetbrains.kotlin:kotlin-stdlib-jdk7 (default: 1.7.21)

If you have compilation issue Duplicate class androidx.lifecycle.ViewModelLazy i found in this the solution who worked for me: https://stackoverflow.com/questions/73406969/duplicate-class-androidx-lifecycle-viewmodellazy-found-in-modules-lifecycle-view

Add this

configurations {
    all {
        exclude group: 'androidx.lifecycle', module: 'lifecycle-runtime-ktx'
        exclude group: 'androidx.lifecycle', module: 'lifecycle-viewmodel-ktx'
    }
}
an

line 2 in file android/app/build.gradle

Configuration

No configuration required for this plugin.

Migration v2

getPurchaserInfo become getCustomerInfo PurchaserInfo become CustomerInfo restoreTransactions become restorePurchases

Read more about it here: https://github.com/RevenueCat/purchases-android/blob/main/migrations/v5-MIGRATION.md

API

• setup(...)
• addListener('purchasesUpdate', ...)
• getOfferings()
• purchasePackage(...)
• restorePurchases()
• setAttributes(...)
• logIn(...)
• logOut()
• getCustomerInfo()
• setDebugLogsEnabled(...)
• Interfaces
• Enums

setup(...)

setup(data: { apiKey: string; appUserID?: string; observerMode?: boolean; enableAdServicesAttribution?: boolean; collectDeviceIdentifiers?: boolean; }) => any

Sets up with your API key and an app user id.

Returns: any

addListener('purchasesUpdate', ...)

addListener(eventName: "purchasesUpdate", listenerFunc: (data: { purchases: Package; customerInfo: CustomerInfo; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Called when partialResults set to true and result received

Provides partial result.

Returns: any

Since: 2.0.2

getOfferings()

getOfferings() => any

Gets the Offerings configured in the RevenueCat dashboard

Returns: any

purchasePackage(...)

purchasePackage(data: { identifier: string; offeringIdentifier: string; oldSKU?: string | null; }) => any

Make a purchase

Returns: any

restorePurchases()

restorePurchases() => any

Restores a user's previous and links their appUserIDs to any user's also using those .

Returns: any

setAttributes(...)

setAttributes(data: { attributes: { [key: string]: string | null; }; }) => any

Subscriber attributes are useful for storing additional, structured information on a user. Since attributes are writable using a public key they should not be used for managing secure or sensitive information such as subscription status, coins, etc.

Key names starting with "$" are reserved names used by RevenueCat. For a full list of key restrictions refer to our guide: https://docs.revenuecat.com/docs/subscriber-attributes

Returns: any

logIn(...)

logIn(data: { appUserID: string; }) => any

This function will logIn the current user with an appUserID. Typically this would be used after a log in to identify a user without calling configure.

Returns: any

logOut()

logOut() => any

Logs out the client clearing the saved appUserID. This will generate a random user id and save it in the cache. If the current user is already anonymous, this will produce a Error.

Returns: any

getCustomerInfo()

getCustomerInfo() => any

Gets the current purchaser info. This call will return the cached purchaser info unless the cache is stale, in which case, it will make a network call to retrieve it from the servers.

Returns: any

setDebugLogsEnabled(...)

setDebugLogsEnabled(data: { enabled: boolean; }) => any

Enables/Disables debugs logs

Returns: any

Interfaces

Package

Contains information about the product available for the user to purchase. For more info see https://docs.revenuecat.com/docs/entitlements

Product

SubscriptionPeriod

SKProductDiscount

CustomerInfo

EntitlementInfos

Contains all the entitlements associated to the user.

EntitlementInfo

The EntitlementInfo object gives you access to all of the information about the status of a user entitlement.

Transaction

PluginListenerHandle

Offerings

Contains all the offerings configured in RevenueCat dashboard. For more info see https://docs.revenuecat.com/docs/entitlements

Offering

An offering is a collection of Packages (PurchasesPackage) available for the user to purchase. For more info see https://docs.revenuecat.com/docs/entitlements

LogInResult

Holds the logIn result

Enums

PACKAGE_TYPE