Loyalty Points & Rewards Earning Tiers Redeeming Calculator Pricing FAQ Manual Start for free
Manual

All settings

This page lists all 54 settings of the plugin, in the order of the configuration. Each entry stands on its own: what it does, which section it sits in, what its default value is and what it is called technically.

You find the settings in the administration under Extensions → My extensions → Loyalty Points & Rewards → Configuration. Most apply per sales channel; a few are system-wide and marked there as a "System-wide setting" - the expiry period, the three reminder settings and the maturation batch size.

All settings at a glance

Setting Section Type Default value
Activate loyalty program General & participation Switch on
Excluded customer groups General & participation Multiple choice empty
Points earned per 1.00 spent Earning points Text field 1
Calculation basis Earning points Choice Amount actually paid
Include shipping costs Earning points Switch off
Rounding Earning points Choice Round down
Combining multiplier rules Boosters Choice Highest wins
Combining fixed-bonus rules Boosters Choice Add up
Points needed for 1.00 discount Redeeming points Text field 100
Minimum points per redemption Redeeming points Text field 100
Redemption step Redeeming points Text field 1
Maximum points per order Redeeming points Text field 0
Allow combined redemption Redeeming points Switch on
Order state that counts as completed Points release Choice Completed
Minimum age in days Points release Text field 14
Auto-reverse points on cancellation Cancellation Switch on
Order state that voids points Cancellation Choice Cancelled
Enable the tier system Loyalty tiers Switch on
Tier mode Loyalty tiers Choice Rolling - score window
Rolling lookback window in days Loyalty tiers Text field 365
Downgrade policy Loyalty tiers Choice With grace - keep tier for N days, then downgrade
Grace window in days Loyalty tiers Text field 30
Birthday bonus points Default-flow point values Text field 100
Registration bonus points Default-flow point values Text field 50
Newsletter confirmation bonus Default-flow point values Text field 30
Show points hint on product detail pages Storefront hints - product & listing Switch on
Show points hint on product listing cards Storefront hints - product & listing Switch on
Show order-wide booster notices on product detail pages Storefront hints - product & listing Switch off
Show points hint in the cart Storefront hints - cart Switch on
Show per-line points hint in the cart Storefront hints - cart Switch on
Show tier-threshold banner in the cart Storefront hints - cart Switch on
Show the loyalty account page Storefront hints - account page Switch on
Show the transaction history on the account page Storefront hints - account page Switch on
Show the tier journey on the account page Storefront hints - account page Switch on
Show goals / milestones on the account page Storefront hints - account page Switch on
Show redeemable rewards on the account page Storefront hints - account page Switch on
Show "how to earn more" on the account page Storefront hints - account page Switch on
Show the points box in the account sidebar Storefront hints - account sidebar Switch off
Storefront theme Theme Choice Ambient - restrained violet accent, calm
Loyalty programme page Theme Reference to a record empty
Points box position Cart Choice Right content, below the summary
Reward products position Cart Choice Left content, below the products
Enable points expiry Points expiry Switch on
Validity in days Points expiry Text field 365
Send reminder mail before expiry Expiry reminder Switch on
Lead time before expiry (days) Expiry reminder Text field 14
Throttle between reminders (days) Expiry reminder Text field 30
Scheduled task: release pending points (hourly) Scheduled tasks & technical Switch on
Scheduled task: expire points (daily) Scheduled tasks & technical Switch on
Scheduled task: expiry-reminder mails (daily) Scheduled tasks & technical Switch on
Scheduled task: birthday bonuses (daily) Scheduled tasks & technical Switch on
Scheduled task: re-evaluate tiers (every 5 min) Scheduled tasks & technical Switch on
Scheduled task: re-evaluate goals (daily) Scheduled tasks & technical Switch on
Maturation batch size Scheduled tasks & technical Text field 250

General & participation

What does the setting "Activate loyalty program" do?

Master switch for earning and redeeming points.

Section
General & participation
Type
Switch
Default value
on
Technical name
active

Help text in the administration:

Master switch for earning and redeeming points.

What does the setting "Excluded customer groups" do?

Customers in these groups are entirely excluded from the loyalty program.

Section
General & participation
Type
Multiple choice
Default value
empty
Technical name
excludedCustomerGroups

