@revenuecat/purchases-capacitor

😻 In-App Subscriptions Made Easy 😻


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

| | RevenueCat |
|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ✅ | Server-side receipt validation |
| ➡️ | Webhooks - enhanced server-to-server communication with events for purchases, renewals, cancellations, and more |
| 🎯 | Subscription status tracking - know whether a user is subscribed whether they're on iOS, Android or web |
| 📊 | Analytics - automatic calculation of metrics like conversion, mrr, and churn |
| 📝 | Online documentation up to date |
| 🔀 | Integrations - over a dozen integrations to easily send purchase data where you need it |
| 💯 | Well maintained - frequent releases |
| 📮 | Great support - Help Center |

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.

``bash
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(...)
* getVirtualCurrencies()
* invalidateVirtualCurrenciesCache()
* getCachedVirtualCurrencies()
* parseAsWebPurchaseRedemption(...)
* redeemWebPurchase(...)
* setMockWebResults(...)
* setSimulatesAskToBuyInSandbox(...)
* addCustomerInfoUpdateListener(...)
* removeCustomerInfoUpdateListener(...)
* getOfferings()
* getCurrentOfferingForPlacement(...)
* syncAttributesAndOfferingsIfNeeded()
* getProducts(...)
* purchaseStoreProduct(...)
* purchaseDiscountedProduct(...)
* purchasePackage(...)
* purchaseSubscriptionOption(...)
* purchaseDiscountedPackage(...)
* restorePurchases()
* recordPurchase(...)
* getAppUserID()
* getStorefront()
* logIn(...)
* logOut()
* setLogLevel(...)
* setLogHandler(...)
* getCustomerInfo()
* syncPurchases()
* syncObserverModeAmazonPurchase(...)
* syncAmazonPurchase(...)
* enableAdServicesAttributionTokenCollection()
* isAnonymous()
* checkTrialOrIntroductoryPriceEligibility(...)
* getPromotionalOffer(...)
* getEligibleWinBackOffersForProduct(...)
* getEligibleWinBackOffersForPackage(...)
* purchaseProductWithWinBackOffer(...)
* purchasePackageWithWinBackOffer(...)
* 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()
* overridePreferredUILocale(...)
* Interfaces
* Type Aliases
* Enums




$3

`typescript
configure(configuration: PurchasesConfiguration) => Promise
`

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

| Param | Type | Description |
| ------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| configuration | PurchasesConfiguration | RevenueCat configuration object including the API key and other optional parameters. See {@link PurchasesConfiguration} |

--------------------




$3

`typescript
getVirtualCurrencies() => Promise<{ virtualCurrencies: PurchasesVirtualCurrencies; }>
`

Fetches the virtual currencies for the current subscriber.

Returns: Promise<{ virtualCurrencies: PurchasesVirtualCurrencies; }>

--------------------




$3

`typescript
invalidateVirtualCurrenciesCache() => Promise
`

Invalidates the cache for virtual currencies.

This is useful for cases where a virtual currency's balance might have been updated
outside of the app, like if you decreased a user's balance from the user spending a virtual currency,
or if you increased the balance from your backend using the server APIs.

--------------------




$3

`typescript
getCachedVirtualCurrencies() => Promise<{ cachedVirtualCurrencies: PurchasesVirtualCurrencies | null; }>
`

The currently cached {@link PurchasesVirtualCurrencies} if one is available.
This value will remain null until virtual currencies have been fetched at
least once with {@link getVirtualCurrencies} or an equivalent function.

Returns: Promise<{ cachedVirtualCurrencies: PurchasesVirtualCurrencies | null; }>

--------------------




$3

`typescript
parseAsWebPurchaseRedemption(options: { urlString: string; }) => Promise<{ webPurchaseRedemption: WebPurchaseRedemption | null; }>
`

Parses the given URL string into a [WebPurchaseRedemption] object that can be used to redeem web purchases.

