Android

Flutter

React Native

Superwall can be installed with many different package managers. Please find your preferred package manager below.

Overview

Installation (Legacy)

Superwall

Superwall gives you the ability to remotely update your purchase screen (a.k.a. paywall), without shipping app updates. Changing things like pricing, design, location, text and discounts takes a few seconds from Superwall's dashboard.

Welcome

Use a Superwall delegate to help interface with 3rd party analytics, see which product was purchased on a paywall, handle custom placements and more.

Using the Superwall Delegate

It's important to tell Superwall when a deep link has been opened. This enables two things:

Deep Links and In-App Previews

You can set the click behavior of any element on a paywall to be a custom paywall action. This allows you to tie any tap in your paywall to hard-coded application logic.

Custom Paywall Actions

Use Observer mode to report purchases made outside of Superwall so they'll appear in your dashboard. Available for iOS and Android.

Observer Mode

If you wish to purchase products directly on iOS and Android, use our SDK's `purchase` methods.

Purchasing Products Outside of a Paywall

SuperwallKit supports Game Controller input.

Game Controller Support

(iOS only) When submitting your app for review, you'll need to fill out an App Store Privacy label. When using the Superwall SDK, there are a few choices you may need to consider.

App Store Privacy Labels

(iOS only) StoreKit testing in Xcode is a local test environment for testing in-app purchases without requiring a connection to App Store servers. Set up in-app purchases in a local StoreKit configuration file in your Xcode project, or create a synced StoreKit configuration file in Xcode from your in-app purchase settings in App Store Connect. After you enable the configuration file, the test environment uses this local data on your paywalls when your app calls StoreKit APIs.

Setting up StoreKit testing

Troubleshooting

Ready to ship your app with Superwall? Here is a last minute checklist to give you confidence that you're ready to ship without issue.

Pre-Launch Checklist

Superwall's recent SDK updates bring several new improvements and features. Here's how to get started quickly.

Using New SDK Features

Creating a Countdown Timer

Building Mult-Tier Paywalls

Managing Connectivity Issues

Learn how to present a unique paywall based on the audience that was matched within a campaign.

Showing Unique Paywalls

Learn how to present a a paywall when a user starts to convert, but then cancels the transaction.

Abandoned Transaction Paywalls

Learn how to present a paywall the moment users interact with your app.

First Touch Paywalls

Learn how to toggle feature gating in a paywall.

Feature Gating

Custom Actions

SuperwallKit 4.0 is a major release of Superwall's iOS SDK. This introduces breaking changes.

Migrating from v3 to v4 - iOS

SuperwallKit 3.0 is a major release of Superwall's iOS SDK, previously known as `Paywall`. This introduces breaking changes.

Migrating from v2 to v3 - iOS

SuperwallKit 2.0 is a major release of Superwall's Android SDK. This introduces breaking changes.

Migrating from v1 to v2 - Android

SuperwallKit 2.0 is a major release of Superwall's Flutter SDK. This introduces breaking changes.

Migrating from v1 to v2 - Flutter

SuperwallKit 2.0 is a major release of Superwall's React Native SDK. This introduces breaking changes.

Migrating from v1 to v2 - React Native

The long-awaited Superwall for Android is now available! Here's how to get started!

Superwall's Flutter SDK is now available — we can't wait for you to try it!

The long-awaited Superwall for React Native is now available! Here's how to get started!

The Overview page gives you a holistic look at how your app is performing, complete with easy-to-find key metrics and top-level campaign data.

Create or edit paywalls across all of your campaigns in one place.

Paywalls

Use our template library to jump-start your paywall design process. Either plug in your products, switch them up to fit your needs, or remix them altogether.

Templates

View charts detailing important metrics about your app's subscription performance, paywalls and more.

Charts

Adding Products

Adding a paywall exit or post-purchase survey is a great way to boost conversion and get feedback on why users declined or purchased from your paywall. Once you've configured a survey, it can be attached to multiple paywalls. A user will only ever see a specific survey once unless you reset its responses.

Surveys

Get a snapshot view of users who recently triggered a placement in your app.

Users

Managing Localization Updates

Creating Applications

GitHub

Twitter

Blog

Sign Up

Status

Installation

