Class default
Index
Constructors
Properties
Methods
Constructors
constructor
Properties
Static Readonly BILLING_
Static Readonly ENTITLEMENT_
Enum of entitlement verification modes.
+Static Readonly INTRO_
Enum of different possible states for intro price eligibility status.
+Static Readonly IN_
List of valid in app message types.
+Static Readonly LOG_
List of valid log levels.
+Static Readonly PACKAGE_
Enumeration of all possible Package types.
+Static Readonly PRODUCT_
Supported product categories.
+Static Readonly PRORATION_
Replace SKU's ProrationMode.
+Static Readonly PURCHASES_
Enum of all error codes the SDK produces.
+Static Readonly PURCHASE_
Supported SKU types.
+@deprecated, use PRODUCT_CATEGORY
+Static Readonly REFUND_
Enum with possible return states for beginning refund request.
+Static Readonly VERIFICATION_
The result of the verification process.
+Methods
Static add
- add
Customer Info Update Listener(customerInfoUpdateListener): void Sets a function to be called on updated customer info
+Parameters
- customerInfoUpdateListener: CustomerInfoUpdateListener
CustomerInfo update listener
+
Returns void
- customerInfoUpdateListener: CustomerInfoUpdateListener
Static add
- add
Should Purchase Promo Product Listener(shouldPurchasePromoProductListener): void Sets a function to be called on purchases initiated on the Apple App Store. This is only used in iOS.
+Parameters
- shouldPurchasePromoProductListener: ShouldPurchasePromoProductListener
Called when a user initiates a +promotional in-app purchase from the App Store. If your app is able to handle a purchase at the current time, run +the deferredPurchase function. If the app is not in a state to make a purchase: cache the deferredPurchase, then +call the deferredPurchase when the app is ready to make the promotional purchase. +If the purchase should never be made, you don't need to ever call the deferredPurchase and the app will not +proceed with promotional purchases.
+
Returns void
- shouldPurchasePromoProductListener: ShouldPurchasePromoProductListener
Static begin
- begin
Refund Request For Active Entitlement(): Promise<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
+UnsupportedPlatformExceptionwill 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
+beginRefundRequestForEntitlementinstead.Returns Promise<REFUND_REQUEST_STATUS>
Returns REFUND_REQUEST_STATUS: The status of the + refund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED
+
Static begin
- begin
Refund Request For Entitlement(entitlementInfo): Promise<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
+UnsupportedPlatformExceptionwill be thrown.Parameters
- entitlementInfo: PurchasesEntitlementInfo
The entitlement to begin a refund request for.
+
Returns Promise<REFUND_REQUEST_STATUS>
Returns REFUND_REQUEST_STATUS: The status of the + refund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED
+- entitlementInfo: PurchasesEntitlementInfo
Static begin
- begin
Refund Request For Product(storeProduct): Promise<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
+UnsupportedPlatformExceptionwill be thrown.Parameters
- storeProduct: PurchasesStoreProduct
The StoreProduct to begin a refund request for.
+
Returns Promise<REFUND_REQUEST_STATUS>
Returns a REFUND_REQUEST_STATUS: The status of the + refund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED
+- storeProduct: PurchasesStoreProduct
Static can
- can
Make Payments(features?): Promise<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.
+Parameters
- 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<boolean>
promise with boolean response. True if billing is supported, false otherwise.
+- features: BILLING_FEATURE[] = []
Static check
- check
Trial Or Introductory Price Eligibility(productIdentifiers): Promise<{
[productId: string]: IntroEligibility;
}> iOS only. Computes whether or not a user is eligible for the introductory pricing period of a given product. +You should use this method to determine whether or not 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).
+Parameters
- productIdentifiers: string[]
Array of product identifiers for which you want to compute eligibility
+
Returns Promise<{
[productId: string]: IntroEligibility;
}>A map of IntroEligility per productId. The promise +will be rejected if configure has not been called yet or if there's in an error checking eligibility.
+Note
Subscription groups are automatically collected for determining eligibility. If RevenueCat can't +definitively compute the eligibility, most likely because of missing group information, it will return +
+INTRO_ELIGIBILITY_STATUS_UNKNOWN. The best course of action on unknown status is to display the non-intro +pricing, to not create a misleading situation. To avoid this, make sure you are testing with the latest version of +iOS so that the subscription group can be collected by the SDK. Android always returns INTRO_ELIGIBILITY_STATUS_UNKNOWN.- productIdentifiers: string[]
Static collect
- collect
Device Identifiers(): Promise<void> Automatically collect subscriber attributes associated with the device identifiers. +$idfa, $idfv, $ip on iOS +$gpsAdId, $androidId, $ip on Android
+Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting collecting the device identifiers.
+
Static configure
- configure(__namedParameters): void
Sets up Purchases with your API key and an app user id.
+Parameters
- __namedParameters: PurchasesConfiguration
Returns void
Static enable
Static get
Static get
- get
Current Offering For Placement(placementIdentifier): Promise<null | PurchasesOffering> Retrieves a current offering for a placement identifier, use this to access offerings defined by targeting +placements configured in the RevenueCat dashboard.
+Parameters
- placementIdentifier: string
The placement identifier to fetch a current offeringn for
+
Returns Promise<null | PurchasesOffering>
Promise of an optional offering. The promise will be rejected if configure +has not been called yet.
+- placementIdentifier: string
Static get
- get
Customer Info(): Promise<CustomerInfo> Gets current customer info
+Returns Promise<CustomerInfo>
A promise of a customer info object. Rejections return an error code, and an +userInfo object with more information. The promise will be rejected if configure has not been called yet or if +there's an issue getting the customer information.
+
Static get
- get
Offerings(): Promise<PurchasesOfferings> Gets the map of entitlements -> offerings -> products
+Returns Promise<PurchasesOfferings>
Promise of entitlements structure. The promise will be rejected if configure +has not been called yet.
+
Static get
- get
Products(productIdentifiers, type?): Promise<PurchasesStoreProduct[]> Fetch the product info
+Parameters
- productIdentifiers: string[]
Array of product identifiers
+ - type: PURCHASE_TYPE | PRODUCT_CATEGORY = PRODUCT_CATEGORY.SUBSCRIPTION
Optional type of products to fetch, can be SUBSCRIPTION or NON_SUBSCRIPTION. SUBSCRIPTION by default
+
Returns Promise<PurchasesStoreProduct[]>
A promise containing an array of products. The promise will be rejected +if the products are not properly configured in RevenueCat or if there is another error retrieving them. +Rejections return an error code, and a userInfo object with more information. The promise will also be rejected +if configure has not been called yet.
+- productIdentifiers: string[]
Static get
- get
Promotional Offer(product, discount): Promise<undefined | PurchasesPromotionalOffer> iOS only. Use this function to retrieve the
+PurchasesPromotionalOfferfor a givenPurchasesPackage.Parameters
- product: PurchasesStoreProduct
The
+PurchasesStoreProductthe user intends to purchase. - discount: PurchasesStoreProductDiscount
The
+PurchasesStoreProductDiscountto apply to the product.
Returns Promise<undefined | PurchasesPromotionalOffer>
Returns when the
+PurchasesPaymentDiscountis returned. +Null is returned for Android and incompatible iOS versions. The promise will be rejected if configure has not been +called yet or if there's an error getting the payment discount.- product: PurchasesStoreProduct
Static invalidate
- invalidate
Customer Info Cache(): 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 of the app, like if a +promotional subscription is granted through the RevenueCat dashboard.
+Returns Promise<void>
The promise will be rejected if configure has not been called yet or there's an error +invalidating the customer info cache.
+
Static is
Static is
Static log
- log
In(appUserID): Promise<LogInResult> 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.
+Parameters
- appUserID: string
The appUserID that should be linked to the currently user
+
Returns Promise<LogInResult>
A promise of an object that contains the customerInfo after logging in, as well +as a boolean indicating whether the user has just been created for the first time in the RevenueCat backend. The +promise will be rejected if configure has not been called yet or if there's an issue logging in.
+- appUserID: string
Static log
- log
Out(): Promise<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>
A promise of a customer info object. Rejections return an error code, +and a userInfo object with more information. The promise will be rejected if configure has not been called yet or if +there's an issue logging out.
+
Static present
- present
Code Redemption Sheet(): Promise<void> iOS 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
+Returns Promise<void>
The promise will be rejected if configure has not been called yet or there's an error +presenting the code redemption sheet.
+
Static purchase
- purchase
Discounted Package(aPackage, discount): Promise<MakePurchaseResult> iOS only. Purchase a package applying a given discount.
+Parameters
- aPackage: PurchasesPackage
The Package you wish to purchase. You can get the Packages by calling getOfferings
+ - discount: PurchasesPromotionalOffer
Discount to apply to this package. Retrieve this discount using getPromotionalOffer.
+
Returns Promise<MakePurchaseResult>
A promise of an object containing +a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the +user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure +has not been called yet.
+- aPackage: PurchasesPackage
Static purchase
- purchase
Discounted Product(product, discount): Promise<MakePurchaseResult> iOS only. Purchase a product applying a given discount.
+Parameters
- product: PurchasesStoreProduct
The product you want to purchase
+ - discount: PurchasesPromotionalOffer
Discount to apply to this package. Retrieve this discount using getPromotionalOffer.
+
Returns Promise<MakePurchaseResult>
A promise of an object containing +a customer info object and a product identifier. Rejections return an error code, +a boolean indicating if the user cancelled the purchase, and an object with more information. The promise will be +rejected if configure has not been called yet.
+- product: PurchasesStoreProduct
Static purchase
- purchase
Package(aPackage, upgradeInfo?, googleProductChangeInfo?, googleIsPersonalizedPrice?): Promise<MakePurchaseResult> Make a purchase
+Parameters
- aPackage: PurchasesPackage
The Package you wish to purchase. You can get the Packages by calling getOfferings
+ OptionalupgradeInfo: null | UpgradeInfoDEPRECATED. Use googleProductChangeInfo.
+OptionalgoogleProductChangeInfo: null | GoogleProductChangeInfoAndroid only. Optional GoogleProductChangeInfo you +wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.
+OptionalgoogleIsPersonalizedPrice: null | booleanAndroid and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU. +For compliance with EU regulations. User will see "This price has been customize for you" in the purchase dialog when true. +See https://developer.android.com/google/play/billing/integrate#personalized-price for more info.
+
Returns Promise<MakePurchaseResult>
A promise of an object containing +a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the +user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure +has not been called yet.
+- aPackage: PurchasesPackage
Static purchase
- purchase
Product(productIdentifier, upgradeInfo?, type?): Promise<MakePurchaseResult> Make a purchase
+Parameters
- productIdentifier: string
The product identifier of the product you want to purchase
+ OptionalupgradeInfo: null | UpgradeInfoAndroid only. Optional UpgradeInfo you wish to upgrade from containing the oldSKU +and the optional prorationMode.
+- type: PURCHASE_TYPE = PURCHASE_TYPE.SUBS
Optional type of product, can be inapp or subs. Subs by default +@deprecated, use purchaseStoreProduct instead
+
Returns Promise<MakePurchaseResult>
- productIdentifier: string
Static purchase
- purchase
Store Product(product, googleProductChangeInfo?, googleIsPersonalizedPrice?): Promise<MakePurchaseResult> Make a purchase
+Parameters
- product: PurchasesStoreProduct
The product you want to purchase
+ OptionalgoogleProductChangeInfo: null | GoogleProductChangeInfoAndroid only. Optional GoogleProductChangeInfo you +wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.
+OptionalgoogleIsPersonalizedPrice: null | booleanAndroid and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU. +For compliance with EU regulations. User will see "This price has been customize for you" in the purchase dialog when true. +See https://developer.android.com/google/play/billing/integrate#personalized-price for more info.
+
Returns Promise<MakePurchaseResult>
A promise of an object containing +a customer info object and a product identifier. Rejections return an error code, +a boolean indicating if the user cancelled the purchase, and an object with more information. The promise will +also be rejected if configure has not been called yet.
+- product: PurchasesStoreProduct
Static purchase
- purchase
Subscription Option(subscriptionOption, googleProductChangeInfo?, googleIsPersonalizedPrice?): Promise<MakePurchaseResult> Google only. Make a purchase of a subscriptionOption
+Parameters
- subscriptionOption: SubscriptionOption
The SubscriptionOption you wish to purchase. You can get the SubscriptionOption from StoreProducts by calling getOfferings
+ OptionalgoogleProductChangeInfo: GoogleProductChangeInfoAndroid only. Optional GoogleProductChangeInfo you +wish to upgrade from containing the oldProductIdentifier and the optional prorationMode.
+OptionalgoogleIsPersonalizedPrice: booleanAndroid and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU. +For compliance with EU regulations. User will see "This price has been customize for you" in the purchase dialog when true. +See https://developer.android.com/google/play/billing/integrate#personalized-price for more info.
+
Returns Promise<MakePurchaseResult>
A promise of an object containing +a customer info object and a product identifier. Rejections return an error code, a boolean indicating if the +user cancelled the purchase, and an object with more information. The promise will be also be rejected if configure +has not been called yet.
+- subscriptionOption: SubscriptionOption
Static remove
- remove
Customer Info Update Listener(listenerToRemove): boolean Removes a given CustomerInfoUpdateListener
+Parameters
- listenerToRemove: CustomerInfoUpdateListener
CustomerInfoUpdateListener reference of the listener to remove
+
Returns boolean
True if listener was removed, false otherwise
+- listenerToRemove: CustomerInfoUpdateListener
Static remove
- remove
Should Purchase Promo Product Listener(listenerToRemove): boolean Removes a given ShouldPurchasePromoProductListener
+Parameters
- listenerToRemove: ShouldPurchasePromoProductListener
ShouldPurchasePromoProductListener reference of +the listener to remove
+
Returns boolean
True if listener was removed, false otherwise
+- listenerToRemove: ShouldPurchasePromoProductListener
Static restore
- restore
Purchases(): Promise<CustomerInfo> Restores a user's previous purchases and links their appUserIDs to any user's also using those purchases.
+Returns Promise<CustomerInfo>
A promise of a customer info object. Rejections return an error code, and an +userInfo object with more information. The promise will be also be rejected if configure has not been called yet.
+
Static set
- set
Ad(ad): Promise<void> Subscriber attribute associated with the install ad for the user
+Parameters
- ad: null | string
Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the ad subscriber attribute.
+- ad: null | string
Static set
- set
Ad Group(adGroup): Promise<void> Subscriber attribute associated with the install ad group for the user
+Parameters
- adGroup: null | string
Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting ad group.
+- adGroup: null | string
Static set
- set
AdjustID(adjustID): Promise<void> Subscriber attribute associated with the Adjust Id for the user +Required for the RevenueCat Adjust integration
+Parameters
- adjustID: null | string
Adjust ID to use in Adjust integration. Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting Adjust ID.
+- adjustID: null | string
Static set
- set
Airship ChannelID(airshipChannelID): Promise<void> Subscriber attribute associated with the Airship Channel Id for the user +Required for the RevenueCat Airship integration
+Parameters
- airshipChannelID: null | string
Airship Channel ID to use in Airship integration. Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the Airship Channel ID.
+- airshipChannelID: null | string
Static set
- set
Allow Sharing Store Account(allowSharing): Promise<void> @deprecated, configure behavior through the RevenueCat dashboard instead. +If an user tries to purchase a product that is active on the current app store account, +we will treat it as a restore and alias the new ID with the previous id.
+Parameters
- allowSharing: boolean
Set this to true if you are passing in an appUserID but it is anonymous, +this is true by default if you didn't pass an appUserID
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet.
+- allowSharing: boolean
Static set
- set
AppsflyerID(appsflyerID): Promise<void> Subscriber attribute associated with the AppsFlyer Id for the user +Required for the RevenueCat AppsFlyer integration
+Parameters
- appsflyerID: null | string
Appsflyer ID to use in Appsflyer integration. Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the Appsflyer ID.
+- appsflyerID: null | string
Static set
- set
Attributes(attributes): 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
+Parameters
- attributes: {
[key: string]: string | null;
}Map of attributes by key. Set the value as an empty string to delete an attribute.
+[key: string]: string | null
Returns Promise<void>
The promise will be rejected if configure has not been called yet or there's an error +setting the subscriber attributes.
+- attributes: {
Static set
- set
Automatic Apple Search Ads Attribution Collection(enabled): Promise<void> @deprecated, use enableAdServicesAttributionTokenCollection instead. +Enable automatic collection of Apple Search Ad attribution. Disabled by default
+Parameters
- enabled: boolean
Enable or not automatic apple search ads attribution collection
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet.
+- enabled: boolean
Static set
- set
Campaign(campaign): Promise<void> Subscriber attribute associated with the install campaign for the user
+Parameters
- campaign: null | string
Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the campaign.
+- campaign: null | string
Static set
- set
Clever TapID(cleverTapID): Promise<void> Subscriber attribute associated with the CleverTap Id for the user +Required for the RevenueCat CleverTap integration
+Parameters
- cleverTapID: null | string
CleverTap user ID to use in CleverTap integration. Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the CleverTap ID.
+- cleverTapID: null | string
Static set
- set
Creative(creative): Promise<void> Subscriber attribute associated with the install ad creative for the user
+Parameters
- creative: null | string
Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the creative subscriber attribute.
+- creative: null | string
Static set
Static set
- set
Display Name(displayName): Promise<void> Subscriber attribute associated with the display name for the user
+Parameters
- displayName: null | string
Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the display name.
+- displayName: null | string
Static set
- set
Email(email): Promise<void> Subscriber attribute associated with the email address for the user
+Parameters
- email: null | string
Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the email.
+- email: null | string
Static setFBAnonymousID
- setFBAnonymousID(fbAnonymousID): Promise<void>
Subscriber attribute associated with the Facebook SDK Anonymous Id for the user +Recommended for the RevenueCat Facebook integration
+Parameters
- fbAnonymousID: null | string
Facebook Anonymous ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the Facebook Anonymous ID.
+- fbAnonymousID: null | string
Static set
Static set
- set
Firebase App InstanceID(firebaseAppInstanceID): Promise<void> Subscriber attribute associated with the Firebase App Instance ID for the user +Required for the RevenueCat Firebase integration
+Parameters
- firebaseAppInstanceID: null | string
Firebase App Instance ID to use in Firebase integration. Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the Firebase App Instance ID.
+- firebaseAppInstanceID: null | string
Static set
- set
Keyword(keyword): Promise<void> Subscriber attribute associated with the install keyword for the user
+Parameters
- keyword: null | string
Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the keyword.
+- keyword: null | string
Static set
- set
Log Handler(logHandler): 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].
+Parameters
- logHandler: LogHandler
It will get called for each log event. +Use this function to redirect the log to your own logging system
+
Returns void
- logHandler: LogHandler
Static set
- set
Log Level(level): Promise<void> 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.
+Parameters
- level: LOG_LEVEL
Returns Promise<void>
Static set
- set
Media Source(mediaSource): Promise<void> Subscriber attribute associated with the install media source for the user
+Parameters
- mediaSource: null | string
Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the media source.
+- mediaSource: null | string
Static set
- set
Mixpanel DistinctID(mixpanelDistinctID): Promise<void> Subscriber attribute associated with the Mixpanel Distinct Id for the user +Required for the RevenueCat Mixpanel integration
+Parameters
- mixpanelDistinctID: null | string
Mixpanel Distinct ID to use in Mixpanel integration. Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the Mixpanel Distinct ID.
+- mixpanelDistinctID: null | string
Static set
- set
MparticleID(mparticleID): Promise<void> Subscriber attribute associated with the mParticle Id for the user +Recommended for the RevenueCat mParticle integration
+Parameters
- mparticleID: null | string
Mparticle ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the Mparticle ID.
+- mparticleID: null | string
Static set
- set
OnesignalID(onesignalID): Promise<void> Subscriber attribute associated with the OneSignal Player Id for the user +Required for the RevenueCat OneSignal integration
+Parameters
- onesignalID: null | string
OneSignal Player ID to use in OneSignal integration. Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the OneSignal ID.
+- onesignalID: null | string
Static set
- set
Phone Number(phoneNumber): Promise<void> Subscriber attribute associated with the phone number for the user
+Parameters
- phoneNumber: null | string
Empty String or null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the phone number.
+- phoneNumber: null | string
Static set
- set
ProxyURL(url): 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.
+Parameters
- url: string
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the proxy url.
+
Static set
- set
Push Token(pushToken): Promise<void> Subscriber attribute associated with the push token for the user
+Parameters
- pushToken: null | string
null will delete the subscriber attribute.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +setting the push token.
+- pushToken: null | string
Static set
- set
Simulates Ask To Buy In Sandbox(simulatesAskToBuyInSandbox): Promise<void> iOS only.
+Parameters
- 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
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet.
+- simulatesAskToBuyInSandbox: boolean
Static show
- show
In App Messages(messageTypes?): 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.
+Parameters
OptionalmessageTypes: IN_APP_MESSAGE_TYPE[]An array of message types that the stores can display inside your app. Must be one of + [IN_APP_MESSAGE_TYPE]. By default, is undefined and all message types will be shown.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet.
+
Static sync
- sync
Attributes And Offerings If Needed(): 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 Promise<PurchasesOfferings>
Promise of entitlements structure. The promise will be rejected if configure +has not been called yet.
+
Static sync
- sync
Observer Mode Amazon Purchase(productID, receiptID, amazonUserID, isoCurrencyCode?, price?): 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.
+Parameters
- productID: string
Product ID associated to the purchase.
+ - receiptID: string
ReceiptId that represents the Amazon purchase.
+ - amazonUserID: string
Amazon's userID. This parameter will be ignored when syncing a Google purchase.
+ OptionalisoCurrencyCode: null | stringProduct's currency code in ISO 4217 format.
+Optionalprice: null | numberProduct's price.
+
Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +syncing purchases.
+- productID: string
Static sync
- sync
Purchases(): 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.
+Returns Promise<void>
The promise will be rejected if configure has not been called yet or if there's an error +syncing purchases.
+Warning
This function should only be called if you're not calling purchaseProduct/purchaseStoreProduct/purchasePackage/purchaseSubscriptionOption.
+
Generated using TypeDoc
Enumeration BILLING_FEATURE
Enum for billing features. +Currently, these are only relevant for Google Play Android users: +https://developer.android.com/reference/com/android/billingclient/api/BillingClient.FeatureType
+ Index
Enumeration Members
Enumeration Members
IN_
Purchase/query for in-app items on VR.
+PRICE_
Launch a price change confirmation flow.
+SUBSCRIPTIONS
Purchase/query for subscriptions.
+SUBSCRIPTIONS_
Purchase/query for subscriptions on VR.
+SUBSCRIPTIONS_
Subscriptions update/replace.
+Generated using TypeDoc
Enumeration INTRO_ELIGIBILITY_STATUS
Enumeration Members
INTRO_
The user is eligible for a free trial or intro pricing for this product.
+INTRO_
The user is not eligible for a free trial or intro pricing for this product.
+INTRO_
There is no free trial or intro pricing for this product.
+INTRO_
RevenueCat doesn't have enough information to determine eligibility.
+Generated using TypeDoc
Generated using TypeDoc
Enumeration OFFER_PAYMENT_MODE
Payment mode for offer pricing phases. Google Play only.
+ Index
Enumeration Members
Enumeration Members
DISCOUNTED_
Subscribers pay a discounted amount for a specified number of periods
+FREE_
Subscribers don't pay until the specified period ends
+SINGLE_
Subscribers pay up front for a specified period
+Generated using TypeDoc
Enumeration PACKAGE_TYPE
Enumeration Members
ANNUAL
A package configured with the predefined annual identifier.
+CUSTOM
A package that was defined with a custom identifier.
+LIFETIME
A package configured with the predefined lifetime identifier.
+MONTHLY
A package configured with the predefined monthly identifier.
+SIX_
A package configured with the predefined six month identifier.
+THREE_
A package configured with the predefined three month identifier.
+TWO_
A package configured with the predefined two month identifier.
+UNKNOWN
A package that was defined with a custom identifier.
+WEEKLY
A package configured with the predefined weekly identifier.
+Generated using TypeDoc
Generated using TypeDoc
Enumeration PRODUCT_CATEGORY
Index
Enumeration Members
Enumeration Members
NON_
A type of product for non-subscription.
+SUBSCRIPTION
A type of product for subscriptions.
+UNKNOWN
A type of product for unknowns.
+Generated using TypeDoc
Enumeration PRODUCT_TYPE
Index
Enumeration Members
Enumeration Members
AUTO_
An auto-renewable subscription.
+CONSUMABLE
A consumable in-app purchase.
+NON_
A non-consumable in-app purchase. Only applies to Apple Store products.
+NON_
A non-renewing subscription. Only applies to Apple Store products.
+PREPAID_
A subscription that is pre-paid. Only applies to Google Play products.
+UNKNOWN
Unable to determine product type.
+Generated using TypeDoc
Enumeration PRORATION_MODE
Enumeration Members
IMMEDIATE_
Replacement takes effect immediately, and the user is charged full price +of new plan and is given a full billing cycle of subscription, +plus remaining prorated time from the old plan.
+IMMEDIATE_
Replacement takes effect immediately, and the billing cycle remains the +same. The price for the remaining period will be charged. This option is +only available for subscription upgrade.
+IMMEDIATE_
Replacement takes effect immediately, and the new price will be charged on +next recurrence time. The billing cycle stays the same.
+IMMEDIATE_
Replacement takes effect immediately, and the remaining time will be +prorated and credited to the user. This is the current default behavior.
+UNKNOWN_
Generated using TypeDoc
Enumeration PURCHASES_ERROR_CODE
Index
Enumeration Members
Enumeration Members
API_
BEGIN_
CONFIGURATION_
CUSTOMER_
EMPTY_
INELIGIBLE_
INSUFFICIENT_
INVALID_
INVALID_
INVALID_
INVALID_
INVALID_
INVALID_
LOG_
MISSING_
NETWORK_
OFFLINE_
OPERATION_
PAYMENT_
PRODUCT_
PRODUCT_
PRODUCT_
PRODUCT_
PRODUCT_
PURCHASE_
PURCHASE_
PURCHASE_
RECEIPT_
RECEIPT_
STORE_
SYSTEM_
UNEXPECTED_
UNKNOWN_
UNKNOWN_
UNSUPPORTED_
Generated using TypeDoc
Generated using TypeDoc
Enumeration RECURRENCE_MODE
Recurrence mode for a pricing phase
+ Index
Enumeration Members
Enumeration Members
FINITE_
Pricing phase repeats for a fixed number of billing periods
+INFINITE_
Pricing phase repeats infinitely until cancellation
+NON_
Pricing phase does not repeat
+Generated using TypeDoc
Generated using TypeDoc
react-native-purchases - v7.26.1
😻 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.
+React Native Purchases
React Native Purchases 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 React Native easy.
Migrating from React-Native Purchases v4 to v5
-
+
- See our Migration guide +
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 and SDK reference 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.
+Or view our React Native sample app:
+-
+
- MagicWeather +
Requirements
The minimum React Native version this SDK requires is 0.64.
SDK Reference
Our full SDK reference can be found here.
++
Installation
ExpoKit projects of version 33 or higher can successfully use react-native-purchases. If you haven't upgraded, you can follow the instructions here to upgrade.
+++❗️ If you're planning on ejecting from Expo, upgrade your expo version first, THEN eject. It'll save you a whole lot of hassle. ❗️
+
1. Add the library to the project
$ npm install react-native-purchases --save
+or
+$ yarn add react-native-purchases
+2. Link library to the project
$ react-native link react-native-purchases
+Additional iOS Setup
If your project uses Cocoapods
If your project already uses Cocoapods to install iOS dependencies, common in ExpoKit projects, linking the library should have added it to the podfile. If it hasn't, add the following to your project's podfile to reference the library from your node_modules folder:
+pod 'RNPurchases', :path => '../node_modules/react-native-purchases'
:inhibit_warnings => true
+In your ios folder, run pod install. If you've just upgraded ExpoKit, you might need to upgrade cocoapods to the newest version: sudo gem install cocoapods.
Migrating from manual installation (if your project doesn't use CocoapodsCreate)
Remove the Framework Reference from your project
-
+
- Remove
Purchases.frameworkandPurchasesHybridCommon.frameworkfrom the libraries section of the project.
+
Remove iOS Frameworks to Embedded Binaries
-
+
- In Xcode, in project manager, select your app target. +
- Select the general tab +
- Look for
Purchases.frameworkandPurchasesHybridCommon.frameworkin the Embedded Binaries section and remove them.
+
Remove $(PROJECT_DIR)/../node_modules/react-native-purchases/ios from Framework Search paths in build settings
Remove Strip Frameworks Phase
During the old manual installation instructions, now deprecated, we indicated to add a build phase to strip fat frameworks.
+-
+
- In Xcode, in project manager, select your app target. +
- Open the
Build Phasestab
+ - Remove the added
Strip Frameworksphase
+ - Clean
Derived Data
+
Link static library
The react-native link command should have added the libRNPurchases.a library to the Linked Frameworks and Libraries section of your app target. If it hasn't add it like this:
Generated using TypeDoc
Interface CustomerInfo
activeSubscriptions: string[];
allExpirationDates: {
[key: string]: string | null;
};
allPurchaseDates: {
[key: string]: string | null;
};
allPurchasedProductIdentifiers: string[];
entitlements: PurchasesEntitlementInfos;
firstSeen: string;
latestExpirationDate: null | string;
managementURL: null | string;
nonSubscriptionTransactions: PurchasesStoreTransaction[];
originalAppUserId: string;
originalApplicationVersion: null | string;
originalPurchaseDate: null | string;
requestDate: string;
}
Properties
Readonly active
Set of active subscription skus
+Readonly all
[key: string]: string | null;
}
Map of skus to expiration dates
+Type declaration
[key: string]: string | null
Readonly all
[key: string]: string | null;
}
Map of skus to purchase dates
+Type declaration
[key: string]: string | null
Readonly all
Set of purchased skus, active and inactive
+Readonly entitlements
Entitlements attached to this customer info
+Readonly first
The date this user was first seen in RevenueCat.
+Readonly latest
The latest expiration date of all purchased skus
+Readonly managementURL
URL to manage the active subscription of the user. If this user has an active iOS +subscription, this will point to the App Store, if the user has an active Play Store subscription +it will point there. If there are no active subscriptions it will be null. +If there are multiple for different platforms, it will point to the device store.
+Readonly non
Readonly original
The original App User Id recorded for this user.
+Readonly original
Returns the version number for the version of the application when the +user bought the app. Use this for grandfathering users when migrating +to subscriptions.
+This corresponds to the value of CFBundleVersion (in iOS) in the +Info.plist file when the purchase was originally made. This is always null +in Android
+Readonly original
Returns the purchase date for the version of the application when the user bought the app. +Use this for grandfathering users when migrating to subscriptions.
+Readonly request
Date when this info was requested
+Generated using TypeDoc
Generated using TypeDoc
Interface GoogleProductChangeInfo
Holds the information used when upgrading from another sku. For Android use only.
+ Index
Properties
Properties
Readonly old
The old product identifier to upgrade from.
+Optional Readonly proration
The [PRORATION_MODE] to use when upgrading the given oldSKU.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface Period
Contains all the details associated with a Period
+Properties
Readonly iso8601
Specified in ISO 8601 format. For example, P1W equates to one week, +P1M equates to one month, P3M equates to three months, P6M equates to six months, +and P1Y equates to one year
+Readonly unit
The number of period units: day, week, month, year, unknown
+Readonly value
The increment of time that a subscription period is specified in
+Generated using TypeDoc
Interface PresentedOfferingContext
Contains data about the context in which an offering was presented.
+offeringIdentifier: string;
placementIdentifier: null | string;
targetingContext: null | PresentedOfferingTargetingContext;
}
Index
Properties
Properties
Readonly offering
The identifier of the offering used to obtain this object.
+Readonly placement
The identifier of the placement used to obtain this object.
+Readonly targeting
The revision of the targeting used to obtain this object.
+Generated using TypeDoc
Interface PresentedOfferingTargetingContext
Contains data about the context in which an offering was presented.
+Properties
Readonly revision
The revision of the targeting used to obtain this object.
+Readonly rule
The rule id from the targeting used to obtain this object.
+Generated using TypeDoc
Interface Price
Contains all the details associated with a Price
+ Index
Properties
Properties
Readonly amount
Price in micro-units, where 1,000,000 micro-units equal one unit of the currency.
+For example, if price is "€7.99", price_amount_micros is 7,990,000. This value represents +the localized, rounded price for a particular currency.
+Readonly currency
Returns ISO 4217 currency code for price and original price.
+For example, if price is specified in British pounds sterling, price_currency_code is "GBP". +If currency code cannot be determined, currency symbol is returned.
+Readonly formatted
Formatted price of the item, including its currency sign. For example $3.00
+Generated using TypeDoc
Interface PricingPhase
Contains all the details associated with a PricingPhase
+billingCycleCount: null | number;
billingPeriod: Period;
offerPaymentMode: null | OFFER_PAYMENT_MODE;
price: Price;
recurrenceMode: null | RECURRENCE_MODE;
}
Index
Properties
Properties
Readonly billing
Number of cycles for which the pricing phase applies. +Null for infiniteRecurring or finiteRecurring recurrence modes.
+Readonly billing
Billing period for which the PricingPhase applies
+Readonly offer
Indicates how the pricing phase is charged for finiteRecurring pricing phases
+Readonly price
Price of the PricingPhase
+Readonly recurrence
Recurrence mode of the PricingPhase
+Generated using TypeDoc
Interface PurchasesConfiguration
Holds parameters to initialize the SDK.
+apiKey: string;
appUserID?: null | string;
entitlementVerificationMode?: ENTITLEMENT_VERIFICATION_MODE;
observerMode?: boolean;
shouldShowInAppMessagesAutomatically?: boolean;
useAmazon?: boolean;
userDefaultsSuiteName?: string;
usesStoreKit2IfAvailable?: boolean;
}
Properties
api
RevenueCat API Key. Needs to be a string
+Optional app
A unique id for identifying the user
+Optional entitlement
Verification strictness levels for [EntitlementInfo]. +See https://rev.cat/trusted-entitlements for more info.
+Optional observer
An optional boolean. Set this to TRUE if you have your own IAP implementation and +want to use only RevenueCat's backend. Default is FALSE. If you are on Android and setting this to ON, you will have +to acknowledge the purchases yourself.
+Optional should
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
+Optional use
An optional boolean. Android only. Required to configure the plugin to be used in the Amazon Appstore.
+Optional user
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.
+Optional uses
iOS-only, will be ignored for Android. +Set this to TRUE to enable StoreKit2. +Default is FALSE.
+Deprecated
RevenueCat currently uses StoreKit 1 for purchases, as its stability in production scenarios has +proven to be more performant than StoreKit 2. +We're collecting more data on the best approach, but StoreKit 1 vs StoreKit 2 is an implementation detail +that you shouldn't need to care about. +We recommend not using this parameter, letting RevenueCat decide for you which StoreKit implementation to use.
+Generated using TypeDoc
Interface PurchasesEntitlementInfo
The EntitlementInfo object gives you access to all of the information about the status of a user entitlement.
+billingIssueDetectedAt: null | string;
billingIssueDetectedAtMillis: null | number;
expirationDate: null | string;
expirationDateMillis: null | number;
identifier: string;
isActive: boolean;
isSandbox: boolean;
latestPurchaseDate: string;
latestPurchaseDateMillis: number;
originalPurchaseDate: string;
originalPurchaseDateMillis: number;
ownershipType: "FAMILY_SHARED" | "PURCHASED" | "UNKNOWN";
periodType: string;
productIdentifier: string;
productPlanIdentifier: null | string;
store: "PLAY_STORE" | "APP_STORE" | "STRIPE" | "MAC_APP_STORE" | "PROMOTIONAL" | "AMAZON" | "RC_BILLING" | "UNKNOWN_STORE";
unsubscribeDetectedAt: null | string;
unsubscribeDetectedAtMillis: null | number;
verification: VERIFICATION_RESULT;
willRenew: boolean;
}
Index
Properties
Properties
Readonly billing
The date a billing issue was detected in ISO8601 format. Can be null if there is no billing issue or an
+issue has been resolved
@note: Entitlement may still be active even if there is a billing issue. Check the isActive property.
Readonly billing
The date a billing issue was detected in milliseconds. Can be null if there is no billing issue or an
+issue has been resolved
@note: Entitlement may still be active even if there is a billing issue. Check the isActive property.
Readonly expiration
The expiration date for the entitlement in ISO8601, can be null for lifetime access.
+If the periodType is trial, this is the trial expiration date.
Readonly expiration
The expiration date for the entitlement in milliseconds, can be null for lifetime access.
+If the periodType is trial, this is the trial expiration date.
Readonly identifier
The entitlement identifier configured in the RevenueCat dashboard
+Readonly is
True if the user has access to this entitlement
+Readonly is
False if this entitlement is unlocked via a production purchase
+Readonly latest
The latest purchase or renewal date for the entitlement in ISO8601 format.
+Readonly latest
The latest purchase or renewal date for the entitlement in milliseconds.
+Readonly original
The first date this entitlement was purchased in ISO8601 format.
+Readonly original
The first date this entitlement was purchased in milliseconds.
+Readonly ownership
Supported ownership types for an entitlement. +PURCHASED if the purchase was made directly by this user. +FAMILY_SHARED if the purchase has been shared to this user by a family member. +UNKNOWN if the purchase has no or an unknown ownership type.
+Readonly period
The last period type this entitlement was in. Either: NORMAL, INTRO, TRIAL.
+Readonly product
The product identifier that unlocked this entitlement
+Readonly product
The product plan identifier that unlocked this entitlement. Android subscriptions only, null on consumables and iOS.
+Readonly store
The store where this entitlement was unlocked from.
+Readonly unsubscribe
The date an unsubscribe was detected in ISO8601 format. Can be null.
@note: Entitlement may still be active even if user has unsubscribed. Check the isActive property.
Readonly unsubscribe
The date an unsubscribe was detected in milliseconds. Can be null.
@note: Entitlement may still be active even if user has unsubscribed. Check the isActive property.
Readonly verification
If entitlement verification was enabled, the result of that verification. If not, VerificationResult.NOT_REQUESTED
+Readonly will
True if the underlying subscription is set to renew at the end of the billing period (expirationDate).
+Generated using TypeDoc
Interface PurchasesEntitlementInfos
Contains all the entitlements associated to the user.
+active: {
[key: string]: PurchasesEntitlementInfo;
};
all: {
[key: string]: PurchasesEntitlementInfo;
};
verification: VERIFICATION_RESULT;
}
Index
Properties
Properties
Readonly active
Map of active EntitlementInfo (PurchasesEntitlementInfo) objects keyed by entitlement identifier.
Type declaration
[key: string]: PurchasesEntitlementInfo
Readonly all
Map of all EntitlementInfo (PurchasesEntitlementInfo) objects (active and inactive) keyed by entitlement identifier.
Type declaration
[key: string]: PurchasesEntitlementInfo
Readonly verification
If entitlement verification was enabled, the result of that verification. If not, VerificationResult.NOT_REQUESTED
+Generated using TypeDoc
Interface PurchasesError
code: PURCHASES_ERROR_CODE;
message: string;
readableErrorCode: string;
underlyingErrorMessage: string;
userCancelled: null | boolean;
userInfo: ErrorInfo;
}
Index
Properties
Properties
code
message
readable
underlying
user
user
Generated using TypeDoc
Interface PurchasesIntroPrice
cycles: number;
period: string;
periodNumberOfUnits: number;
periodUnit: string;
price: number;
priceString: string;
}
Index
Properties
Properties
Readonly cycles
Number of subscription billing periods for which the user will be given the discount, such as 3.
+Readonly period
Billing period of the discount, specified in ISO 8601 format.
+Readonly period
Number of units for the billing period of the discount.
+Readonly period
Unit for the billing period of the discount, can be DAY, WEEK, MONTH or YEAR.
+Readonly price
Price in the local currency.
+Readonly price
Formatted price, including its currency sign, such as €3.99.
+Generated using TypeDoc
Interface PurchasesOffering
An offering is a collection of Packages (PurchasesPackage) available for the user to purchase.
+For more info see https://docs.revenuecat.com/docs/entitlements
annual: null | PurchasesPackage;
availablePackages: PurchasesPackage[];
identifier: string;
lifetime: null | PurchasesPackage;
metadata: {
[key: string]: unknown;
};
monthly: null | PurchasesPackage;
serverDescription: string;
sixMonth: null | PurchasesPackage;
threeMonth: null | PurchasesPackage;
twoMonth: null | PurchasesPackage;
weekly: null | PurchasesPackage;
}
Index
Properties
Properties
Readonly annual
Annual package type configured in the RevenueCat dashboard, if available.
+Readonly available
Array of Package objects available for purchase.
Readonly identifier
Unique identifier defined in RevenueCat dashboard.
+Readonly lifetime
Lifetime package type configured in the RevenueCat dashboard, if available.
+Readonly metadata
[key: string]: unknown;
}
Offering metadata defined in RevenueCat dashboard. To access values, you need +to check the type beforehand. For example: +const my_unknown_value: unknown = offering.metadata['my_key']; +const my_string_value: string | undefined = typeof(my_unknown_value) === 'string' ? my_unknown_value : undefined;
+Type declaration
[key: string]: unknown
Readonly monthly
Monthly package type configured in the RevenueCat dashboard, if available.
+Readonly server
Offering description defined in RevenueCat dashboard.
+Readonly six
Six month package type configured in the RevenueCat dashboard, if available.
+Readonly three
Three month package type configured in the RevenueCat dashboard, if available.
+Readonly two
Two month package type configured in the RevenueCat dashboard, if available.
+Readonly weekly
Weekly package type configured in the RevenueCat dashboard, if available.
+Generated using TypeDoc
Interface PurchasesOfferings
Contains all the offerings configured in RevenueCat dashboard. +For more info see https://docs.revenuecat.com/docs/entitlements
+all: {
[key: string]: PurchasesOffering;
};
current: null | PurchasesOffering;
}
Properties
Readonly all
Map of all Offerings [PurchasesOffering] objects keyed by their identifier.
+Type declaration
[key: string]: PurchasesOffering
Readonly current
Current offering configured in the RevenueCat dashboard.
+Generated using TypeDoc
Interface PurchasesPackage
Contains information about the product available for the user to purchase. +For more info see https://docs.revenuecat.com/docs/entitlements
+identifier: string;
offeringIdentifier: string;
packageType: PACKAGE_TYPE;
presentedOfferingContext: PresentedOfferingContext;
product: PurchasesStoreProduct;
}
Index
Properties
Properties
Readonly identifier
Unique identifier for this package. Can be one a predefined package type or a custom one.
+Readonly offering
Offering this package belongs to. +@deprecated, use presentedOfferingContext
+Readonly package
Package type for the product. Will be one of [PACKAGE_TYPE].
+Readonly presented
Offering context this package belongs to. +Null if not using offerings or if fetched directly from store via getProducts.
+Readonly product
Product assigned to this package.
+Generated using TypeDoc
Interface PurchasesPromotionalOffer
identifier: string;
keyIdentifier: string;
nonce: string;
signature: string;
timestamp: number;
}
Index
Properties
Properties
Readonly identifier
Readonly key
Readonly nonce
Readonly signature
Readonly timestamp
Generated using TypeDoc
Interface PurchasesStoreProduct
currencyCode: string;
defaultOption: null | SubscriptionOption;
description: string;
discounts: null | PurchasesStoreProductDiscount[];
identifier: string;
introPrice: null | PurchasesIntroPrice;
presentedOfferingContext: null | PresentedOfferingContext;
presentedOfferingIdentifier: null | string;
price: number;
priceString: string;
productCategory: null | PRODUCT_CATEGORY;
productType: PRODUCT_TYPE;
subscriptionOptions: null | SubscriptionOption[];
subscriptionPeriod: null | string;
title: string;
}
Properties
Readonly currency
Currency code for price and original price. +Contains the currency code value of defaultOption for Google Play.
+Readonly default
Default subscription option for a product. Google Play only.
+Readonly description
Description of the product.
+Readonly discounts
Collection of discount offers for a product. Null for Android.
+Readonly identifier
Product Id.
+Readonly intro
Introductory price.
+Readonly presented
Offering context this package belongs to. +Null if not using offerings or if fetched directly from store via getProducts.
+Readonly presented
Offering identifier the store product was presented from. +Null if not using offerings or if fetched directly from store via getProducts. +@deprecated, use presentedOfferingContext
+Readonly price
Price of the product in the local currency. +Contains the price value of defaultOption for Google Play.
+Readonly price
Formatted price of the item, including its currency sign. +Contains the formatted price value of defaultOption for Google Play.
+Readonly product
Product category.
+Readonly product
The specific type of subscription or one time purchase this product represents. +Important: In iOS, if using StoreKit 1, we cannot determine the type.
+Readonly subscription
Collection of subscription options for a product. Google Play only.
+Readonly subscription
Subscription period, specified in ISO 8601 format. For example, +P1W equates to one week, P1M equates to one month, +P3M equates to three months, P6M equates to six months, +and P1Y equates to one year. +Note: Not available for Amazon.
+Readonly title
Title of the product.
+Generated using TypeDoc
Interface PurchasesStoreProductDiscount
cycles: number;
identifier: string;
period: string;
periodNumberOfUnits: number;
periodUnit: string;
price: number;
priceString: string;
}
Index
Properties
Properties
Readonly cycles
Number of subscription billing periods for which the user will be given the discount, such as 3.
+Readonly identifier
Identifier of the discount.
+Readonly period
Billing period of the discount, specified in ISO 8601 format.
+Readonly period
Number of units for the billing period of the discount.
+Readonly period
Unit for the billing period of the discount, can be DAY, WEEK, MONTH or YEAR.
+Readonly price
Price in the local currency.
+Readonly price
Formatted price, including its currency sign, such as €3.99.
+Generated using TypeDoc
Interface PurchasesStoreTransaction
List of all non subscription transactions. Use this to fetch the history of +non-subscription purchases
+productIdentifier: string;
purchaseDate: string;
transactionIdentifier: string;
}
Index
Properties
Properties
product
Product Id associated with the transaction.
+purchase
Purchase date of the transaction in ISO 8601 format.
+transaction
Id of the transaction.
+Generated using TypeDoc
Interface SubscriptionOption
Contains all details associated with a SubscriptionOption +Used only for Google
+billingPeriod: null | Period;
freePhase: null | PricingPhase;
fullPricePhase: null | PricingPhase;
id: string;
introPhase: null | PricingPhase;
isBasePlan: boolean;
isPrepaid: boolean;
presentedOfferingContext: null | PresentedOfferingContext;
presentedOfferingIdentifier: null | string;
pricingPhases: PricingPhase[];
productId: string;
storeProductId: string;
tags: string[];
}
Index
Properties
Readonly billing
The subscription period of fullPricePhase (after free and intro trials).
+Readonly free
The free trial PricingPhase of the subscription. +Looks for the first pricing phase of the SubscriptionOption where amountMicros is 0. +There can be a freeTrialPhase and an introductoryPhase in the same SubscriptionOption.
+Readonly full
The full price PricingPhase of the subscription. +Looks for the last price phase of the SubscriptionOption.
+Readonly id
Identifier of the subscription option +If this SubscriptionOption represents a base plan, this will be the basePlanId. +If it represents an offer, it will be {basePlanId}:{offerId}
+Readonly intro
The intro trial PricingPhase of the subscription. +Looks for the first pricing phase of the SubscriptionOption where amountMicros is greater than 0. +There can be a freeTrialPhase and an introductoryPhase in the same SubscriptionOption.
+Readonly is
True if this SubscriptionOption represents a subscription base plan (rather than an offer).
+Readonly is
True if the subscription is pre-paid.
+Readonly presented
Offering context this package belongs to. +Null if not using offerings or if fetched directly from store via getProducts.
+Readonly presented
Offering identifier the subscription option was presented from +@deprecated, use presentedOfferingContext
+Readonly pricing
Pricing phases defining a user's payment plan for the product over time.
+Readonly product
Identifer of the subscription associated with this SubscriptionOption +This will be {subId}
+Readonly store
Identifier of the StoreProduct associated with this SubscriptionOption +This will be {subId}:{basePlanId}
+Readonly tags
Tags defined on the base plan or offer. Empty for Amazon.
+Generated using TypeDoc
Interface UpgradeInfo
Holds the information used when upgrading from another sku. For Android use only. +@deprecated, use GoogleProductChangeInfo
+ Index
Properties
Properties
Readonly oldSKU
The oldSKU to upgrade from.
+Optional Readonly proration
The [PRORATION_MODE] to use when upgrading the given oldSKU.
+Generated using TypeDoc
react-native-purchases - v7.26.1
Index
Enumerations
Classes
Interfaces
Type Aliases
Generated using TypeDoc
Type alias CustomerInfoUpdateListener
Listener used on updated customer info
+Type declaration
- (customerInfo): void
Parameters
- customerInfo: CustomerInfo
Object containing info for the customer
+
Returns void
- customerInfo: CustomerInfo
Generated using TypeDoc
Type alias LogHandler
Type declaration
- (logLevel, message): void
Parameters
- logLevel: LOG_LEVEL
- message: string
Returns void
Generated using TypeDoc
Type alias MakePurchaseResult
customerInfo: CustomerInfo;
productIdentifier: string;
transaction: PurchasesStoreTransaction;
}
Type declaration
customer
Info: CustomerInfo product
Identifier: string transaction: PurchasesStoreTransaction
Generated using TypeDoc
Type alias ShouldPurchasePromoProductListener
Type declaration
- (deferredPurchase): void
Parameters
- deferredPurchase: (() => Promise<MakePurchaseResult>)
- (): Promise<MakePurchaseResult>
Returns Promise<MakePurchaseResult>
Returns void
- deferredPurchase: (() => Promise<MakePurchaseResult>)
Generated using TypeDoc
Enum for billing features. +Currently, these are only relevant for Google Play Android users: +https://developer.android.com/reference/com/android/billingclient/api/BillingClient.FeatureType
+