Awesome

RevenueCat is a powerful, reliable, and free to use in-app purchase server with cross-platform support. Our open-source framework provides a backend and a wrapper around StoreKit and Google Play Billing to make implementing in-app purchases and subscriptions easy.

Whether you are building a new app or already have millions of customers, you can use RevenueCat to:

• Fetch products, make purchases, and check subscription status with our native SDKs.
• Host and configure products remotely from our dashboard.
• Analyze the most important metrics for your app business in one place.
• See customer transaction histories, chart lifetime value, and grant promotional subscriptions.
• Get notified of real-time events through webhooks.
• Send enriched purchase events to analytics and attribution tools with our easy integrations.

Sign up to get started for free.

@revenuecat/purchases-capacitor

@revenuecat/purchases-capacitor is the client for the RevenueCat subscription and purchase tracking system. It is an open source framework that provides a wrapper around StoreKit, Google Play Billing and the RevenueCat backend to make implementing in-app purchases in Capacitor easy.

RevenueCat SDK Features

Getting Started

For more detailed information, you can view our complete documentation at docs.revenuecat.com.

Please follow the Quickstart Guide for more information on how to install the SDK.

npm install @revenuecat/purchases-capacitor
npx cap sync

Contributing

Contributions are always welcome! To learn how you can contribute, please see the Contributing Guide.

Acknowledgment

This plugin is based on CapGo's Capacitor plugin. The plugin was transferred to RevenueCat to become an officially supported plugin.

API

• configure(...)
• setMockWebResults(...)
• setSimulatesAskToBuyInSandbox(...)
• addCustomerInfoUpdateListener(...)
• removeCustomerInfoUpdateListener(...)
• getOfferings()
• getCurrentOfferingForPlacement(...)
• syncAttributesAndOfferingsIfNeeded()
• getProducts(...)
• purchaseStoreProduct(...)
• purchaseDiscountedProduct(...)
• purchasePackage(...)
• purchaseSubscriptionOption(...)
• purchaseDiscountedPackage(...)
• restorePurchases()
• recordPurchase(...)
• getAppUserID()
• logIn(...)
• logOut()
• setLogLevel(...)
• setLogHandler(...)
• getCustomerInfo()
• syncPurchases()
• syncObserverModeAmazonPurchase(...)
• syncAmazonPurchase(...)
• enableAdServicesAttributionTokenCollection()
• isAnonymous()
• checkTrialOrIntroductoryPriceEligibility(...)
• getPromotionalOffer(...)
• invalidateCustomerInfoCache()
• presentCodeRedemptionSheet()
• setAttributes(...)
• setEmail(...)
• setPhoneNumber(...)
• setDisplayName(...)
• setPushToken(...)
• setProxyURL(...)
• collectDeviceIdentifiers()
• setAdjustID(...)
• setAppsflyerID(...)
• setFBAnonymousID(...)
• setMparticleID(...)
• setCleverTapID(...)
• setMixpanelDistinctID(...)
• setFirebaseAppInstanceID(...)
• setOnesignalID(...)
• setOnesignalUserID(...)
• setAirshipChannelID(...)
• setMediaSource(...)
• setCampaign(...)
• setAdGroup(...)
• setAd(...)
• setKeyword(...)
• setCreative(...)
• canMakePayments(...)
• beginRefundRequestForActiveEntitlement()
• beginRefundRequestForEntitlement(...)
• beginRefundRequestForProduct(...)
• showInAppMessages(...)
• isConfigured()
• Interfaces
• Type Aliases
• Enums

configure(...)

configure(configuration: PurchasesConfiguration) => Promise<void>

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

setMockWebResults(...)

setMockWebResults(options: { shouldMockWebResults: boolean; }) => Promise<void>

Sets whether the SDK should return mocked results in the web version. This won't affect the iOS and Android versions of the implementation. Default is false

setSimulatesAskToBuyInSandbox(...)

setSimulatesAskToBuyInSandbox(options: { simulatesAskToBuyInSandbox: boolean; }) => Promise<void>

iOS only.

addCustomerInfoUpdateListener(...)