| Param | Type | Description |
| ------------- | ----------------------------------- | --------------------------------------- |
| options | { urlString: string; } | Set the urlString used to open the App. |

Returns: Promise<{ webPurchaseRedemption: WebPurchaseRedemption | null; }>

--------------------




$3

`typescript
redeemWebPurchase(options: { webPurchaseRedemption: WebPurchaseRedemption; }) => Promise
`

Redeems the web purchase associated with the Redemption Link obtained with [parseAsWebPurchaseRedemption].

| Param | Type | Description |
| ------------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| options | { webPurchaseRedemption: WebPurchaseRedemption; } | The WebPurchaseRedemption object obtained from {@link parseAsWebPurchaseRedemption}. |

Returns: Promise<WebPurchaseRedemptionResult>

--------------------




$3

`typescript
setMockWebResults(options: { shouldMockWebResults: boolean; }) => Promise
`

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

| Param | Type | Description |
| ------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------- |
| options | { shouldMockWebResults: boolean; } | Set shouldMockWebResults to true if you want the plugin methods to return mocked values |

--------------------




$3

`typescript
setSimulatesAskToBuyInSandbox(options: { simulatesAskToBuyInSandbox: boolean; }) => Promise
`

iOS only.

| Param | Type | Description |
| ------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| options | { simulatesAskToBuyInSandbox: boolean; } | Set this property to true only when testing the ask-to-buy / SCA purchases flow. More information: http://errors.rev.cat/ask-to-buy |

--------------------




$3

`typescript
addCustomerInfoUpdateListener(customerInfoUpdateListener: CustomerInfoUpdateListener) => Promise
`

Sets a function to be called on updated customer info

| Param | Type | Description |
| -------------------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------- |
| customerInfoUpdateListener | CustomerInfoUpdateListener | CustomerInfo update listener |

Returns: Promise<string>

--------------------




$3

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

Removes a given CustomerInfoUpdateListener

| Param | Type | Description |
| ------------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------- |
| options | { listenerToRemove: string; } | Include listenerToRemove, which is a CustomerInfoUpdateListener reference of the listener to remove |

Returns: Promise<{ wasRemoved: boolean; }>

--------------------




$3

`typescript
getOfferings() => Promise
`

Gets the map of entitlements -> offerings -> products

Returns: Promise<PurchasesOfferings>

--------------------




$3

`typescript
getCurrentOfferingForPlacement(options: { placementIdentifier: string; }) => Promise
`

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

| Param | Type |
| ------------- | --------------------------------------------- |
| options | { placementIdentifier: string; } |

Returns: Promise<PurchasesOffering | null>

--------------------




$3

`typescript
syncAttributesAndOfferingsIfNeeded() => Promise
`

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: Promise<PurchasesOfferings>

--------------------




$3

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

Fetch the product info

| Param | Type |
| ------------- | --------------------------------------------------------------- |
| options | GetProductOptions |

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

--------------------




$3

`typescript
purchaseStoreProduct(options: PurchaseStoreProductOptions) => Promise
`

Make a purchase

| Param | Type |
| ------------- | ----------------------------------------------------------------------------------- |
| options | PurchaseStoreProductOptions |

Returns: Promise<MakePurchaseResult>

--------------------




$3

`typescript
purchaseDiscountedProduct(options: PurchaseDiscountedProductOptions) => Promise
`

iOS only. Purchase a product applying a given discount.

| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------- |
| options | PurchaseDiscountedProductOptions |

Returns: Promise<MakePurchaseResult>

--------------------




$3

`typescript
purchasePackage(options: PurchasePackageOptions) => Promise
`

Make a purchase

| Param | Type |
| ------------- | ------------------------------------------------------------------------- |
| options | PurchasePackageOptions |

Returns: Promise<MakePurchaseResult>

--------------------




$3

`typescript
purchaseSubscriptionOption(options: PurchaseSubscriptionOptionOptions) => Promise
`

