Skip to main content

Installing the SDK

RevenueCat Paywalls are included as part of the RevenueCatUI package in the RevenueCat SDK. You'll need to install the RevenueCatUI package in your project to use Paywalls.

📘Paywalls v2 Beta

These docs refer to our beta of Paywalls v2. For installation requirements of original Paywalls, click here.

Supported SDK versions​

RevenueCat SDKVersion required for Paywalls v2
purchases-ios5.16.0 and up
purchases-android8.12.2 and up
react-native-purchases8.6.1 and up
purchases-flutter8.5.0 and up
purchases-kmp1.5.1+13.18.1 and up

Platforms (support for more coming)​

  • ✅ iOS 15.0 and higher
  • ✅ Android 7.0 (API level 24) and higher
  • ❌ Mac Catalyst
  • ❌ visionOS
  • ❌ watchOS
  • ❌ macOS
  • ❌ tvOS

Native iOS Installation​

Using SPM:​

If you already have RevenueCat in your project:​

  1. Open your project settings and select "Package Dependencies":

Change version

  1. Make sure version is at least 5.16.0:

Configure version

  1. Open your target settings and find "Frameworks, Libraries, and Embedded Content":

Find frameworks in your target

  1. Add RevenueCatUI:

Add RevenueCatUI dependency

First time integrating the RevenueCat SDK:​

  1. Click File -> Add Packages...

  2. Search for git@github.com:RevenueCat/purchases-ios.git and make sure version is at least 5.16.0:

Adding purchases-ios dependency

  1. Add RevenueCat and RevenueCatUI SPM dependency to your project:

Add paywall

Using CocoaPods:​

Add the following to your Podfile:

pod 'RevenueCat'
pod 'RevenueCatUI'

Native Android Installation​

Release

  1. Add RevenueCatUI:
implementation 'com.revenuecat.purchases:purchases:<latest version>'
implementation 'com.revenuecat.purchases:purchases-ui:<latest version>'

React Native Installation​

Release

  • Update your package.json to include react-native-purchases-ui:
{
  "dependencies": {
    "react-native-purchases": "<latest version>",
    "react-native-purchases-ui": "<latest version>"
  }
}

Flutter Installation​

Release

  • Add purchases-ui-flutter in your pubspec.yaml:
dependencies:
  purchases_flutter: <latest version>
  purchases_ui_flutter: <latest version>
  • For Android, you need to change your MainActivity to subclass FlutterFragmentActivity instead of FlutterActivity.

Kotlin Multiplatform Installation​

Release

Add the following Maven coordinates to your libs.versions.toml:

[versions] 
purchases-kmp = "<latest version>"

[libraries]
purchases-core = { module = "com.revenuecat.purchases:purchases-kmp-core", version.ref = "purchases-kmp" }
purchases-ui = { module = "com.revenuecat.purchases:purchases-kmp-ui", version.ref = "purchases-kmp" }

Then add the dependencies to the commonMain sourceset in your Compose Multiplatform module's build.gradle.kts:

kotlin {
    // ...
    sourceSets {
        // ...
        commonMain.dependencies {  
            // Add the purchases-kmp dependencies.
            implementation(libs.purchases.core)  
            implementation(libs.purchases.ui)  
        }
    }
}

Lastly, you'll need to make sure you link the PurchasesHybridCommonUI native iOS framework. If your iOS app uses Swift Package Manager, add the PurchasesHybridCommonUI library to your target in the same way you added the PurchasesHybridCommon library. If your iOS app uses CocoaPods, either update its Podfile, or update your Compose Multiplatform module's build.gradle.kts, depending on how your Multiplatform module is integrated with your iOS project.