addCustomerInfoUpdateListener(customerInfoUpdateListener: CustomerInfoUpdateListener) => Promise<PurchasesCallbackId>

Sets a function to be called on updated customer info

Returns: <code>Promise<string></code>

removeCustomerInfoUpdateListener(...)

removeCustomerInfoUpdateListener(options: { listenerToRemove: PurchasesCallbackId; }) => Promise<{ wasRemoved: boolean; }>

Removes a given <a href="#customerinfoupdatelistener">CustomerInfoUpdateListener</a>

Returns: <code>Promise<{ wasRemoved: boolean; }></code>

getOfferings()

getOfferings() => Promise<PurchasesOfferings>

Gets the map of entitlements -> offerings -> products

Returns: <code>Promise<<a href="#purchasesofferings">PurchasesOfferings</a>></code>

getCurrentOfferingForPlacement(...)

getCurrentOfferingForPlacement(options: { placementIdentifier: string; }) => Promise<PurchasesOffering | null>

Retrieves a current offering for a placement identifier, use this to access offerings defined by targeting placements configured in the RevenueCat dashboard.

Returns: <code>Promise<<a href="#purchasesoffering">PurchasesOffering</a> | null></code>

syncAttributesAndOfferingsIfNeeded()

syncAttributesAndOfferingsIfNeeded() => Promise<PurchasesOfferings>

Syncs subscriber attributes and then fetches the configured offerings for this user. This method is intended to be called when using Targeting Rules with Custom Attributes. Any subscriber attributes should be set before calling this method to ensure the returned offerings are applied with the latest subscriber attributes.

Returns: <code>Promise<<a href="#purchasesofferings">PurchasesOfferings</a>></code>

getProducts(...)

getProducts(options: GetProductOptions) => Promise<{ products: PurchasesStoreProduct[]; }>

Fetch the product info

Returns: <code>Promise<{ products: PurchasesStoreProduct[]; }></code>

purchaseStoreProduct(...)

purchaseStoreProduct(options: PurchaseStoreProductOptions) => Promise<MakePurchaseResult>

Make a purchase

Returns: <code>Promise<<a href="#makepurchaseresult">MakePurchaseResult</a>></code>

purchaseDiscountedProduct(...)

purchaseDiscountedProduct(options: PurchaseDiscountedProductOptions) => Promise<MakePurchaseResult>

iOS only. Purchase a product applying a given discount.

Returns: <code>Promise<<a href="#makepurchaseresult">MakePurchaseResult</a>></code>

purchasePackage(...)

purchasePackage(options: PurchasePackageOptions) => Promise<MakePurchaseResult>

Make a purchase

Returns: <code>Promise<<a href="#makepurchaseresult">MakePurchaseResult</a>></code>

purchaseSubscriptionOption(...)

purchaseSubscriptionOption(options: PurchaseSubscriptionOptionOptions) => Promise<MakePurchaseResult>

Google only. Make a purchase of a subscriptionOption

Returns: <code>Promise<<a href="#makepurchaseresult">MakePurchaseResult</a>></code>

purchaseDiscountedPackage(...)

purchaseDiscountedPackage(options: PurchaseDiscountedPackageOptions) => Promise<MakePurchaseResult>

iOS only. Purchase a package applying a given discount.

Returns: <code>Promise<<a href="#makepurchaseresult">MakePurchaseResult</a>></code>

restorePurchases()

restorePurchases() => Promise<{ customerInfo: CustomerInfo; }>

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

Returns: <code>Promise<{ customerInfo: <a href="#customerinfo">CustomerInfo</a>; }></code>

recordPurchase(...)

recordPurchase(options: { productID: string; }) => Promise<{ transaction: PurchasesStoreTransaction; }>

Use this method only if you already have your own IAP implementation using StoreKit 2 and want to use RevenueCat's backend. If you are using StoreKit 1 for your implementation, you do not need this method.

You only need to use this method with new purchases. Subscription updates are observed automatically.

Returns: <code>Promise<{ transaction: <a href="#purchasesstoretransaction">PurchasesStoreTransaction</a>; }></code>