Google only. Make a purchase of a subscriptionOption

| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------- |
| options | PurchaseSubscriptionOptionOptions |

Returns: Promise<MakePurchaseResult>

--------------------




$3

`typescript
purchaseDiscountedPackage(options: PurchaseDiscountedPackageOptions) => Promise
`

iOS only. Purchase a package applying a given discount.

| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------- |
| options | PurchaseDiscountedPackageOptions |

Returns: Promise<MakePurchaseResult>

--------------------




$3

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

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

Returns: Promise<{ customerInfo: CustomerInfo; }>

--------------------




$3

`typescript
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.

| Param | Type | Description |
| ------------- | ----------------------------------- | ----------------------------------------------------------------------------------- |
| options | { productID: string; } | The productID that was purchased that needs to be synced with RevenueCat's backend. |

Returns: Promise<{ transaction: PurchasesStoreTransaction; }>

--------------------




$3

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

Get the appUserID

Returns: Promise<{ appUserID: string; }>

--------------------




$3

`typescript
getStorefront() => Promise
`

Gets the storefront for the current store account.

Returns: Promise<Storefront>

--------------------




$3

`typescript
logIn(options: { appUserID: string; }) => Promise
`

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.

| Param | Type | Description |
| ------------- | ----------------------------------- | ------------------------------------------------------- |
| options | { appUserID: string; } | The appUserID that should be linked to the current user |

Returns: Promise<LogInResult>

--------------------




$3

`typescript
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: Promise<{ customerInfo: CustomerInfo; }>

--------------------




$3

`typescript
setLogLevel(options: { level: LOG_LEVEL; }) => Promise
`

Used to set the log level. Useful for debugging issues with the lovely team @RevenueCat.
The default is {LOG_LEVEL.INFO} in release builds and {LOG_LEVEL.DEBUG} in debug builds.

| Param | Type | Description |
| ------------- | ----------------------------------------------------------- | --------------------------------- |
| options | { level: LOG_LEVEL; } | Log level to use to display logs. |

--------------------




$3

`typescript
setLogHandler(logHandler: LogHandler) => Promise
`

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].

| Param | Type | Description |
| ---------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| logHandler | LogHandler | It will get called for each log event. Use this function to redirect the log to your own logging system |

--------------------




$3

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

Gets current customer info

Returns: Promise<{ customerInfo: CustomerInfo; }>

--------------------




$3

`typescript
syncPurchases() => Promise
`

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.

--------------------




$3

`typescript
syncObserverModeAmazonPurchase(options: SyncObserverModeAmazonPurchaseOptions) => Promise
`

| Param | Type |
| ------------- | ------------------------------------------------------------------------------- |
| options | SyncAmazonPurchaseOptions |

--------------------




$3

`typescript
syncAmazonPurchase(options: SyncAmazonPurchaseOptions) => Promise
`

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.

| Param | Type |
| ------------- | ------------------------------------------------------------------------------- |
| options | SyncAmazonPurchaseOptions |

--------------------




$3

`typescript
enableAdServicesAttributionTokenCollection() => Promise
`

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

--------------------




$3

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

Returns: Promise<{ isAnonymous: boolean; }>

--------------------




$3