Help text in the administration:

Customers in these groups are entirely excluded from the loyalty program.

Earning points

What does the setting "Points earned per 1.00 spent" do?

1 point per 1 unit of the base currency (typically EUR). Orders in other currencies are converted using the live exchange rate.

Section
Earning points
Type
Text field
Default value
1
Technical name
earnRate

Help text in the administration:

1 point per 1 unit of the base currency (typically EUR). Orders in other currencies are converted using the live exchange rate.

What does the setting "Calculation basis" do?

Whether points are based on the amount actually paid or the original price.

Section
Earning points
Type
Choice
Default value
Amount actually paid
Technical name
earnBasis

The options are:

  • Amount actually paid
  • Original price (before discounts)

Help text in the administration:

Whether points are based on the amount actually paid or the original price.

What does the setting "Include shipping costs" do?

If enabled, shipping costs count towards earned points.

Section
Earning points
Type
Switch
Default value
off
Technical name
earnIncludeShipping

Help text in the administration:

If enabled, shipping costs count towards earned points.

What does the setting "Rounding" do?

How fractional point amounts are rounded.

Section
Earning points
Type
Choice
Default value
Round down
Technical name
earnRounding

The options are:

  • Round down
  • Round commercially
  • Round up

Help text in the administration:

How fractional point amounts are rounded.

Boosters

What does the setting "Combining multiplier rules" do?

How simultaneously matching multiplier boosters are combined.

Section
Boosters
Type
Choice
Default value
Highest wins
Technical name
boosterMultiplierMode

The options are:

  • Highest wins
  • Lowest wins
  • Multiply together

Help text in the administration:

How simultaneously matching multiplier boosters are combined.

What does the setting "Combining fixed-bonus rules" do?

How simultaneously matching fixed-bonus boosters are combined.

Section
Boosters
Type
Choice
Default value
Add up
Technical name
boosterFixedMode

The options are:

  • Add up
  • Highest wins
  • Lowest wins

Help text in the administration:

How simultaneously matching fixed-bonus boosters are combined.

Redeeming points

What does the setting "Points needed for 1.00 discount" do?

How many points equal a 1.00 discount in the base currency (typically EUR).

Section
Redeeming points
Type
Text field
Default value
100
Technical name
redeemConversion

Help text in the administration:

How many points equal a 1.00 discount in the base currency (typically EUR).

Carts in other currencies receive the equivalent discount converted via the live exchange rate.

What does the setting "Minimum points per redemption" do?

The smallest number of points a customer may redeem at once.

Section
Redeeming points
Type
Text field
Default value
100
Technical name
redeemMinPoints

Help text in the administration:

The smallest number of points a customer may redeem at once.

What does the setting "Redemption step" do?

Points can only be redeemed in multiples of this value. 1 lets customers redeem their exact balance (e.g. all 159 points); a higher value forces round blocks (e.g. 100 = whole-euro steps at a 100-points-per-unit rate).

Section
Redeeming points
Type
Text field
Default value
1
Technical name
redeemStep

Help text in the administration:

Points can only be redeemed in multiples of this value. 1 lets customers redeem their exact balance (e.g. all 159 points); a higher value forces round blocks (e.g. 100 = whole-euro steps at a 100-points-per-unit rate).

What does the setting "Maximum points per order" do?

Upper limit of points redeemable in a single order. 0 means no limit.

Section
Redeeming points
Type
Text field
Default value
0
Technical name
redeemMaxPointsPerOrder

Help text in the administration:

Upper limit of points redeemable in a single order. 0 means no limit.

What does the setting "Allow combined redemption" do?

When on, a customer can stack several rewards plus a leftover-points discount in one order, up to their full balance.

Section
Redeeming points
Type
Switch
Default value
on
Technical name
redeemAllowCombined

Help text in the administration:

When on, a customer can stack several rewards plus a leftover-points discount in one order, up to their full balance.

When off, only one redemption per cart is possible.

Points release

What does the setting "Order state that counts as completed" do?

The single "completed" definition for the whole plugin: pending points are released once an order reaches this state (plus the minimum age below), and the tier order-count and booster order-gate count orders in this state.

Section
Points release
Type
Choice
Default value
Completed
Technical name
completedOrderState