getAppUserID()

getAppUserID() => Promise<{ appUserID: string; }>

Get the appUserID

Returns: <code>Promise<{ appUserID: string; }></code>

logIn(...)

logIn(options: { appUserID: string; }) => Promise<LogInResult>

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

Returns: <code>Promise<<a href="#loginresult">LogInResult</a>></code>

logOut()

logOut() => Promise<{ customerInfo: CustomerInfo; }>

Logs out the Purchases client clearing the saved appUserID. This will generate a random user id and save it in the cache.

Returns: <code>Promise<{ customerInfo: <a href="#customerinfo">CustomerInfo</a>; }></code>

setLogLevel(...)

setLogLevel(options: { level: LOG_LEVEL; }) => Promise<void>

Used to set the log level. Useful for debugging issues with the lovely team @RevenueCat. The default is {<a href="#log_level">LOG_LEVEL.INFO</a>} in release builds and {<a href="#log_level">LOG_LEVEL.DEBUG</a>} in debug builds.

setLogHandler(...)

setLogHandler(logHandler: LogHandler) => Promise<void>

Set a custom log handler for redirecting logs to your own logging system. By default, this sends info, warning, and error messages. If you wish to receive Debug level messages, see [setLogLevel].

getCustomerInfo()

getCustomerInfo() => Promise<{ customerInfo: CustomerInfo; }>

Gets current customer info

Returns: <code>Promise<{ customerInfo: <a href="#customerinfo">CustomerInfo</a>; }></code>

syncPurchases()

syncPurchases() => Promise<void>

This method will send all the purchases to the RevenueCat backend. Call this when using your own implementation for subscriptions anytime a sync is needed, like after a successful purchase.

syncObserverModeAmazonPurchase(...)

syncObserverModeAmazonPurchase(options: SyncObserverModeAmazonPurchaseOptions) => Promise<void>

syncAmazonPurchase(...)

syncAmazonPurchase(options: SyncAmazonPurchaseOptions) => Promise<void>

This method will send a purchase to the RevenueCat backend. This function should only be called if you are in Amazon observer mode or performing a client side migration of your current users to RevenueCat.

The receipt IDs are cached if successfully posted, so they are not posted more than once.

enableAdServicesAttributionTokenCollection()

enableAdServicesAttributionTokenCollection() => Promise<void>

Enable automatic collection of Apple Search Ad attribution on iOS. Disabled by default. Supported in iOS 14.3+ only

isAnonymous()

isAnonymous() => Promise<{ isAnonymous: boolean; }>

Returns: <code>Promise<{ isAnonymous: boolean; }></code>

checkTrialOrIntroductoryPriceEligibility(...)

checkTrialOrIntroductoryPriceEligibility(options: { productIdentifiers: string[]; }) => Promise<{ [productId: string]: IntroEligibility; }>

iOS only. Computes whether a user is eligible for the introductory pricing period of a given product. You should use this method to determine whether you show the user the normal product price or the introductory price. This also applies to trials (trials are considered a type of introductory pricing).

Returns: <code>Promise<{ [productId: string]: <a href="#introeligibility">IntroEligibility</a>; }></code>

getPromotionalOffer(...)

getPromotionalOffer(options: GetPromotionalOfferOptions) => Promise<PurchasesPromotionalOffer | undefined>

iOS only. Use this function to retrieve the <a href="#purchasespromotionaloffer">PurchasesPromotionalOffer</a> for a given <a href="#purchasespackage">PurchasesPackage</a>.

Returns: <code>Promise<<a href="#purchasespromotionaloffer">PurchasesPromotionalOffer</a>></code>

invalidateCustomerInfoCache()

invalidateCustomerInfoCache() => Promise<void>

Invalidates the cache for customer information.

Most apps will not need to use this method; invalidating the cache can leave your app in an invalid state. Refer to https://docs.revenuecat.com/docs/customer-info#section-get-user-information for more information on using the cache properly.

This is useful for cases where customer information might have been updated outside the app, like if a promotional subscription is granted through the RevenueCat dashboard.