`typescript
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).

| Param | Type | Description |
| ------------- | ---------------------------------------------- | ---------------------------------------------------------------------- |
| options | { productIdentifiers: string[]; } | Array of product identifiers for which you want to compute eligibility |

Returns: Promise<{ [productId: string]: IntroEligibility; }>

--------------------




$3

`typescript
getPromotionalOffer(options: GetPromotionalOfferOptions) => Promise
`

iOS only. Use this function to retrieve the PurchasesPromotionalOffer for a given PurchasesPackage.

| Param | Type |
| ------------- | --------------------------------------------------------------------------------- |
| options | GetPromotionalOfferOptions |

Returns: Promise<PurchasesPromotionalOffer>

--------------------




$3

`typescript
getEligibleWinBackOffersForProduct(options: GetEligibleWinBackOffersForProductOptions) => Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[]; }>
`

iOS only, requires iOS 18.0 or greater with StoreKit 2. Use this function to retrieve
the eligible PurchasesWinBackOffers that a subscriber is eligible for for a
given PurchasesStoreProduct.

| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------------------------- |
| options | GetEligibleWinBackOffersForProductOptions |

Returns: Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[]; }>

--------------------




$3

`typescript
getEligibleWinBackOffersForPackage(options: GetEligibleWinBackOffersForPackageOptions) => Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[]; }>
`

iOS only, requires iOS 18.0 or greater with StoreKit 2. Use this function to retrieve
the eligible PurchasesWinBackOffers that a subscriber is eligible for for a
given PurchasesStorePackage.

| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------------------------- |
| options | GetEligibleWinBackOffersForPackageOptions |

Returns: Promise<{ eligibleWinBackOffers: PurchasesWinBackOffer[]; }>

--------------------




$3

`typescript
purchaseProductWithWinBackOffer(options: PurchaseProductWithWinBackOfferOptions) => Promise
`

iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a product applying a given win-back offer.

| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------------------- |
| options | PurchaseProductWithWinBackOfferOptions |

Returns: Promise<MakePurchaseResult>

--------------------




$3

`typescript
purchasePackageWithWinBackOffer(options: PurchasePackageWithWinBackOfferOptions) => Promise
`

iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a package applying a given win-back offer.

| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------------------- |
| options | PurchasePackageWithWinBackOfferOptions |

Returns: Promise<MakePurchaseResult>

--------------------




$3

`typescript
invalidateCustomerInfoCache() => Promise
`

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.

--------------------




$3

`typescript
presentCodeRedemptionSheet() => Promise
`

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

--------------------




$3

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

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

| Param | Type | Description |
| ---------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------- |
| attributes | { [key: string]: string \| null; } | Map of attributes by key. Set the value as an empty string to delete an attribute. |

--------------------




$3

`typescript
setEmail(options: { email: string | null; }) => Promise
`

Subscriber attribute associated with the email address for the user

| Param | Type | Description |
| ------------- | --------------------------------------- | ---------------------------------------------------------- |
| options | { email: string \| null; } | Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setPhoneNumber(options: { phoneNumber: string | null; }) => Promise
`

Subscriber attribute associated with the phone number for the user

| Param | Type | Description |
| ------------- | --------------------------------------------- | ---------------------------------------------------------- |
| options | { phoneNumber: string \| null; } | Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setDisplayName(options: { displayName: string | null; }) => Promise
`

Subscriber attribute associated with the display name for the user

| Param | Type | Description |
| ------------- | --------------------------------------------- | ---------------------------------------------------------- |
| options | { displayName: string \| null; } | Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setPushToken(options: { pushToken: string | null; }) => Promise
`

Subscriber attribute associated with the push token for the user

| Param | Type | Description |
| ------------- | ------------------------------------------- | ------------------------------------------ |
| options | { pushToken: string \| null; } | null will delete the subscriber attribute. |

--------------------




$3

`typescript
setProxyURL(options: { url: string; }) => Promise
`

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

| Param | Type |
| ------------- | ----------------------------- |
| options | { url: string; } |

--------------------




$3

`typescript
collectDeviceIdentifiers() => Promise
`

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

--------------------




$3

`typescript
setAdjustID(options: { adjustID: string | null; }) => Promise
`

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

| Param | Type | Description |
| ------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------- |
| options | { adjustID: string \| null; } | Adjust ID to use in Adjust integration. Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setAppsflyerID(options: { appsflyerID: string | null; }) => Promise
`

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

| Param | Type | Description |
| ------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| options | { appsflyerID: string \| null; } | Appsflyer ID to use in Appsflyer integration. Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setFBAnonymousID(options: { fbAnonymousID: string | null; }) => Promise
`

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

