Framework

RevenueCat

😻 In-App Subscriptions Made Easy 😻

Overview

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 SDK Features

RevenueCat

✅

Server-side receipt validation

➡️

Webhooks - enhanced server-to-server communication with events for purchases, renewals, cancellations, and more

🖥

iOS, tvOS, macOS and watchOS support

🎯

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

Migrating from Purchases v3

When transitioning between our V3 SDK, we ported our entire SDK into Swift. Migrating from Objective-C to Swift required a number of API changes, but we feel that the changes resulted in the SDK having a more natural feel for developers. In addition, we introduced several new types and APIs.

Our RevenueCat V4 API Migration Guide provides information on how to migrate from V3 to V4.

Getting Started

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

Or browse our iOS sample apps:

Topics

Purchases

class Purchases
Purchases is the main entry point of the RevenueCat SDK. It provides access to all its features.

Configuring the SDK

static func configure(withAPIKey: String) -> Purchases
Configures an instance of the Purchases SDK with a specified API key.
static func configure(withAPIKey: String, appUserID: String?) -> Purchases
Configures an instance of the Purchases SDK with a specified API key and app user ID.
static func configure(withAPIKey: String, appUserID: String?, observerMode: Bool) -> Purchases
Configures an instance of the Purchases SDK with a custom UserDefaults.
static func configure(withAPIKey: String, appUserID: String?, observerMode: Bool, userDefaults: UserDefaults?) -> Purchases
Configures an instance of the Purchases SDK with a custom UserDefaults.

Displaying Products

class Offerings
This class contains all the offerings configured in RevenueCat dashboard. Offerings let you control which products are shown to users without requiring an app update.
class Offering
An offering is a collection of Packages, and they let you control which products are shown to users without requiring an app update.
class Package
Packages help abstract platform-specific products by grouping equivalent products across iOS, Android, and web. A package is made up of three parts: identifier, packageType, and underlying StoreProduct.
class StoreProduct
Type that provides access to all of StoreKit‘s product type’s properties.
class SubscriptionPeriod
The duration of time between subscription renewals. Use the value and the unit together to determine the subscription period. For example, if the unit is .month, and the value is 3, the subscription period is three months.
func offerings() async throws -> Offerings
Fetch the configured Offerings for this user.
func getOfferings(completion: (Offerings?, Error?) -> Void)
Fetch the configured Offerings for this user.
func products([String]) async -> [StoreProduct]
Fetches the StoreProducts for your IAPs for given productIdentifiers.
func getProducts([String], completion: ([StoreProduct]) -> Void)
Fetches the StoreProducts for your IAPs for given productIdentifiers.

Making Purchases

class StoreTransaction
Abstract class that provides access to all of StoreKit’s product type’s properties.
func purchase(package: Package) async throws -> PurchaseResultData
Initiates a purchase of a Package.
func purchase(package: Package, completion: PurchaseCompletedBlock)
Initiates a purchase of a Package.
func purchase(product: StoreProduct) async throws -> PurchaseResultData
Initiates a purchase of a StoreProduct.
func purchase(product: StoreProduct, completion: PurchaseCompletedBlock)
Initiates a purchase of a StoreProduct.

Making Purchases with Subscription Offers