presentCodeRedemptionSheet()

presentCodeRedemptionSheet() => Promise<void>

iOS 14.0+ only. Presents a code redemption sheet, useful for redeeming offer codes Refer to https://docs.revenuecat.com/docs/ios-subscription-offers#offer-codes for more information on how to configure and use offer codes

setAttributes(...)

setAttributes(attributes: { [key: string]: string | null; }) => Promise<void>

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

setEmail(...)

setEmail(options: { email: string | null; }) => Promise<void>

Subscriber attribute associated with the email address for the user

setPhoneNumber(...)

setPhoneNumber(options: { phoneNumber: string | null; }) => Promise<void>

Subscriber attribute associated with the phone number for the user

setDisplayName(...)

setDisplayName(options: { displayName: string | null; }) => Promise<void>

Subscriber attribute associated with the display name for the user

setPushToken(...)

setPushToken(options: { pushToken: string | null; }) => Promise<void>

Subscriber attribute associated with the push token for the user

setProxyURL(...)

setProxyURL(options: { url: string; }) => Promise<void>

Set this property to your proxy URL before configuring Purchases only if you've received a proxy key value from your RevenueCat contact.

collectDeviceIdentifiers()

collectDeviceIdentifiers() => Promise<void>

Automatically collect subscriber attributes associated with the device identifiers. $idfa, $idfv, $ip on iOS $gpsAdId, $androidId, $ip on Android

setAdjustID(...)

setAdjustID(options: { adjustID: string | null; }) => Promise<void>

Subscriber attribute associated with the Adjust ID for the user Required for the RevenueCat Adjust integration

setAppsflyerID(...)

setAppsflyerID(options: { appsflyerID: string | null; }) => Promise<void>

Subscriber attribute associated with the AppsFlyer ID for the user Required for the RevenueCat AppsFlyer integration

setFBAnonymousID(...)

setFBAnonymousID(options: { fbAnonymousID: string | null; }) => Promise<void>

Subscriber attribute associated with the Facebook SDK Anonymous ID for the user Recommended for the RevenueCat Facebook integration

setMparticleID(...)

setMparticleID(options: { mparticleID: string | null; }) => Promise<void>

Subscriber attribute associated with the mParticle ID for the user Recommended for the RevenueCat mParticle integration

setCleverTapID(...)

setCleverTapID(options: { cleverTapID: string | null; }) => Promise<void>

Subscriber attribute associated with the CleverTap ID for the user Required for the RevenueCat CleverTap integration

setMixpanelDistinctID(...)

setMixpanelDistinctID(options: { mixpanelDistinctID: string | null; }) => Promise<void>

Subscriber attribute associated with the Mixpanel Distinct ID for the user Required for the RevenueCat Mixpanel integration

setFirebaseAppInstanceID(...)

setFirebaseAppInstanceID(options: { firebaseAppInstanceID: string | null; }) => Promise<void>

Subscriber attribute associated with the Firebase App Instance ID for the user Required for the RevenueCat Firebase integration

setOnesignalID(...)

setOnesignalID(options: { onesignalID: string | null; }) => Promise<void>

Subscriber attribute associated with the OneSignal Player ID for the user Required for the RevenueCat OneSignal integration. Deprecated for OneSignal versions above v9.0.

setOnesignalUserID(...)

setOnesignalUserID(options: { onesignalUserID: string | null; }) => Promise<void>

Subscriber attribute associated with the OneSignal User ID for the user Required for the RevenueCat OneSignal integration with versions v11.0 and above.

setAirshipChannelID(...)

setAirshipChannelID(options: { airshipChannelID: string | null; }) => Promise<void>

Subscriber attribute associated with the Airship Channel ID for the user Required for the RevenueCat Airship integration

setMediaSource(...)

setMediaSource(options: { mediaSource: string | null; }) => Promise<void>

Subscriber attribute associated with the install media source for the user

setCampaign(...)

setCampaign(options: { campaign: string | null; }) => Promise<void>

Subscriber attribute associated with the install campaign for the user

setAdGroup(...)

