Variables
For some Paywall strings you may want to set values based on the package that’s being displayed instead of hardcoding a single value, such as when quoting a price, or describing the duration of an Introductory Offer.
To make this easier and ensure accuracy, we recommend using Variables for these values that are package-specific.
For example, to describe a trial that offers "1 week free", you should use the {{ product.offer_period_with_unit }} variable to insert 1 week to ensure the string is accurate for any product you use, even if you make changes to the product or its introductory offer in the future.
We support the following variables:
| Variable | Weekly Example | Monthly Example | 2 Month Example | 3 Month Example | 6 Month Example | Annual Example | Lifetime Example |
|---|---|---|---|---|---|---|---|
| product.price | $2.99 | $9.99 | $17.99 | $24.99 | $39.99 | $69.99 | $119.99 |
| product.price_per_period | $2.99/week | $9.99/month | $17.99/2 months | $24.99/3 months | $39.99/6 months | $69.99/year | $119.99 |
| product.price_per_period_abbreviated | $2.99/wk | $9.99/mo | $17.99/2mo | $24.99/3mo | $39.99/6mo | $69.99/yr | $119.99 |
| product.price_per_day | $0.43 | $0.33 | $0.30 | $0.28 | $0.22 | $0.19 | $119.99 |
| product.price_per_week | $2.99 | $2.50 | $2.25 | $1.92 | $1.54 | $1.35 | $119.99 |
| product.price_per_month | $11.96 | $9.99 | $9.00 | $8.33 | $6.67 | $5.83 | $119.99 |
| product.price_per_year | $155.48 | $119.88 | $107.94 | $99.96 | $79.98 | $69.99 | $119.99 |
| product.period | week | month | 2 months | 3 months | 6 months | annual | lifetime |
| product.period_abbreviated | wk | mo | 2mo | 3mo | 6mo | yr | lifetime |
| product.periodly | weekly | monthly | 2 months | 3 months | 6 months | annually | lifetime |
| product.period_in_days | 7 | 30 | 60 | 90 | 180 | 365 | nan |
| product.period_in_weeks | 1 | 4 | 8 | 13 | 13 | 52 | nan |
| product.period_in_months | 0 | 1 | 2 | 3 | 6 | 12 | nan |
| product.period_in_years | 0 | 0 | 0 | 0 | 0 | 1 | nan |
| product.period_with_unit | 1 week | 1 month | 2 months | 3 months | 6 months | 1 year | lifetime |
| product.currency_code | USD | USD | USD | USD | USD | USD | USD |
| product.currency_symbol | $ | $ | $ | $ | $ | $ | $ |
| product.offer_price | $1.99 | $1.99 | $1.99 | $1.99 | $1.99 | $1.99 | nan |
| product.offer_price_per_day | $0.07 | $0.07 | $0.07 | $0.07 | $0.07 | $0.07 | nan |
| product.offer_price_per_week | $0.50 | $0.50 | $0.50 | $0.50 | $0.50 | $0.50 | nan |
| product.offer_price_per_month | $1.99 | $1.99 | $1.99 | $1.99 | $1.99 | $1.99 | nan |
| product.offer_price_per_year | $23.88 | $23.88 | $23.88 | $23.88 | $23.88 | $23.88 | nan |
| product.offer_period | week | week | week | week | week | week | nan |
| product.offer_period_abbreviated | wk | wk | wk | wk | wk | wk | nan |
| product.offer_period_in_days | 7 | 7 | 7 | 7 | 7 | 7 | nan |
| product.offer_period_in_weeks | 1 | 1 | 1 | 1 | 1 | 1 | nan |
| product.offer_period_in_months | 0 | 0 | 0 | 0 | 0 | 0 | nan |
| product.offer_period_in_years | 0 | 0 | 0 | 0 | 0 | 0 | nan |
| product.offer_period_with_unit | 1 week | 1 week | 1 week | 1 week | 1 week | 1 week | nan |
| product.offer_end_date | December 31, 2024 | December 31, 2024 | December 31, 2024 | December 31, 2024 | December 31, 2024 | December 31, 2024 | nan |
| product.secondary_offer_price | $2.99 | $2.99 | $2.99 | $2.99 | $2.99 | $2.99 | nan |
| product.secondary_offer_period | week | week | week | week | week | week | nan |
| product.secondary_offer_period_abbreviated | wk | wk | wk | wk | wk | wk | nan |
| product.relative_discount | 19% | 19% | 19% | 19% | 19% | 19% | 19% |
| product.store_product_name | Pro Access | Pro Access | Pro Access | Pro Access | Pro Access | Pro Access | Pro Access |
The paywall preview is generated using our example values for each package listed above, and therefore will differ from the actual values for the product's you choose to present on your paywall.
To see a more accurate preview, we recommend running your application on your physical device or in the simulator, as this will present details based on the actual information for the products you're displaying on that device.
FAQs
| Question | Answer |
|---|---|
How is the product.relative_discount variable calculated? | relative_discount returns the localized discount percentage of a given package compared to the most expensive package per period that's offered on your paywall. For example, if you're displaying a monthly package that is $10/month, and a yearly package that is $80/year (or $6.67/month), the relative discount for the annual package is 67%. Because of this, we recommend only using this variable within packages that are NOT the most expensive package per period, as the most expensive package will have a null value returned, since its relative discount is null. |