GitHub

Twitter

Blog

Superwall

Sign Up

Status

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

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

Overview

Installation

iOS - Swift Package Manager

iOS - CocoaPods

Android - Gradle

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 [rules](/campaign-rules) 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(event:params:handler:feature:)`. 

Showing Paywalls

If you want complete control over the paywall presentation process, you can use `getPaywall(forEvent:params:paywallOverrides:delegate:)`. This returns the `UIViewController` subclass `PaywallViewController`, which you can then present however you like. The following is code is how you'd mimic [register](/docs/feature-gating):

Retrieving and Presenting a Paywall Yourself

SuperwallKit automatically tracks some internal events. You can [view the list of events here](/docs/tracking-analytics). We encourage you to also track them in your own analytics by implementing `didTrackSuperwallEventInfo(_:)` in your `SuperwallDelegate`:

3rd Party Analytics

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

Superwall Events

To easily view Superwall cohorts in 3rd party tools, we recommend you set user attributes based on the experiments that users are included in.

Cohorting in 3rd Party Tools

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

SuperwallKit supports Game Controller input.

Game Controller Support

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

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

Migrating from v2.x

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

Android Beta

Home Page

Superwall maintains a growing list of paywall templates for you to choose from. These designs are used by some of the biggest apps on the App Store and are perfect to get you up and running in no time.

Creating Paywalls

The settings sidebar is split into 3 sections: Products; Design; and Advanced.

Paywall Settings Sidebar

Products

Layout Tab

The interactive paywall preview shows how your paywall looks on certain iOS devices, for different configurations:

Interactive Paywall Preview

Localization

External Paywall Creation

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

Rules allow you to decide _which users_ see a paywall.

Rules

The following [Superwall Events](/docs/tracking-analytics) are automatically registered by the SDK and can be added as events in campaigns to present paywalls.

Home

SDK

SDK Reference

Dashboard

iOS