setAdGroup(options: { adGroup: string | null; }) => Promise<void>

Subscriber attribute associated with the install ad group for the user

setAd(...)

setAd(options: { ad: string | null; }) => Promise<void>

Subscriber attribute associated with the install ad for the user

setKeyword(...)

setKeyword(options: { keyword: string | null; }) => Promise<void>

Subscriber attribute associated with the install keyword for the user

setCreative(...)

setCreative(options: { creative: string | null; }) => Promise<void>

Subscriber attribute associated with the install ad creative for the user

canMakePayments(...)

canMakePayments(options?: { features?: BILLING_FEATURE[] | undefined; } | undefined) => Promise<{ canMakePayments: boolean; }>

Check if billing is supported for the current user (meaning IN-APP purchases are supported) and optionally, whether a list of specified feature types are supported.

Note: Billing features are only relevant to Google Play Android users. For other stores and platforms, billing features won't be checked.

Returns: <code>Promise<{ canMakePayments: boolean; }></code>

beginRefundRequestForActiveEntitlement()

beginRefundRequestForActiveEntitlement() => Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS; }>

iOS 15+ only. Presents a refund request sheet in the current window scene for the latest transaction associated with the active entitlement.

If the request was unsuccessful, no active entitlements could be found for the user, or multiple active entitlements were found for the user, the promise will return an error. If called in an unsupported platform (Android or iOS < 15), an UnsupportedPlatformException will be thrown.

Important: This method should only be used if your user can only have a single active entitlement at a given time. If a user could have more than one entitlement at a time, use beginRefundRequestForEntitlement instead.

Returns: <code>Promise<{ refundRequestStatus: <a href="#refund_request_status">REFUND_REQUEST_STATUS</a>; }></code>

beginRefundRequestForEntitlement(...)

beginRefundRequestForEntitlement(options: { entitlementInfo: PurchasesEntitlementInfo; }) => Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS; }>

iOS 15+ only. Presents a refund request sheet in the current window scene for the latest transaction associated with the entitlement.

If the request was unsuccessful, the promise will return an error. If called in an unsupported platform (Android or iOS < 15), an UnsupportedPlatformException will be thrown.

Returns: <code>Promise<{ refundRequestStatus: <a href="#refund_request_status">REFUND_REQUEST_STATUS</a>; }></code>

beginRefundRequestForProduct(...)

beginRefundRequestForProduct(options: { storeProduct: PurchasesStoreProduct; }) => Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS; }>

iOS 15+ only. Presents a refund request sheet in the current window scene for the latest transaction associated with the product.

If the request was unsuccessful, the promise will return an error. If called in an unsupported platform (Android or iOS < 15), an UnsupportedPlatformException will be thrown.

Returns: <code>Promise<{ refundRequestStatus: <a href="#refund_request_status">REFUND_REQUEST_STATUS</a>; }></code>

showInAppMessages(...)

showInAppMessages(options?: { messageTypes?: IN_APP_MESSAGE_TYPE[] | undefined; } | undefined) => Promise<void>

Shows in-app messages available from the App Store or Google Play. You need to disable messages from showing automatically using [PurchasesConfiguration.shouldShowInAppMessagesAutomatically].

Note: In iOS, this requires version 16+. In older versions the promise will be resolved successfully immediately.

isConfigured()

isConfigured() => Promise<{ isConfigured: boolean; }>

Check if configure has finished and Purchases has been configured.

Returns: <code>Promise<{ isConfigured: boolean; }></code>

Interfaces

PurchasesConfiguration

Holds parameters to initialize the SDK.

CustomerInfo

Type containing all information regarding the customer

PurchasesEntitlementInfos

Contains all the entitlements associated to the user.

PurchasesEntitlementInfo

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

PurchasesStoreTransaction

Represents a non-subscription transaction in the Store.

PurchasesOfferings

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

PurchasesOffering

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

PurchasesPackage

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

PurchasesStoreProduct

Type representing a product from the Store.

PurchasesIntroPrice

Contains information about the introductory price for a product

PurchasesStoreProductDiscount

