Skip to main content

Fetch Paywall Builder paywalls and their configuration

After you designed the visual part for your paywall with the new Paywall Builder in the Adapty Dashboard, you can display it in your mobile app. The first step in this process is to get the paywall associated with the placement and its view configuration as described below.

warning

The new Paywall Builder is available for iOS (from v3.0), Android (from v3.0), React Native (from v3.0), and Flutter (from v3.2.0) only. For presenting paywalls in Adapty SDK v2 designed with legacy Paywall Builder, see Display paywalls designed with legacy Paywall Builder.

Please be aware that this topic refers to Paywall Builder-customized paywalls. For guidance on fetching remote config paywalls, please refer to the Fetch paywalls and products for remote config paywalls in your mobile app topic.

Before you start displaying paywalls in your mobile app (click to expand)
  1. Create your products in the Adapty Dashboard.
  2. Create a paywall and incorporate the products into it in the Adapty Dashboard.
  3. Create placements and incorporate your paywall into it in the Adapty Dashboard.
  4. Install Adapty SDK in your mobile app.

Fetch paywall designed with Paywall Builder​

If you've designed a paywall using the Paywall Builder, you don't need to worry about rendering it in your mobile app code to display it to the user. Such a paywall contains both what should be shown within the paywall and how it should be shown. Nevertheless, you need to get its ID via the placement, its view configuration, and then present it in your mobile app.

To ensure optimal performance, it's crucial to retrieve the paywall and its view configuration as early as possible, allowing sufficient time for images to download before presenting them to the user.

To get a paywall, use the getPaywall method:

do {
    let paywall = try await Adapty.getPaywall("YOUR_PLACEMENT_ID")
    // the requested paywall
} catch {
    // handle the error
}

Parameters:

ParameterPresenceDescription
placementIdrequiredThe identifier of the desired Placement. This is the value you specified when creating a placement in the Adapty Dashboard.
locale

optional

default: en

The identifier of the paywall localization. This parameter is expected to be a language code composed of one or two subtags separated by the minus (-) character. The first subtag is for the language, the second one is for the region.

Example: en means English, pt-br represents the Brazilian Portuguese language.

See Localizations and locale codes for more information on locale codes and how we recommend using them.

fetchPolicydefault: .reloadRevalidatingCacheData

By default, SDK will try to load data from the server and will return cached data in case of failure. We recommend this variant because it ensures your users always get the most up-to-date data.

However, if you believe your users deal with unstable internet, consider using .returnCacheDataElseLoad to return cached data if it exists. In this scenario, users might not get the absolute latest data, but they'll experience faster loading times, no matter how patchy their internet connection is. The cache is updated regularly, so it's safe to use it during the session to avoid network requests.

Note that the cache remains intact upon restarting the app and is only cleared when the app is reinstalled or through manual cleanup.

Adapty SDK stores paywalls locally in two layers: regularly updated cache described above and fallback paywalls. We also use CDN to fetch paywalls faster and a stand-alone fallback server in case the CDN is unreachable. This system is designed to make sure you always get the latest version of your paywalls while ensuring reliability even in cases where internet connection is scarce.

loadTimeoutdefault: 5 sec

This value limits the timeout for this method. If the timeout is reached, cached data or local fallback will be returned.

Note that in rare cases this method can timeout slightly later than specified in loadTimeout, since the operation may consist of different requests under the hood.

For Android: You can create TimeInterval with extension functions (like 5.seconds, where .seconds is from import com.adapty.utils.seconds), or TimeInterval.seconds(5). To set no limitation, use TimeInterval.INFINITE.

Don't hardcode product IDs! Since paywalls are configured remotely, the available products, the number of products, and special offers (such as free trials) can change over time. Make sure your code handles these scenarios.
For example, if you initially retrieve 2 products, your app should display those 2 products. However, if you later retrieve 3 products, your app should display all 3 without requiring any code changes. The only thing you should hardcode is the placement ID.

Response parameters:

ParameterDescription
PaywallAn AdaptyPaywall object with a list of product IDs, the paywall identifier, remote config, and several other properties.

Fetch the view configuration of paywall designed using Paywall Builder​

After fetching the paywall, check if it includes a ViewConfiguration, which indicates that it was created using Paywall Builder. This will guide you on how to display the paywall. If the ViewConfiguration is present, treat it as a Paywall Builder paywall; if not, handle it as a remote config paywall.

For paywalls with a ViewConfiguration, use the getViewConfiguration method to load the view configuration. In cross-platform SDKs, you can directly call the createPaywallView method without manually fetching the view configuration first.

warning

The result of the createPaywallView method can be used only once. If you need to reuse it, call the createPaywallView method again.

import Adapty

guard paywall.hasViewConfiguration else {
    //  use your custom logic
    return
}