The options are:

  • Open
  • In progress
  • Completed
  • Cancelled

Help text in the administration:

The single "completed" definition for the whole plugin: pending points are released once an order reaches this state (plus the minimum age below), and the tier order-count and booster order-gate count orders in this state.

Recommended: "Completed".

What does the setting "Minimum age in days" do?

Days that must pass after the order date before points are confirmed.

Section
Points release
Type
Text field
Default value
14
Technical name
confirmAfterDays

Help text in the administration:

Days that must pass after the order date before points are confirmed.

Cancellation

What does the setting "Auto-reverse points on cancellation" do?

When an order is cancelled, automatically counter-book the points it earned and re-credit the points it redeemed.

Section
Cancellation
Type
Switch
Default value
on
Technical name
cancellationReverse

Help text in the administration:

When an order is cancelled, automatically counter-book the points it earned and re-credit the points it redeemed.

Turn off to handle cancellations manually via admin bookings.

What does the setting "Order state that voids points" do?

Pending points lapse when the order reaches this state. Recommended: "Cancelled".

Section
Cancellation
Type
Choice
Default value
Cancelled
Technical name
cancelOrderState

The options are:

  • Open
  • In progress
  • Completed
  • Cancelled

Help text in the administration:

Pending points lapse when the order reaches this state. Recommended: "Cancelled".

Loyalty tiers

What does the setting "Enable the tier system" do?

Master switch for the whole tier feature.

Section
Loyalty tiers
Type
Switch
Default value
on
Technical name
tiersEnabled

Help text in the administration:

Master switch for the whole tier feature.

When off, points keep working fully (earn, redeem, rewards, balance, goals) but customers are never assigned a tier, no tier multiplier is applied and all tier UI is hidden.

The settings below only take effect while this is on.

What does the setting "Tier mode" do?

Defines which points count towards a customer's tier: only those inside a rolling window, or everything ever collected.

Section
Loyalty tiers
Type
Choice
Default value
Rolling - score window
Technical name
tierMode

The options are:

  • Rolling - score window – tier reflects points earned within the rolling lookback window - once the window passes, points drop out and the customer can re-tier or move down.
  • Lifetime - all-time score – tier reflects all points ever earned (also expired and redeemed lots stay countable) - a customer who reaches Gold once stays Gold unless reset manually.

What does the setting "Rolling lookback window in days" do?

Only relevant when tier mode is "rolling". Number of days that earn-points count towards the tier-score (typically 365 = past year).

Section
Loyalty tiers
Type
Text field
Default value
365
Technical name
tierRollingLookbackDays

Help text in the administration:

Only relevant when tier mode is "rolling". Number of days that earn-points count towards the tier-score (typically 365 = past year).

Ignored when mode is "lifetime".

What does the setting "Downgrade policy" do?

What happens when a customer's score drops below their current tier. Immediate: downgrade the same day.

Section
Loyalty tiers
Type
Choice
Default value
With grace - keep tier for N days, then downgrade
Technical name
tierDowngradePolicy

The options are:

  • Immediate - downgrade right away
  • With grace - keep tier for N days, then downgrade – customer keeps the tier for a configurable grace window - if the score recovers within that window, the tier survives; if not, downgrade after grace expires.
  • Never - once reached, stay forever – customers never lose a tier (manual reset only).

Help text in the administration:

What happens when a customer's score drops below their current tier. Immediate: downgrade the same day.

What does the setting "Grace window in days" do?

Only relevant when downgrade policy is "with grace".

Section
Loyalty tiers
Type
Text field
Default value
30
Technical name
tierGraceDays

Help text in the administration:

Only relevant when downgrade policy is "with grace".

Number of days the customer keeps their tier after the score drops below the threshold, before the downgrade actually applies.

Default-flow point values

What does the setting "Birthday bonus points" do?

Credited once a year on the customer's birthday. 0 = disabled.

Section
Default-flow point values
Type
Text field
Default value
100
Technical name
birthdayPoints

Help text in the administration:

Credited once a year on the customer's birthday. 0 = disabled.

What does the setting "Registration bonus points" do?

Credited once when a new customer creates an account. 0 = disabled.