Contains information about a discount offer for a product

SubscriptionOption

Contains all details associated with a SubscriptionOption Used only for Google

PricingPhase

Contains all the details associated with a <a href="#pricingphase">PricingPhase</a>

Period

Contains all the details associated with a <a href="#period">Period</a>

Price

Contains all the details associated with a <a href="#price">Price</a>

PresentedOfferingContext

Contains data about the context in which an offering was presented.

PresentedOfferingTargetingContext

Contains data about the context in which an offering was presented.

InstallmentsInfo

Type containing information of installment subscriptions. Currently only supported in Google Play.

GetProductOptions

PurchaseStoreProductOptions

GoogleProductChangeInfo

Holds the information used when upgrading from another sku. For Android use only.

PurchaseDiscountedProductOptions

PurchasesPromotionalOffer

Holds the information about a PromotionalOffer in Apple's App Store.

PurchasePackageOptions

PurchaseSubscriptionOptionOptions

PurchaseDiscountedPackageOptions

LogInResult

Holds the logIn result

SyncAmazonPurchaseOptions

IntroEligibility

Holds the introductory price status

GetPromotionalOfferOptions

Type Aliases

PurchasesAreCompletedBy

Allows you to specify whether you want RevenueCat to complete your app's purchases or if your app will do so.

You can configure RevenueCat to complete your purchases like so:

Purchases.configure({
 apiKey: "123",
 purchasesAreCompletedBy: PURCHASES_ARE_COMPLETED_BY.REVENUECAT,
});

You can specify that purchase are completed by your app like so:

Purchases.configure({
 apiKey: "123",
 purchasesAreCompletedBy: {
   type: PURCHASES_ARE_COMPLETED_BY.MY_APP,
   storeKitVersion: <a href="#storekit_version">STOREKIT_VERSION</a>.STOREKIT_1
 },
});

<code><a href="#purchases_are_completed_by_type">PURCHASES_ARE_COMPLETED_BY_TYPE.REVENUECAT</a> | <a href="#purchasesarecompletedbymyapp">PurchasesAreCompletedByMyApp</a></code>

PurchasesAreCompletedByMyApp

Configuration option that specifies that your app will complete purchases.

<code>{ type: <a href="#purchases_are_completed_by_type">PURCHASES_ARE_COMPLETED_BY_TYPE.MY_APP</a>; /** * The version of StoreKit that your app is using to make purchases. This value is ignored * on Android, so if your app is Android-only, you may provide any value. */ storeKitVersion: <a href="#storekit_version">STOREKIT_VERSION</a>; }</code>

CustomerInfoUpdateListener

Listener used on updated customer info

<code>(customerInfo: <a href="#customerinfo">CustomerInfo</a>): void</code>

PurchasesCallbackId

<code>string</code>

MakePurchaseResult

Result of a successful purchase

<code>{ /** * The product identifier of the purchased product / productIdentifier: string; /* * The Customer Info for the user. / customerInfo: <a href="#customerinfo">CustomerInfo</a>; /* * The transaction object for the purchase */ transaction: <a href="#purchasesstoretransaction">PurchasesStoreTransaction</a>; }</code>

LogHandler

Listener used to receive log messages from the SDK.

<code>(logLevel: <a href="#log_level">LOG_LEVEL</a>, message: string): void</code>

SyncObserverModeAmazonPurchaseOptions

<code><a href="#syncamazonpurchaseoptions">SyncAmazonPurchaseOptions</a></code>

Enums

PURCHASES_ARE_COMPLETED_BY_TYPE

STOREKIT_VERSION

ENTITLEMENT_VERIFICATION_MODE

VERIFICATION_RESULT

PACKAGE_TYPE

PRODUCT_CATEGORY

PRODUCT_TYPE

PERIOD_UNIT

RECURRENCE_MODE

OFFER_PAYMENT_MODE

PRORATION_MODE

LOG_LEVEL

INTRO_ELIGIBILITY_STATUS

BILLING_FEATURE

REFUND_REQUEST_STATUS

IN_APP_MESSAGE_TYPE