Install the Superwall iOS SDK via Swift Package Manager. To see the latest release, [check out the repository](https://github.com/superwall/Superwall-iOS).

iOS - Swift Package Manager

Install the Superwall iOS SDK via CocoaPods. To see the latest release, [check out the repository](https://github.com/superwall/Superwall-iOS).

iOS - CocoaPods

Install the Superwall Android SDK via Gradle. To see the latest release, [check out the repository](https://github.com/superwall/Superwall-Android).

Android - Gradle

Install the Superwall Flutter SDK via pub package manager. To see the latest release, [check out the repository](https://github.com/superwall/Superwall-Flutter).

Flutter - pubspec.yaml

Install the Superwall React Native SDK via npm or yarn. To see the latest release, [check out the repository](https://github.com/superwall/react-native-superwall).

React Native - Package.json

As soon as your app launches, you need to configure the SDK with your **Public API Key**. You'll retrieve this from the Superwall settings page.

Configuring the SDK

Purchases and Subscription Status

If you want to use RevenueCat to handle your subscription-related logic with Superwall, follow this guide.

Using RevenueCat

When configuring the SDK you can pass in options that configure Superwall, the paywall presentation, and its appearance.

Passing in options

It is necessary to uniquely identify users to track their journey within Superwall.

User Management

By setting user attributes, you can display information about the user on the paywall. You can also define [audiences](/campaigns-audience) in a campaign to determine which paywall to show to a user, based on their user attributes.

Setting User Attributes

At the heart of Superwall's SDK lies `Superwall.shared.register(placement:params:handler:feature:)`. 

Showing Paywalls

Use this technique to get an instance of a paywall manually, using either UIKit, SwiftUI, or Jetpack Compose.

Retrieving and Presenting a Paywall Yourself

Learn how to present a different paywall from one that's already presented.

Presenting Paywalls from One Another

Superwall can easily be integrated with 3rd party analytics tools.

3rd Party Analytics

The SDK automatically tracks some placements, which power the charts in the dashboard. 

Superwall Placements

To easily view Superwall cohorts in 3rd party tools, we recommend you set user attributes based on the experiments that users are included in. You can also use custom placements for creating analytics events for actions such as interacting with an element on a paywall.

Cohorting in 3rd Party Tools

Use a Superwall delegate to help interface with 3rd party analytics, see which product was purchased on a paywall, handle custom events and more.

Using the Superwall Delegate (Legacy)

Deep Links and In-App Previews (Legacy)

Custom Paywall Actions (Legacy)

Troubleshooting (Legacy)

Pre-Launch Checklist (Legacy)

Use Superwall's best-in-class editor to bring virtually any paywall design to life, complete with advanced U.X. patterns. Or, browse our growing list of paywall templates to get started quickly.

Editor Overview

Getting Started with the Paywall Editor

Layout

Styling Elements

Stacks

Dynamic Values

Products

Theme

Variables

Liquid

Localizing Strings

Paywall Localization

Notifications

Settings

Debugger

Floating Toolbar

Publishing

Previewing

Duplicating Paywalls

Renaming Paywalls

Campaigns are logical groupings of paywalls to show when certain _events_ are registered and _conditions_ are met. They are an incredibly powerful tool for creating experiments and managing best-in-class monetization flows.

Campaigns

Campaign Structure

Placements

Standard Placements

Audiences

Starting an Experiment

Understanding Experiment Results

Paywalled Users

Use the Settings area to setup API keys, metadata and more.

General

Keys

Billing

Revenue Tracking

Refund Protection

Integrate Apple Search Ads with Superwall. View details on users acquired via search ads, visualize conversions from Apple Search Ads in charts, and create powerful campaign filters to target users using search ad data. Search ad integration requires 3.12.0 of the Superwall SDK or higher.

Home

SDK

Guides

Tips

SDK Reference

SDK Quickstart

Dashboard

Installation (Legacy)

iOS

Use Swift Package Manager

Use Cocoapods

Android

Use Gradle

Flutter

Use pubspec.yaml

React Native

Use package.json

Home

SDK

Guides

Tips

SDK Reference

SDK Quickstart

Dashboard

​iOS

Use Swift Package Manager

Use Cocoapods

​Android

Use Gradle

​Flutter

Use pubspec.yaml

​React Native

Use package.json

iOS

Android

Flutter

React Native