Section
Default-flow point values
Type
Text field
Default value
50
Technical name
registrationPoints

Help text in the administration:

Credited once when a new customer creates an account. 0 = disabled.

What does the setting "Newsletter confirmation bonus" do?

Credited once when a customer confirms their newsletter subscription. 0 = disabled.

Section
Default-flow point values
Type
Text field
Default value
30
Technical name
newsletterPoints

Help text in the administration:

Credited once when a customer confirms their newsletter subscription. 0 = disabled.

Storefront hints - product & listing

What does the setting "Show points hint on product detail pages" do?

"You earn X points with this product" badge under the product price.

Section
Storefront hints - product & listing
Type
Switch
Default value
on
Technical name
displayPdpHint

Help text in the administration:

"You earn X points with this product" badge under the product price.

What does the setting "Show points hint on product listing cards" do?

Compact earn badge on category and search-result cards.

Section
Storefront hints - product & listing
Type
Switch
Default value
on
Technical name
displayListingHint

Help text in the administration:

Compact earn badge on category and search-result cards.

What does the setting "Show order-wide booster notices on product detail pages" do?

Order-wide booster notices ("This week double points on everything") always show in the cart summary.

Section
Storefront hints - product & listing
Type
Switch
Default value
off
Technical name
displayPdpGlobalNotices

Help text in the administration:

Order-wide booster notices ("This week double points on everything") always show in the cart summary.

Turning this on additionally renders them on every PDP. Product-stream-scoped notices always show on matching PDPs regardless of this setting.

Storefront hints - cart

What does the setting "Show points hint in the cart" do?

"You earn X points for this order" preview above the redeem widget.

Section
Storefront hints - cart
Type
Switch
Default value
on
Technical name
displayCartHint

Help text in the administration:

"You earn X points for this order" preview above the redeem widget.

What does the setting "Show per-line points hint in the cart" do?

Small "+X points" badge next to each cart line - on top of the overall order preview above the redeem widget.

Section
Storefront hints - cart
Type
Switch
Default value
on
Technical name
displayCartLinePoints

Help text in the administration:

Small "+X points" badge next to each cart line - on top of the overall order preview above the redeem widget.

What does the setting "Show tier-threshold banner in the cart" do?

Banner above the cart summary that tells the customer how many points are missing until the next loyalty tier - including the points this very order would earn.

Section
Storefront hints - cart
Type
Switch
Default value
on
Technical name
displayCartTierThreshold

Help text in the administration:

Banner above the cart summary that tells the customer how many points are missing until the next loyalty tier - including the points this very order would earn.

Hides automatically when the customer is already on the top tier.

Storefront hints - account page

What does the setting "Show the loyalty account page" do?

The dedicated /dvsn-loyalty page with balance, tier card and history. Hidden = the menu link disappears too.

Section
Storefront hints - account page
Type
Switch
Default value
on
Technical name
displayAccountPage

Help text in the administration:

The dedicated /dvsn-loyalty page with balance, tier card and history. Hidden = the menu link disappears too.

What does the setting "Show the transaction history on the account page" do?

Per-transaction log on the customer's loyalty page. Off = balance + tier card stay visible, but no individual booking rows.

Section
Storefront hints - account page
Type
Switch
Default value
on
Technical name
displayAccountHistory

Help text in the administration:

Per-transaction log on the customer's loyalty page. Off = balance + tier card stay visible, but no individual booking rows.

What does the setting "Show the tier journey on the account page" do?

The horizontal tier path (Silver → Gold → …) with the customer's progress. Only shown when the tier system is enabled.

Section
Storefront hints - account page
Type
Switch
Default value
on
Technical name
displayAccountTierJourney

Help text in the administration:

The horizontal tier path (Silver → Gold → …) with the customer's progress. Only shown when the tier system is enabled.

Off = hide the journey even with tiers active.

What does the setting "Show goals / milestones on the account page" do?

The milestone progress block ("460 points to your +100 bonus"). Off = hide it even when goals are configured.

Section
Storefront hints - account page
Type
Switch
Default value
on
Technical name
displayAccountGoals

Help text in the administration:

The milestone progress block ("460 points to your +100 bonus"). Off = hide it even when goals are configured.

What does the setting "Show redeemable rewards on the account page" do?