do {
    let paywallConfiguration = try await AdaptyUI.getPaywallConfiguration(
            forPaywall: paywall,
            products: products,
            observerModeResolver: <AdaptyObserverModeResolver>, // only for Observer Mode
            tagResolver: <AdaptyTagResolver>,
            timerResolver: <AdaptyTimerResolver>
    )
    // use loaded configuration
} catch {
    // handle the error
}
ParameterPresenceDescription
paywallrequiredAn AdaptyPaywall object to obtain a controller for the desired paywall.
loadTimeoutdefault: 5 secThis value limits the timeout for this method. If the timeout is reached, cached data or local fallback will be returned.Note that in rare cases this method can timeout slightly later than specified in loadTimeout, since the operation may consist of different requests under the hood.
productsoptionalProvide an array of AdaptyPaywallProducts to optimize the display timing of products on the screen. If nil is passed, AdaptyUI will automatically fetch the necessary products.
observerModeResolveroptionalThe AdaptyObserverModeResolver object you've implemented in the previous step
tagResolveroptionalDefine a dictionary of custom tags and their resolved values. Custom tags serve as placeholders in the paywall content, dynamically replaced with specific strings for personalized content within the paywall. Refer to Custom tags in paywall builder topic for more details.
timerResolveroptionalTo use custom timers in your mobile app, create an object that follows the AdaptyTimerResolver protocol. This object defines how each custom timer should be rendered. If you prefer, you can use a [String: Date] dictionary directly, as it already conforms to this protocol.

Set up developer-defined timers​

To use custom timers in your mobile app, create an object that follows the AdaptyTimerResolver protocol. This object defines how each custom timer should be rendered. If you prefer, you can use a [String: Date] dictionary directly, as it already conforms to this protocol. Here is an example:

@MainActor
struct AdaptyTimerResolverImpl: AdaptyTimerResolver {
    func timerEndAtDate(for timerId: String) -> Date {
        switch timerId {
        case "CUSTOM_TIMER_6H":
            Date(timeIntervalSinceNow: 3600.0 * 6.0) // 6 hours
        case "CUSTOM_TIMER_NY":
            Calendar.current.date(from: DateComponents(year: 2025, month: 1, day: 1)) ?? Date(timeIntervalSinceNow: 3600.0)
        default:
            Date(timeIntervalSinceNow: 3600.0) // 1 hour
        }
    }
}

In this example, CUSTOM_TIMER_NY and CUSTOM_TIMER_6H are the Timer IDs of developer-defined timers you set in the Adapty Dashboard. The timerResolver ensures your app dynamically updates each timer with the correct value. For example:

  • CUSTOM_TIMER_NY: The time remaining until the timer’s end, such as New Year’s Day.
  • CUSTOM_TIMER_6H: The time left in a 6-hour period that started when the user opened the paywall.
note

If you are using multiple languages, learn how to add a Paywall builder localization and how to use locale codes correctly here.

Once you have successfully loaded the paywall and its view configuration, you can proceed to presenting the paywall in your mobile app.

Speed up paywall fetching with default audience paywall​

Typically, paywalls are fetched almost instantly, so you don’t need to worry about speeding up this process. However, in cases where you have numerous audiences and paywalls, and your users have a weak internet connection, fetching a paywall may take longer than you'd like. In such situations, you might want to display a default paywall to ensure a smooth user experience rather than showing no paywall at all.

To address this, you can use the getPaywallForDefaultAudience method, which fetches the paywall of the specified placement for the All Users audience. However, it's crucial to understand that the recommended approach is to fetch the paywall by the getPaywall method, as detailed in the Fetch Paywall Information section above.

warning

Why we recommend using getPaywall

The getPaywallForDefaultAudience method comes with a few significant drawbacks:

  • Potential backward compatibility issues: If you need to show different paywalls for different app versions (current and future), you may face challenges. You’ll either have to design paywalls that support the current (legacy) version or accept that users with the current (legacy) version might encounter issues with non-rendered paywalls.
  • Loss of targeting: All users will see the same paywall designed for the All Users audience, which means you lose personalized targeting (including based on countries, marketing attribution or your own custom attributes).

If you're willing to accept these drawbacks to benefit from faster paywall fetching, use the getPaywallForDefaultAudience method as follows. Otherwise stick to getPaywall described above.

Adapty.getPaywallForDefaultAudience(placementId: "YOUR_PLACEMENT_ID", locale: "en") { result in
    switch result {
        case let .success(paywall):
            // the requested paywall
        case let .failure(error):
            // handle the error
    }
}
note

The getPaywallForDefaultAudience method is available starting from these versions:

  • iOS: 2.11.2
  • Android: 2.11.3
  • React Native: 2.11.2

The method is not yet supported in Flutter and Unity, but support will be added soon.

ParameterPresenceDescription
placementIdrequiredThe identifier of the Placement. This is the value you specified when creating a placement in your Adapty Dashboard.
locale

optional

default: en

The identifier of the paywall localization. This parameter is expected to be a language code composed of one or more subtags separated by the minus (-) character. The first subtag is for the language, the second one is for the region.

Example: en means English, pt-br represents the Brazilian Portuguese language.

See Localizations and locale codes for more information on locale codes and how we recommend using them.

fetchPolicydefault: .reloadRevalidatingCacheData

By default, SDK will try to load data from the server and will return cached data in case of failure. We recommend this variant because it ensures your users always get the most up-to-date data.

However, if you believe your users deal with unstable internet, consider using .returnCacheDataElseLoad to return cached data if it exists. In this scenario, users might not get the absolute latest data, but they'll experience faster loading times, no matter how patchy their internet connection is. The cache is updated regularly, so it's safe to use it during the session to avoid network requests.

Note that the cache remains intact upon restarting the app and is only cleared when the app is reinstalled or through manual cleanup.