Skip to main content
Supported on: Android SDK 1.0.33+
You can A/B test this paywall with no extra code — create an experiment on it in the Console and the SDK serves the assigned variant automatically. See Servable Surface Experiments.
The AppDNA paywall module lets you present server-driven paywalls configured in the AppDNA Console. Paywalls are rendered natively with Jetpack Compose and include built-in purchase handling through the billing module.

Present a Paywall

Present a paywall by its identifier:
import ai.appdna.sdk.AppDNA
import ai.appdna.sdk.paywalls.PaywallContext

AppDNA.presentPaywall(
    activity = this,
    id = "premium_paywall",
    context = PaywallContext(placement = "settings"),
    listener = paywallDelegate,
)

Present by Placement

Present a paywall by placement — the SDK uses audience rules configured in the Console to determine which paywall to show:
// Present paywall by placement (audience rules determine which paywall to show)
AppDNA.presentPaywallByPlacement(
    activity = this,
    placement = "premium_upgrade",
)
presentPaywallByPlacement is a top-level method on AppDNA (not on AppDNA.paywall).

Module Access

Access the paywall module directly:
val paywall = AppDNA.paywall

Module Methods

MethodSignatureDescription
presentpresent(activity: Activity, paywallId: String, context: PaywallContext?)Present a paywall by ID
setDelegatesetDelegate(delegate: AppDNAPaywallDelegate?)Set a delegate for paywall callbacks
The placement-routed flavor lives on the top-level AppDNA object as AppDNA.presentPaywallByPlacement(activity, placement, context).

PaywallContext

Provide context about where and why the paywall is being shown:
val context = PaywallContext(
    placement = "settings",
    experiment = "paywall_test",
    variant = "b",
)
PropertyTypeDescription
placementStringWhere the paywall is triggered (e.g., “settings”, “onboarding”, “feature_gate”)
experimentString?Experiment identifier, if showing as part of an A/B test
variantString?Variant identifier within the experiment
The placement value is included in all paywall analytics events, allowing you to measure conversion by placement in the Console.

AppDNAPaywallDelegate

Implement the delegate interface to receive paywall lifecycle callbacks. The same delegate fires for paywalls launched standalone via AppDNA.paywall.present(...) AND for paywalls launched from inside an onboarding flow (via the present_paywall step outcome) — register once with AppDNA.paywall.setDelegate(...) and handle every paywall presentation through the same handler.
interface AppDNAPaywallDelegate {
    fun onPaywallPresented(paywallId: String)
    fun onPaywallAction(paywallId: String, action: PaywallAction)
    fun onPaywallPurchaseStarted(paywallId: String, productId: String)
    fun onPaywallPurchaseCompleted(paywallId: String, productId: String, transaction: TransactionInfo)
    fun onPaywallPurchaseFailed(paywallId: String, error: Throwable)
    fun onPaywallDismissed(paywallId: String)
    fun onPromoCodeSubmit(paywallId: String, code: String, completion: (Boolean) -> Unit)
    fun onPostPurchaseDeepLink(paywallId: String, url: String)
    fun onPostPurchaseNextStep(paywallId: String)
    fun onPaywallRestoreStarted(paywallId: String)
    fun onPaywallRestoreCompleted(paywallId: String, productIds: List<String>)
    fun onPaywallRestoreFailed(paywallId: String, error: Throwable)
}

Example Implementation

class PaywallHandler : AppDNAPaywallDelegate {

    override fun onPaywallPresented(paywallId: String) {
        Log.d("Paywall", "Paywall shown: $paywallId")
    }

    override fun onPaywallAction(paywallId: String, action: PaywallAction) {
        when (action) {
            PaywallAction.CTA_TAPPED -> Log.d("Paywall", "CTA tapped")
            PaywallAction.FEATURE_SELECTED -> Log.d("Paywall", "Feature selected")
            PaywallAction.PLAN_CHANGED -> Log.d("Paywall", "Plan changed")
            PaywallAction.LINK_TAPPED -> Log.d("Paywall", "Link tapped")
            PaywallAction.CUSTOM -> Log.d("Paywall", "Custom action")
        }
    }

    override fun onPaywallPurchaseStarted(paywallId: String, productId: String) {
        Log.d("Paywall", "Purchase started: $productId")
    }

    override fun onPaywallPurchaseCompleted(
        paywallId: String,
        productId: String,
        transaction: TransactionInfo,
    ) {
        Log.d("Paywall", "Purchased $productId — txn: ${transaction.transactionId}")
        // Paywall auto-dismisses on successful purchase
    }

    override fun onPaywallPurchaseFailed(paywallId: String, error: Throwable) {
        Log.e("Paywall", "Purchase failed: ${error.message}", error)
        // Paywall stays visible so the user can retry
    }