The reward showcase (cart-style boxes) on the account page. Off = hide the reward list there; redemption in the cart is unaffected.

Section
Storefront hints - account page
Type
Switch
Default value
on
Technical name
displayAccountRewards

Help text in the administration:

The reward showcase (cart-style boxes) on the account page. Off = hide the reward list there; redemption in the cart is unaffected.

What does the setting "Show "how to earn more" on the account page" do?

A list at the bottom of the account page showing the earn rate plus the registration / newsletter / birthday bonuses (only the ones that award points).

Section
Storefront hints - account page
Type
Switch
Default value
on
Technical name
displayAccountEarnWays

Help text in the administration:

A list at the bottom of the account page showing the earn rate plus the registration / newsletter / birthday bonuses (only the ones that award points).

Storefront hints - account sidebar

What does the setting "Show the points box in the account sidebar" do?

A small permanent box in the account menu showing the current balance on every account page.

Section
Storefront hints - account sidebar
Type
Switch
Default value
off
Technical name
displaySidebarBox

Help text in the administration:

A small permanent box in the account menu showing the current balance on every account page.

The current tier is added automatically while the tier system is enabled.

Theme

What does the setting "Storefront theme" do?

Picks the visual theme for all loyalty fragments (PDP earn-hint, cart redeem widget, account page, listing badge).

Section
Theme
Type
Choice
Default value
Ambient - restrained violet accent, calm
Technical name
storefrontTheme

The options are:

  • Shopware standard - no own colours, uses primary/secondary
  • Ambient - restrained violet accent, calm
  • Spotlight - bold teal accent, filled buttons

Help text in the administration:

Picks the visual theme for all loyalty fragments (PDP earn-hint, cart redeem widget, account page, listing badge).

"Shopware standard" adds no plugin colour of its own - it inherits your theme's colours (primary, surfaces, radius), so an external theme restyles the loyalty UI automatically; override the --dvsn-loyalty-* CSS variables for finer control.

What does the setting "Loyalty programme page" do?

Pick a landing page that explains the programme.

Section
Theme
Type
Reference to a record
Default value
empty
Technical name
programLandingPageId

Help text in the administration:

Pick a landing page that explains the programme.

Shown as "How the programme works" on the loyalty account page; its SEO URL is resolved automatically per sales channel and language.

Leave empty to hide the link.

Cart

What does the setting "Points box position" do?

Where the points / redeem box appears on the cart page.

Section
Cart
Type
Choice
Default value
Right content, below the summary
Technical name
cartCardPosition

The options are:

  • Left content, above the products
  • Left content, below the products
  • Right content, below the summary

Help text in the administration:

Where the points / redeem box appears on the cart page.

When the box and the reward products share a position, the box is rendered first and the rewards below it.

What does the setting "Reward products position" do?

Where the redeemable reward products appear on the cart page.

Section
Cart
Type
Choice
Default value
Left content, below the products
Technical name
cartRewardsPosition

The options are:

  • Left content, above the products
  • Left content, below the products
  • Right content, below the summary

Help text in the administration:

Where the redeemable reward products appear on the cart page.

Points expiry

What does the setting "Enable points expiry" do?

If on, earn-points expire after the configured number of days.

Section
Points expiry
Type
Switch
Default value
on
Technical name
pointsExpiryEnabled

Help text in the administration:

If on, earn-points expire after the configured number of days.

The daily expiry cron creates a counter-transaction for any leftover balance from an expired lot.

What does the setting "Validity in days" do?

Days from the booking-date a points-lot stays valid. 365 = one year.

Section
Points expiry
Type
Text field
Default value
365
Technical name
pointsExpiryDays

Help text in the administration:

Days from the booking-date a points-lot stays valid. 365 = one year.

Only earn-lots booked AFTER this change get the new lifetime; older lots keep the lifetime they were stamped with at booking-time.

Note: the expiry window is applied globally - a per-sales-channel value is not used for points earned from orders.

Expiry reminder

What does the setting "Send reminder mail before expiry" do?

If on, a customer-aggregated reminder mail goes out N days before lots expire. Off = silent expiry without a heads-up.

Section
Expiry reminder
Type
Switch
Default value
on
Technical name
pointsExpiryReminderStatus