class IntroEligibility
Holds the introductory price status
class PromotionalOffer
Represents a StoreProductDiscount that has been validated and is ready to be used for a purchase.
class StoreProductDiscount
Type that wraps StoreKit.Product.SubscriptionOffer and SKProductDiscount and provides access to their properties. Information about a subscription offer that you configured in App Store Connect.
func checkTrialOrIntroDiscountEligibility(productIdentifiers: [String]) async -> [String : IntroEligibility]
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). iOS Introductory Offers.
func checkTrialOrIntroDiscountEligibility(productIdentifiers: [String], completion: ([String : IntroEligibility]) -> Void)
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). iOS Introductory Offers.
func checkTrialOrIntroDiscountEligibility(product: StoreProduct) async -> IntroEligibilityStatus
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). iOS Introductory Offers.
func checkTrialOrIntroDiscountEligibility(product: StoreProduct, completion: (IntroEligibilityStatus) -> Void)
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). iOS Introductory Offers.
func getPromotionalOffer(forProductDiscount: StoreProductDiscount, product: StoreProduct) async throws -> PromotionalOffer
Use this method to find eligibility for this user for iOS Promotional Offers.
func getPromotionalOffer(forProductDiscount: StoreProductDiscount, product: StoreProduct, completion: (PromotionalOffer?, Error?) -> Void)
Use this method to fetch PromotionalOffer to use in purchase(package:promotionalOffer:) or purchase(product:promotionalOffer:). iOS Promotional Offers.
func purchase(package: Package, promotionalOffer: PromotionalOffer) async throws -> PurchaseResultData
Purchase the passed Package. Call this method when a user has decided to purchase a product with an applied discount. Only call this in direct response to user input. From here Purchases will handle the purchase with StoreKit and call the PurchaseCompletedBlock.
func purchase(package: Package, promotionalOffer: PromotionalOffer, completion: PurchaseCompletedBlock)
Purchase the passed Package. Call this method when a user has decided to purchase a product with an applied discount. Only call this in direct response to user input. From here Purchases will handle the purchase with StoreKit and call the PurchaseCompletedBlock.
func purchase(product: StoreProduct, promotionalOffer: PromotionalOffer) async throws -> PurchaseResultData
Use this function if you are not using the Offerings system to purchase a StoreProduct with an applied PromotionalOffer. If you are using the Offerings system, use purchase(package:promotionalOffer:completion:) instead.
func purchase(product: StoreProduct, promotionalOffer: PromotionalOffer, completion: PurchaseCompletedBlock)
Initiates a purchase of a StoreProduct with a PromotionalOffer.

Subscription Status

class CustomerInfo
A container for the most recent customer info returned from Purchases. These objects are non-mutable and do not update automatically.
class EntitlementInfo
The EntitlementInfo object gives you access to all of the information about the status of a user entitlement.
class EntitlementInfos
This class contains all the entitlements associated to the user.
protocol PurchasesDelegate
Delegate for Purchases responsible for handling updating your app’s state in response to updated customer info or promotional product purchases.
func getCustomerInfo(completion: (CustomerInfo?, Error?) -> Void)
Get latest available customer info.
func customerInfo() async throws -> CustomerInfo
Get latest available customer info. Returns a value immediately if CustomerInfo is cached.
var customerInfoStream: AsyncStream<CustomerInfo>
Returns an AsyncStream of CustomerInfo changes, starting from the last known value.

Identifying Users

func logIn(String) async throws -> (customerInfo: CustomerInfo, created: Bool)
This function will log in the current user with an appUserID.
func logIn(String, completion: (CustomerInfo?, Bool, Error?) -> Void)
This function will log in the current user with an appUserID.
func logOut() async throws -> CustomerInfo
Logs out the Purchases client, clearing the saved appUserID.
func logOut(completion: ((CustomerInfo?, Error?) -> Void)?)
Logs out the Purchases client, clearing the saved appUserID.

Managing Subscriptions

func syncPurchases() async throws -> CustomerInfo
This method will post all purchases associated with the current App Store account to RevenueCat and become associated with the current appUserID.
func syncPurchases(completion: ((CustomerInfo?, Error?) -> Void)?)
This method will post all purchases associated with the current App Store account to RevenueCat and become associated with the current appUserID.
func restorePurchases() async throws -> CustomerInfo
This method will post all purchases associated with the current App Store account to RevenueCat and become associated with the current appUserID. If the receipt is being used by an existing user, the current appUserID will be aliased together with the appUserID of the existing user. Going forward, either appUserID will be able to reference the same user.
func restorePurchases(completion: ((CustomerInfo?, Error?) -> Void)?)
This method will post all purchases associated with the current App Store account to RevenueCat and become associated with the current appUserID. If the receipt is being used by an existing user, the current appUserID will be aliased together with the appUserID of the existing user. Going forward, either appUserID will be able to reference the same user.
func showManageSubscriptions() async throws
Use this function to open the manage subscriptions modal.
func showManageSubscriptions(completion: (Error?) -> Void)
Use this function to open the manage subscriptions page.

