Supported on: iOS SDK
1.0.61+Present a Paywall
Present a paywall by its identifier:Present by Placement
Present a paywall by placement — the SDK uses audience rules configured in the Console to determine which paywall to show:Module Access
Access the paywall module directly:Module Methods
PaywallContext
Provide context about where and why the paywall is being shown:The
placement value is included in all paywall analytics events, allowing you to measure conversion by placement in the Console.AppDNAPaywallDelegate
Implement the delegate protocol to receive paywall lifecycle callbacks. The same delegate fires for paywalls launched standalone viaAppDNA.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.
Example Implementation
Restore Purchases
The Restore button is rendered alongside the CTA section (above or below the main subscribe button, controlled by the section’srestoreText and restorePosition config in the Console). When the user taps it, the SDK runs the restore flow and fires the lifecycle:
- SDK fires
onPaywallRestoreStarted(paywallId:)immediately. - SDK calls StoreKit 2’s restore API and queries your verification endpoint for previously-purchased products.
- On success:
onPaywallRestoreCompleted(paywallId:, productIds:)fires with the list of restored product identifiers, and the SDK emits apurchase_restoredanalytics event automatically. - On failure (network error, no previous purchases, StoreKit error):
onPaywallRestoreFailed(paywallId:, error:)fires and the SDK emits apurchase_restore_failedevent.
If the SDK was configured without a billing provider,
onPaywallRestoreFailed fires immediately with BillingError.providerNotAvailable (and onPaywallRestoreStarted is not fired — the SDK never actually started). This only happens in misconfigured hosts; production apps that pass AppDNAOptions(billingProvider: .storeKit2) will never hit this branch.To restore purchases outside of a paywall, call
AppDNA.billing.restorePurchases() directly. It is async throws and returns [String] — the product IDs of the restored transactions, verified server-side. The paywall delegate returns the same product-ID list.PaywallAction
ThePaywallAction enum represents user interactions within the paywall:
Auto-Tracked Events
DismissReason
TheDismissReason 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.
The
restore_success wire value is emitted directly by the SDK after a successful restore that auto-dismisses the paywall. Use it for analytics segmentation (purchase vs restore funnels); the DismissReason enum itself stays at the 4 user-initiated cases above.Paywall Sections
Paywalls configured in the Console support the following content sections:Plan Display Styles
The plan selection section supports 12 display styles, configured in the Console. Each style controls how subscription plans are laid out and visually differentiated: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
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
Promo Code Handling
When a paywall includes aPromo input section, implement the promo code delegate method to validate codes against your backend:
Configuration in Console
Paywalls are created and managed in the AppDNA Console:- Navigate to Monetization > Paywalls.
- Create a new paywall or edit an existing one.
- Add sections (header, features, plans, CTA, social proof, guarantee).
- Link App Store products to the plan options.
- Optionally assign the paywall to an experiment for A/B testing.
- Publish the paywall to make it available via the config bundle.
Full Example
The paywall module integrates with the billing module for purchase handling. Ensure your
billingProvider is configured correctly in AppDNAOptions. See the Billing guide for details.