Help text in the administration:

If on, a customer-aggregated reminder mail goes out N days before lots expire. Off = silent expiry without a heads-up.

What does the setting "Lead time before expiry (days)" do?

How many days before a lot expires the reminder mail is sent. Lots expiring within the lead-window are aggregated into a single mail per customer.

Section
Expiry reminder
Type
Text field
Default value
14
Technical name
pointsExpiryReminderLeadDays

Help text in the administration:

How many days before a lot expires the reminder mail is sent. Lots expiring within the lead-window are aggregated into a single mail per customer.

What does the setting "Throttle between reminders (days)" do?

Minimum spacing between two reminder mails to the same customer. Prevents inbox-spam when several lots expire in close succession.

Section
Expiry reminder
Type
Text field
Default value
30
Technical name
pointsExpiryReminderThrottleDays

Help text in the administration:

Minimum spacing between two reminder mails to the same customer. Prevents inbox-spam when several lots expire in close succession.

Scheduled tasks & technical

What does the setting "Scheduled task: release pending points (hourly)" do?

Off = the cron stops; run it on your own schedule via `bin/console dvsn:loyalty:mature-transactions`.

Section
Scheduled tasks & technical
Type
Switch
Default value
on
Technical name
taskMatureTransactions

Help text in the administration:

Off = the cron stops; run it on your own schedule via `bin/console dvsn:loyalty:mature-transactions`.

What does the setting "Scheduled task: expire points (daily)" do?

Off = the cron stops; run via `bin/console dvsn:loyalty:expire-points`.

Section
Scheduled tasks & technical
Type
Switch
Default value
on
Technical name
taskExpirePoints

Help text in the administration:

Off = the cron stops; run via `bin/console dvsn:loyalty:expire-points`.

What does the setting "Scheduled task: expiry-reminder mails (daily)" do?

Off = the cron stops; run via `bin/console dvsn:loyalty:expiry-reminder`.

Section
Scheduled tasks & technical
Type
Switch
Default value
on
Technical name
taskExpiryReminder

Help text in the administration:

Off = the cron stops; run via `bin/console dvsn:loyalty:expiry-reminder`.

What does the setting "Scheduled task: birthday bonuses (daily)" do?

Off = the cron stops; run via `bin/console dvsn:loyalty:process-birthdays`.

Section
Scheduled tasks & technical
Type
Switch
Default value
on
Technical name
taskProcessBirthdays

Help text in the administration:

Off = the cron stops; run via `bin/console dvsn:loyalty:process-birthdays`.

What does the setting "Scheduled task: re-evaluate tiers (every 5 min)" do?

Off = the cron stops; run via `bin/console dvsn:loyalty:process-tier-upgrades`.

Section
Scheduled tasks & technical
Type
Switch
Default value
on
Technical name
taskProcessTierUpgrades

Help text in the administration:

Off = the cron stops; run via `bin/console dvsn:loyalty:process-tier-upgrades`.

What does the setting "Scheduled task: re-evaluate goals (daily)" do?

Backfills goal bonuses for goals added after customers already crossed them.

Section
Scheduled tasks & technical
Type
Switch
Default value
on
Technical name
taskReevaluateGoals

Help text in the administration:

Backfills goal bonuses for goals added after customers already crossed them.

Off = the cron stops; run via `bin/console dvsn:loyalty:reevaluate-goals`.

What does the setting "Maturation batch size" do?

Maximum number of pending point transactions processed per cron tick.

Section
Scheduled tasks & technical
Type
Text field
Default value
250
Technical name
maturationBatchSize

Help text in the administration:

Maximum number of pending point transactions processed per cron tick.

Increase for high-volume shops with thousands of orders per day; the default 250 covers the typical small / medium shop. 0 falls back to the default.

Everything on this page is generated straight from the plugin configuration. When a setting changes in the plugin, this page changes with it.

← Back to the manual

More chapters
Glossary

Glossary

Pending, lot, booster, goal, multiplier - the words that carry a fixed meaning in the programme.

Read on → First steps

Setting up

From installation to the first point earned: nine steps, one name and one decision.

Read on → Earning

Earning points

How an order becomes points: basis, rounding, boosters, tier - and when they become valid.

Read on →