| Param | Type | Description |
| ------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| options | { fbAnonymousID: string \| null; } | Facebook Anonymous ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setMparticleID(options: { mparticleID: string | null; }) => Promise
`

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

| Param | Type | Description |
| ------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| options | { mparticleID: string \| null; } | Mparticle ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setCleverTapID(options: { cleverTapID: string | null; }) => Promise
`

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

| Param | Type | Description |
| ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| options | { cleverTapID: string \| null; } | CleverTap user ID to use in CleverTap integration. Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setMixpanelDistinctID(options: { mixpanelDistinctID: string | null; }) => Promise
`

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

| Param | Type | Description |
| ------------- | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| options | { mixpanelDistinctID: string \| null; } | Mixpanel Distinct ID to use in Mixpanel integration. Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setFirebaseAppInstanceID(options: { firebaseAppInstanceID: string | null; }) => Promise
`

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

| Param | Type | Description |
| ------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| options | { firebaseAppInstanceID: string \| null; } | Firebase App Instance ID to use in Firebase integration. Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setOnesignalID(options: { onesignalID: string | null; }) => Promise
`

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

| Param | Type | Description |
| ------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| options | { onesignalID: string \| null; } | OneSignal Player ID to use in OneSignal integration. Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setOnesignalUserID(options: { onesignalUserID: string | null; }) => Promise
`

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

| Param | Type | Description |
| ------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| options | { onesignalUserID: string \| null; } | OneSignal UserId to use in OneSignal integration. Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setAirshipChannelID(options: { airshipChannelID: string | null; }) => Promise
`

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

| Param | Type | Description |
| ------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| options | { airshipChannelID: string \| null; } | Airship Channel ID to use in Airship integration. Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setMediaSource(options: { mediaSource: string | null; }) => Promise
`

Subscriber attribute associated with the install media source for the user

| Param | Type | Description |
| ------------- | --------------------------------------------- | ---------------------------------------------------------- |
| options | { mediaSource: string \| null; } | Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setCampaign(options: { campaign: string | null; }) => Promise
`

Subscriber attribute associated with the install campaign for the user

| Param | Type | Description |
| ------------- | ------------------------------------------ | ---------------------------------------------------------- |
| options | { campaign: string \| null; } | Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setAdGroup(options: { adGroup: string | null; }) => Promise
`

Subscriber attribute associated with the install ad group for the user

| Param | Type | Description |
| ------------- | ----------------------------------------- | ---------------------------------------------------------- |
| options | { adGroup: string \| null; } | Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setAd(options: { ad: string | null; }) => Promise
`

Subscriber attribute associated with the install ad for the user

| Param | Type | Description |
| ------------- | ------------------------------------ | ---------------------------------------------------------- |
| options | { ad: string \| null; } | Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setKeyword(options: { keyword: string | null; }) => Promise
`

Subscriber attribute associated with the install keyword for the user

| Param | Type | Description |
| ------------- | ----------------------------------------- | ---------------------------------------------------------- |
| options | { keyword: string \| null; } | Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
setCreative(options: { creative: string | null; }) => Promise
`

Subscriber attribute associated with the install ad creative for the user

| Param | Type | Description |
| ------------- | ------------------------------------------ | ---------------------------------------------------------- |
| options | { creative: string \| null; } | Empty String or null will delete the subscriber attribute. |

--------------------




$3

`typescript
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.

| Param | Type | Description |
| ------------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| options | { features?: BILLING_FEATURE[]; } | An array of feature types to check for support. Feature types must be one of [BILLING_FEATURE]. By default, is an empty list and no specific feature support will be checked. |

Returns: Promise<{ canMakePayments: boolean; }>

--------------------




$3

`typescript
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: Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS; }>

--------------------




$3

`typescript
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.

| Param | Type | Description |
| ------------- | --------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
| options | { entitlementInfo: PurchasesEntitlementInfo; } | The entitlement to begin a refund request for. |

Returns: Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS; }>

--------------------




$3