    override fun onPaywallDismissed(paywallId: String) {
        Log.d("Paywall", "Paywall dismissed")
    }

    override fun onPaywallRestoreStarted(paywallId: String) {
        // Show a "Restoring purchases…" toast or spinner
    }

    override fun onPaywallRestoreCompleted(paywallId: String, productIds: List<String>) {
        if (productIds.isEmpty()) {
            // Tell the user there were no purchases to restore
        } else {
            // Refresh entitlements / unlock premium features
        }
    }

    override fun onPaywallRestoreFailed(paywallId: String, error: Throwable) {
        // Surface an error toast — paywall stays visible so the user can retry
    }
}

Restore Purchases

The Restore button is rendered alongside the CTA section (above or below the main subscribe button, controlled by the section’s restore_text and restore_position config in the Console). When the user taps it, the SDK runs the restore flow and fires the lifecycle:
  1. SDK fires onPaywallRestoreStarted(paywallId) immediately.
  2. SDK calls BillingClient.queryPurchasesAsync(SUBS) + queryPurchasesAsync(INAPP) and queries your verification endpoint for previously-purchased products (both subscriptions and one-time products are restorable).
  3. On success: onPaywallRestoreCompleted(paywallId, productIds) fires with the list of restored product identifiers, and the SDK emits a purchase_restored analytics event automatically.
  4. On failure (network error, no previous purchases, Play Billing error): onPaywallRestoreFailed(paywallId, error) fires and the SDK emits a purchase_restore_failed event.
The paywall stays visible after both completion and failure so the user can decide whether to purchase fresh.
For richer transaction details (status, expiry, store), call AppDNA.billing.getEntitlements() after a successful restore — it returns List<Entitlement> with the full verified state. The paywall delegate intentionally returns just product IDs to keep the callback lightweight.

PaywallAction

The PaywallAction enum represents user interactions within the paywall:
ValueDescription
CTA_TAPPEDThe main call-to-action button was tapped
FEATURE_SELECTEDA feature item was selected
PLAN_CHANGEDThe user switched between plan options
LINK_TAPPEDA link (e.g., terms, privacy policy) was tapped
CUSTOMA custom action defined in the paywall config

DismissReason

The DismissReason enum indicates how the paywall was closed. The wire-format string (sent in paywall_close analytics) is shown in the right column — same value across iOS, Android, Flutter, and React Native.
ValueWire valueDescription
PURCHASED"purchased"Dismissed after a successful purchase
RESTORE_SUCCESS"restore_success"Dismissed after a restore returned at least one product (routes onboarding to success path)
DISMISSED"dismissed"Dismissed by the user via a close button
TAPPED_OUTSIDE"tappedOutside"Dismissed by tapping outside the paywall
PROGRAMMATIC"programmatic"Dismissed programmatically by your code

Paywall Sections

Paywalls configured in the Console support the following content sections:
SectionDescription
HeaderTitle, subtitle, and optional hero image
Features listList of feature highlights with icons and descriptions
Plan selectionSelectable plan options (e.g., monthly, annual)
CTA buttonPrimary purchase button with dynamic price text
Social proofTestimonials, ratings, or user counts
GuaranteeMoney-back guarantee or free trial messaging
ImageFull-width or sized image with optional corner radius
SpacerConfigurable vertical spacing between sections
TestimonialQuote with author name, role, and optional avatar
CountdownUrgency countdown timer with configurable expiry behavior
LegalTerms of service, privacy policy, and subscription terms
DividerHorizontal separator line with optional label
Sticky footerFixed bottom bar with CTA and price summary
CardRounded card container for grouping related content
CarouselHorizontally scrollable content cards (features, reviews)
TimelineStep-by-step vertical timeline (e.g., trial-to-paid flow)
Icon gridGrid layout of icons with labels (feature highlights)
Comparison tableSide-by-side plan comparison (free vs. premium columns)
Promo inputText field for entering promotional or coupon codes
ToggleOn/off toggle for add-on options (e.g., annual billing)
Reviews carouselHorizontally scrollable user reviews with ratings

Plan Display Styles

The plan selection section supports the following display styles, configured per paywall in the Console as a lowercase plan_display_style string:
StyleDescription
vertical_stackStacked rows, each showing plan name, price, and badge. Default.
radio_listRadio-button list with plan details per row.
accordionExpandable/collapsible plan sections with full details.
horizontal_scrollHorizontally scrollable plan cards.
carousel_cards (alias carousel)Snap-paged plan cards.
pill_selectorRounded pill buttons arranged horizontally.
segmented_toggleTwo-/three-option segmented control (e.g., Monthly / Annual).
toggle_cardsCard-style toggles, one selectable card per plan.
minimal_chipsCompact chip-style plan picker with no card surround.
tiered_sliderSlider that snaps between price tiers.
feature_comparison (aliases pricing_table, comparison_table, comparison_cards, feature_matrix)Side-by-side plan comparison with checkmarked feature rows.