Subscriber Attributes

func setAttributes([String : String])
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.
func setAd(String?)
Subscriber attribute associated with the install ad for the user
func setEmail(String?)
Subscriber attribute associated with the email address for the user.
func setDisplayName(String?)
Subscriber attribute associated with the display name for the user.
func setKeyword(String?)
Subscriber attribute associated with the install keyword for the user
func setCampaign(String?)
Subscriber attribute associated with the install campaign for the user.
func setCreative(String?)
Subscriber attribute associated with the install ad creative for the user.
func setAdGroup(String?)
Subscriber attribute associated with the install ad group for the user
func setPushToken(Data?)
Subscriber attribute associated with the push token for the user.
func setMediaSource(String?)
Subscriber attribute associated with the install media source for the user.
func setPhoneNumber(String?)
Subscriber attribute associated with the phone number for the user.
func setAttributes([String : String])
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.
func collectDeviceIdentifiers()
Automatically collect subscriber attributes associated with the device identifiers

Integrations

func setAdjustID(String?)
Subscriber attribute associated with the Adjust Id for the user. Required for the RevenueCat Adjust integration.
func setAppsflyerID(String?)
Subscriber attribute associated with the Appsflyer Id for the user. Required for the RevenueCat Appsflyer integration.
func setAirshipChannelID(String?)
Subscriber attribute associated with the Airship Channel ID for the user. Required for the RevenueCat Airship integration.
func setMparticleID(String?)
Subscriber attribute associated with the mParticle Id for the user. Recommended for the RevenueCat mParticle integration.
func setOnesignalID(String?)
Subscriber attribute associated with the OneSignal Player ID for the user. Required for the RevenueCat OneSignal integration.
func setFBAnonymousID(String?)
Subscriber attribute associated with the Facebook SDK Anonymous Id for the user. Recommended for the RevenueCat Facebook integration.

Articles

RevenueCat V4 API Migration Guide
Migrating from Objective-C to Swift required a number of API changes, but we feel that the changes resulted in the SDK having a more natural feel for developers.

Classes

class DangerousSettings
Only use a Dangerous Setting if suggested by RevenueCat support team.

Protocols

protocol RawDataContainer
A type which exposes its underlying raw data, for debugging purposes or for getting access to future data while using an older version of the SDK.

Type Aliases

typealias DeferredPromotionalPurchaseBlock
Deferred block for shouldPurchasePromoProduct(_:defermentBlock:)
typealias LogHandler
A function that can handle a log message.
typealias PurchaseCompletedBlock
Completion block for purchase(product:completion:)
typealias PurchaseResultData
Result for purchase(product:). Counterpart of PurchaseCompletedBlock for async APIs.
typealias SK1Product
TypeAlias to StoreKit 1’s Product type, called StoreKit/SKProduct
typealias SK1ProductDiscount
TypeAlias to StoreKit 1’s Discount type, called SKProductDiscount
typealias SK1Transaction
TypeAlias to StoreKit 1’s Transaction type, called StoreKit.SKPaymentTransaction
typealias SK2Product
TypeAlias to StoreKit 2’s Product type, called StoreKit.Product
typealias SK2ProductDiscount
TypeAlias to StoreKit 2’s Discount type, called StoreKit.Product.SubscriptionOffer
typealias SK2Transaction
TypeAlias to StoreKit 2’s Transaction type, called StoreKit.Transaction
typealias VerboseLogHandler
A function that can handle a log message including file and method information.

Enumerations

enum AttributionNetwork
Enum of supported attribution networks
enum ErrorCode
Error codes used by the Purchases SDK
enum IntroEligibilityStatus
Enum of different possible states for intro price eligibility status.
enum LogLevel
Enumeration of the different verbosity levels.
enum PackageType
Enumeration of all possible Package types, as configured on the package.
enum PeriodType
Enum of supported period types for an entitlement.
enum PurchaseOwnershipType
The types used to describe whether a transaction was purchased by the user, or is available to them through Family Sharing.
enum RefundRequestStatus
Status codes for refund requests.
enum Store
Enum of supported stores