`typescript
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.

| Param | Type | Description |
| ------------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------- |
| options | { storeProduct: PurchasesStoreProduct; } | The StoreProduct to begin a refund request for. |

Returns: Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS; }>

--------------------




$3

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

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.

| Param | Type | Description |
| ------------- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| options | { messageTypes?: IN_APP_MESSAGE_TYPE[]; } | An array of message types that the stores can display inside your app. Values must be one of [IN_APP_MESSAGE_TYPE]. By default, is undefined and all message types will be shown. |

--------------------




$3

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

Check if configure has finished and Purchases has been configured.

Returns: Promise<{ isConfigured: boolean; }>

--------------------




$3

`typescript
overridePreferredUILocale(options: { locale: string | null; }) => Promise
`

Override the preferred UI locale for RevenueCat UI components at runtime. This affects both API requests
and UI rendering. If the locale changes, this will automatically clear the offerings cache and trigger
a background refetch to get paywall templates with the correct localizations.

| Param | Type | Description |
| ------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
| options | { locale: string \| null; } | The locale string (e.g., "es-ES", "en-US") or null to use system default. |

--------------------




$3


#### PurchasesConfiguration

Holds parameters to initialize the SDK.

| Prop | Type | Description |
| ------------------------------------------------ | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| apiKey | string | RevenueCat API Key. Needs to be a string |
| appUserID | string \| null | A unique id for identifying the user |
| purchasesAreCompletedBy | PurchasesAreCompletedBy | Set this to MY_APP and provide a STOREKIT_VERSION if you have your own IAP implementation and want to only use RevenueCat's backend. Defaults to PURCHASES_ARE_COMPLETED_BY_TYPE.REVENUECAT. If you are on Android and setting this to MY_APP, will have to acknowledge the purchases yourself. If your app is only on Android, you may specify any StoreKit version, as it is ignored by the Android SDK. |
| userDefaultsSuiteName | string | An optional string. iOS-only, will be ignored for Android. Set this if you would like the RevenueCat SDK to store its preferences in a different NSUserDefaults suite, otherwise it will use standardUserDefaults. Default is null, which will make the SDK use standardUserDefaults. |
| storeKitVersion | STOREKIT_VERSION | iOS-only, will be ignored for Android. By selecting the DEFAULT value, RevenueCat will automatically select the most appropriate StoreKit version for the app's runtime environment. - Warning: Make sure you have an In-App Purchase Key configured in your app. Please see https://rev.cat/in-app-purchase-key-configuration for more info. - Note: StoreKit 2 is only available on iOS 16+. StoreKit 1 will be used for previous iOS versions regardless of this setting. |
| useAmazon | boolean | An optional boolean. Android only. Required to configure the plugin to be used in the Amazon Appstore. |
| shouldShowInAppMessagesAutomatically | boolean | Whether we should show store in-app messages automatically. Both Google Play and the App Store provide in-app messages for some situations like billing issues. By default, those messages will be shown automatically. This allows to disable that behavior, so you can display those messages at your convenience. For more information, check: https://rev.cat/storekit-message and https://rev.cat/googleplayinappmessaging |
| entitlementVerificationMode | ENTITLEMENT_VERIFICATION_MODE | Verification strictness levels for [EntitlementInfo]. See https://rev.cat/trusted-entitlements for more info. |
| pendingTransactionsForPrepaidPlansEnabled | boolean | Enable this setting if you want to allow pending purchases for prepaid subscriptions (only supported in Google Play). Note that entitlements are not granted until payment is done. Disabled by default. |
| diagnosticsEnabled | boolean | Enabling diagnostics will send some performance and debugging information from the SDK to RevenueCat's servers. Examples of this information include response times, cache hits or error codes. No personal identifiable information will be collected. The default value is false. |
| automaticDeviceIdentifierCollectionEnabled` | boolean | Enable this setting to allow the collection of identifiers when setting the identifier for an attribution network. For example, when ca