purchases/com.revenuecat.purchases.paywalls/PaywallData

PaywallData

@Serializable

data class PaywallData(val templateName: String, val config: PaywallData.Configuration, val assetBaseURL: URL, val revision: Int = 0, localization: Map<String, PaywallData.LocalizedConfiguration>, localizationByTier: Map<String, Map<String, PaywallData.LocalizedConfiguration>> = emptyMap(), val zeroDecimalPlaceCountries: List<String> = emptyList(), val defaultLocale: String? = null)

Represents the data required to display a paywall using the RevenueCatUI library. This data can be created and configured in the dashboard and then accessed from the Offering/paywall.

Constructors

PaywallData

constructor(templateName: String, config: PaywallData.Configuration, assetBaseURL: URL, revision: Int = 0, localization: Map<String, PaywallData.LocalizedConfiguration>, localizationByTier: Map<String, Map<String, PaywallData.LocalizedConfiguration>> = emptyMap(), zeroDecimalPlaceCountries: List<String> = emptyList(), defaultLocale: String? = null)

Types

Configuration

@Serializable

data class Configuration(val packageIds: List<String> = emptyList(), val defaultPackage: String? = null, imagesWebp: PaywallData.Configuration.Images? = null, legacyImages: PaywallData.Configuration.Images? = null, val imagesByTier: Map<String, PaywallData.Configuration.Images>? = null, val blurredBackgroundImage: Boolean = false, val displayRestorePurchases: Boolean = true, val termsOfServiceURL: URL? = null, val privacyURL: URL? = null, val colors: PaywallData.Configuration.ColorInformation, val colorsByTier: Map<String, PaywallData.Configuration.ColorInformation>? = null, val tiers: List<PaywallData.Configuration.Tier>? = null, val defaultTier: String? = null)

Generic configuration for any paywall.

LocalizedConfiguration

@Serializable

data class LocalizedConfiguration(val title: String, val subtitle: String? = null, val callToAction: String, val callToActionWithIntroOffer: String? = null, val callToActionWithMultipleIntroOffers: String? = null, val offerDetails: String? = null, val offerDetailsWithIntroOffer: String? = null, val offerDetailsWithMultipleIntroOffers: String? = null, val offerName: String? = null, val features: List<PaywallData.LocalizedConfiguration.Feature> = emptyList(), val tierName: String? = null, val offerOverrides: Map<String, PaywallData.LocalizedConfiguration.OfferOverride> = emptyMap())

Defines the necessary localized information for a paywall.