Paywall

Customize the paywalls of your app using different products, messages, and designs, all without new app releases

A Paywall is a set of products. Paywalls allow you to dynamically change the products shown to your customers without app releases.

A list of paywalls

Paywall structure

A paywall consists of a name, a unique ID, ordered products, and optionally custom JSON payload. A paywall name is used across Adapty Dashboard.

Creating a paywall

Paywall ID

Paywall ID is unique within the app. This identifier is used in Adapty SDK and can't be edited once created. Most likely it will resemble a paywall name.

On the SDK side, it's called developerId (heard of legacy? 😎). Here is an example of using it:

Swift
Kotlin
Flutter
Swift
var paywall: PaywallModel?
Adapty.getPaywalls { (paywalls, _, error) in
paywall = paywalls?.first(where: { $0.developerId == "main" })
let product = paywall?.products.first
}
Kotlin
Adapty.getPaywalls { paywalls, _, error ->
val paywall: PaywallModel? = paywalls?.firstOrNull { it.developerId == "main" }
val product = paywall?.products?.firstOrNull()
}
Flutter
void foo() async {
try {
final GetPaywallsResult getPaywallsResult = await Adapty.getPaywalls(forceUpdate: false);
final paywall = getPaywallsResult.paywalls?.firstWhere((element) => element.developerId == 'main');
final product = paywall?.products?.first;
} on AdaptyError catch (adapryError) {} catch (e) {
print(e.toString());
}
}

In this example, we get all the paywalls, then find the one with the identifier main (it can be anything, you should use yours). Finally, we retrieve the first product from the paywall. You can then display it to your customer.

Products

Products are an ordered set of products, which will be shown to your customer.

Products within the paywall

You can add up to 5 products to a paywall. The order of the products is preserved on the SDK side, so keep it in mind when configuring a paywall. You can optionally specify an Apple promotional offer for the product.

Make sure to indicate Bundle ID for iOS and Package Name for Android in Adapty Dashboard, without them SDK can't fetch product info from stores.

Since the paywalls are configured remotely, the available products, the number of the products, and the special offers (eg free trials) can change over time. Make sure your code handles these scenarios. For example, if you get 2 products, the 2 products will be displayed, but when you get 3, all of them should be displayed without code changes.

Don't hard code product ids, you won't need them.

To use promotional offers, you have to upload Subscription Key to Adapty Dashboard, so Adapty can sign the offers.

Custom JSON payload

If you'd like to further customize your paywall, a custom JSON payload may be useful to you.

Custom JSON payload

You can enter any JSON formatted data up to 4 kB. You can access this data from SDK using customPayload or customPayloadString properties of PaywallModel , and make some adjustments to your paywall. Here are some examples of how you can use a custom payload.

Titles
Images
Fonts
Color
HTML
Soft/Hard Paywall
Translations
Titles
{
"screen_title": "Today only: Subscribe, and get 7 days for free!"
}
# Test titles or others texts
Images
{
"background_image": "https://adapty.io/media/paywalls/bg1.png"
}
# Test images on your paywall
Fonts
{
"font_family": "San Francisco",
"font_size": 16
}
# Test fonts
Color
{
"subscribe_button_color": "purple"
}
# Test colors of buttons, texts etc.
HTML
{
"photo_gallery": "https://adapty.io/media/paywalls/link-to-html-snippet.html"
}
# Any HTML code that can be displayed on the paywall
Soft/Hard Paywall
{
"hard_paywall": true
}
# By setting it to true, you disalow skipping paywall without subscribing
# You have to handle this logic in your app
Translations
{
"title": {
"en": "Try for free!",
"es": "¡Prueba gratis!",
"ru": "Попробуй бесплатно!"
}
}

You can combine different options, and make up your own. This way you can test different titles, texts, images, fonts, colors, and so on.

Versioning

Every time the products or custom JSON payload are changed, the new version of the paywall is created. This is done to collect paywall metrics separately for every meaningful change. The list of the paywalls shows the metrics for the latest (current) version of the paywall. You can view the metrics for every version of the paywall on the Paywall metrics page.

Metrics

Adapty collects plenty of metrics to help you better measure the performance of the paywalls. All metrics are updated in real-time, except for the views, which are updated once every several minutes. All metrics, except for the views, are attributed to the product within the paywall.

Paywall metrics
  • Revenue is the amount of money in USD from the purchases made directly on the paywall (renewals are not included). It's calculated before the App Store / Play Store commission. The following events affect revenue:

    • New purchases made on the paywall;

    • Trial conversions of trials that were activated on the paywall;

    • Down/up/cross-grades of the subscription on the paywall;

    • Subscription restores on the paywall (e.g. if the subscription was expired without auto-renewal).

  • The conversion rate (CR) to purchases is the number of purchases divided by the number of views. 10 purchases / 100 views = 10% CR purchases.

  • The conversion rate (CR) to trials is the number of trials started divided by the number of views. 30 trials / 100 views = 30% CR trials.

  • Purchases are the sum of the following transactions (renewals are not included):

    • New purchases made on the paywall;

    • Trial conversions of trials that were activated on the paywall;

    • Down/up/cross-grades of the subscription on the paywall;

    • Subscription restores on the paywall (e.g. if the subscription was expired without auto-renewal).

  • Trials are the number of activated trials

  • Trials cancelled are the number of trials with auto-renewal switched off. It happens when the user manually unsubscribes from the trial.

  • Views are the number of views of the paywall. If the user visits the paywall two times, this will be counted as two visits.

Make sure to send paywall views to Adapty using .logShowPaywall() method. Otherwise, paywall views will not be accounted for in the metrics and conversions will be irrelevant.

Read instructions for iOS, Android, Flutter.

You can view the paywall metrics for every version and platform (OS).

Deleting paywall

To delete the paywall, open it, click Delete paywall, and confirm the action by entering the paywall name you're about to delete.

Deleting paywall

All deleted paywalls are stored in the Inactive tab, and you can still view the metrics.

Deleting the paywall will delete it from SDK. Don't delete paywalls that are used in production, it may break your app logic. You won't be able to restore the paywall after deleting it.

Converting paywall to A/B test

When you ready to test different products or designs, you can convert an existing paywall to an A/B test. The best thing is that you don't have to change anything on the SDK side. This way, you can start using a single paywall and then add other options without having to release a new version of your app.

To convert a paywall to an A/B test, click Convert to A/B test at the right top corner of the paywall editor.

Learn more about working with A/B tests in the next section.