Get a paywall and its values

Your app asks Xee for a paywall by its paywall ID and gets back two things: the paywall's values (headline, button text, toggles, anything you made a variable) and the products it offers. You draw the paywall yourself with those.

Before you start

1. Add your products in Xee under Products, or sync them from App Store Connect.
2. Create the paywall: Paywalls, then Create paywall. The Paywall ID (for example main) is what your app passes to the SDK, and it cannot change later.
3. Give it a version with variables and products. The easiest way is to let Claude push one from your paywall code: see Let Claude build your paywall.
4. Install the SDK and activate it.

Get the paywall

Call Xee.getPaywallVariant(paywallId:) with the paywall ID from the dashboard:

import Xee

do {
    let paywall = try await Xee.getPaywallVariant(paywallId: "main")
    // Read the values and products from `paywall`.
} catch {
    // Show the paywall with the defaults in your code.
}

The SDK keeps the last paywall it received on the device, and the copy survives app restarts. If the server cannot be reached and there is a cached copy, you get that copy. If there is none, the call throws, so keep working defaults in your code. It also throws when the paywall ID does not exist, the paywall is inactive, or it has no version yet.

Fetch policies

let paywall = try await Xee.getPaywallVariant(
    paywallId: "main",
    fetchPolicy: .returnCacheDataIfNotExpiredElseLoad(maxAge: 3600),
    loadTimeout: 3
)

What you get back

getPaywallVariant returns an XeePaywallVariant:

Read the values

The values arrive as the paywall's remote config: one JSON object whose keys are the variable keys. remoteConfig.jsonString is the raw JSON and remoteConfig.dictionary is the same thing as [String: Any].

Each variable type maps to a plain JSON value:

For a quick read, use the dictionary:

let headline = paywall.remoteConfig?.dictionary?["headline"] as? String ?? "Unlock Unlimited Shorts"
let showTrialToggle = paywall.remoteConfig?.dictionary?["show_trial_toggle"] as? Bool ?? true

For a whole paywall, decode jsonString into a Decodable struct whose properties default to the values in your code, so a missing or mistyped key falls back instead of failing:

if let json = paywall.remoteConfig?.jsonString.data(using: .utf8) {
    values = (try? JSONDecoder().decode(PaywallValues.self, from: json)) ?? PaywallValues()
}

The full PaywallValues struct, with a SwiftUI and a UIKit version, is in Let Claude build your paywall.

Get the products

Pass the paywall to Xee.getPaywallVariantProducts(paywallVariant:). It loads the products from the App Store, in the order the version lists them, with offer eligibility already worked out:

do {
    let products = try await Xee.getPaywallVariantProducts(paywallVariant: paywall)
    // Show one row or button per product.
} catch {
    // StoreKit could not load the products.
}

Each item is an XeePaywallVariantProduct. The properties you will use most:

Put it together

1. Get the paywall and decode its values; fall back to your defaults on error.
2. Get its products.
3. Show the paywall, then call Xee.logShowPaywallVariant(paywall) once it is on screen: see Log paywall views.
4. When the user taps a product, pass it to Xee.makePurchase(product:): see Make purchases.

When a test runs on the paywall, you do nothing different. The SDK puts each user in one variation and keeps them there, and the values you read already carry that arm's value for the tested variable. See A/B tests.