Card & Badge Customization

Plan cards support per-plan styling configured in the Console:
  • Badge text and color — e.g., “Best Value”, “Most Popular” with custom background
  • Card border and shadow — highlight the selected or recommended plan
  • Save percentage — automatically calculated and displayed on annual plans
  • Trial label — shows “7-day free trial” or custom trial messaging
  • Card background — solid color, gradient, or image per plan card
  • Corner radius — configurable per card

Layout Types

LayoutDescription
"stack"Vertical stack layout (sections arranged top to bottom)
"grid"Grid layout (for feature comparison or multi-plan views)
"carousel"Horizontally scrollable section layout

Rich Media in Paywalls

Paywall sections support rich media content configured in the Console:
  • Lottie animations — animated hero images, feature illustrations, or backgrounds
  • Rive animations — interactive state-machine-driven animations
  • Video — inline video in header or feature sections
  • Haptic feedback — triggered on plan selection and CTA taps
  • Particle effects — confetti or celebration effects on purchase completion
  • Per-section styling — background colors, gradients, images, borders, shadows, and corner radius
See the Rich Media guide for full details on supported formats and configuration.

Promo Code Handling

When a paywall includes a Promo input section, implement the promo code delegate method to validate codes against your backend. The completion callback is a simple (Boolean) -> Unittrue accepts the code, false rejects it (the SDK renders the in-built rejection message):
override fun onPromoCodeSubmit(
    paywallId: String,
    code: String,
    completion: (Boolean) -> Unit,
) {
    lifecycleScope.launch {
        try {
            val isValid = MyAPI.validatePromoCode(code)
            completion(isValid)
        } catch (e: Exception) {
            completion(false)
        }
    }
}

Auto-Tracked Events

The paywall module automatically tracks the following events:
EventTriggered When
paywall_viewPaywall is presented to the user
paywall_closePaywall is dismissed
purchase_startedUser initiates a purchase from the paywall
purchase_restoredA successful restore returns at least one product
purchase_restore_failedThe restore flow fails or returns no products
Purchase completion and failure events are tracked by the billing module, not the paywall module. See the Billing documentation for the full list of purchase-related events.

Configuration in Console

Paywalls are created and managed in the AppDNA Console:
  1. Navigate to Monetization > Paywalls.
  2. Create a new paywall or edit an existing one.
  3. Add sections (header, features, plans, CTA, social proof, guarantee).
  4. Link Google Play products to the plan options.
  5. Optionally assign the paywall to an experiment for A/B testing.
  6. Publish the paywall to make it available via the config bundle.
Ensure the product identifiers used in your paywall match the products configured in Google Play Console. Mismatched identifiers will cause purchase failures.

Full Example

import ai.appdna.sdk.AppDNA
import ai.appdna.sdk.paywalls.AppDNAPaywallDelegate
import ai.appdna.sdk.paywalls.PaywallAction
import ai.appdna.sdk.paywalls.PaywallContext
import ai.appdna.sdk.billing.TransactionInfo
import androidx.fragment.app.FragmentActivity

class PremiumGate(
    private val activity: FragmentActivity,
) : AppDNAPaywallDelegate {

    init {
        AppDNA.paywall.setDelegate(this)
    }

    fun showPremiumPaywall(placement: String) {
        AppDNA.presentPaywall(
            activity = activity,
            id = "premium_paywall",
            context = PaywallContext(placement = placement),
            listener = this,
        )
    }

    // MARK: AppDNAPaywallDelegate

    override fun onPaywallPresented(paywallId: String) {
        // Track additional analytics if needed
    }

    override fun onPaywallAction(paywallId: String, action: PaywallAction) {
        // Handle custom actions
    }

    override fun onPaywallPurchaseStarted(paywallId: String, productId: String) {
        // Show loading state if desired
    }

    override fun onPaywallPurchaseCompleted(
        paywallId: String,
        productId: String,
        transaction: TransactionInfo,
    ) {
        unlockPremium()
    }

    override fun onPaywallPurchaseFailed(paywallId: String, error: Throwable) {
        // Error is shown in the paywall UI automatically
    }

    override fun onPaywallDismissed(paywallId: String) {
        // User closed without purchasing
    }

    private fun unlockPremium() { /* ... */ }
}
The paywall module integrates with the billing module for purchase handling. See the Billing guide for the full purchase API.

Next Steps