Prints the amount of money a loyalty program member still needs to spend on the online store's products to reach the reward tier.

Description

The tag works in the reward tier list of the loyalty program, which is implemented using the {LoyaltyProgramDiscountTiers} tag.

The tag will print the amount required for the reward tier only if the customer has not yet reached that reward tier. However, you can use the or attribute to specify alternative content for the tag, which will be printed at the customer's current and lower reward tiers.

The tag calculates the value based on the correct point balance of a loyalty program member, provided that the customer is logged into the online store. Otherwise, the default point balance is zero.

To prevent confusing customers by the value changing upon login, you can define different content for non-logged-in visitors by using the {Helper} tag and the case: 'CustomerNotLogged' attribute.

Also read:

Syntax

{LoyaltyProgramDiscountTierPurchasesNeeded(
    currencysymbol: boolean,
    decimals: int,
    decimalsep: string,
    includetax: boolean,
    price_format: string,
    thousandssep: string  
)}

Scope

Required scope: loyalty-program-discount-tier

The tag is used only in the {LoyaltyProgramDiscountTiers} tag's helper attribute.

Attribuutit

currencysymbol:

Determines whether the currency symbol is also displayed with the total. The output symbol is automatically determined based on the currency in use.

The currency symbol can also be printed using the {CurrencySymbol} tag.

Allowed values:true/false. The default value is false.

decimals:

Sets the decimal print precision (default is 2 decimal places).

Allowed values:integers.

decimalsep:

Defines the decimal separator character. The most popular decimal separators are comma and dot, the use of which depends on the store's locale.

Allowed values: merkki jota halutaan käyttää desimaalierottimena (esim. desimaalipiste = decimalsep: '.'). Oletusarvo on pilkku.

includetax:

Calculates the resulting sum either with or without value-added tax.

Allowed values:true/false. The default value is true.

price_format:

Determines the price information display format.

Allowed values:
  • string (default): The price information is displayed as a string, which may also include additions depending on other attributes of the tag (e.g., currency symbol).
  • decimal: The price information is displayed as a clean decimal number (e.g. 9.90), which can be used, among other things, in JavaScript code. This option overrides other attributes that may affect the price information display format.
thousandssep:

Specifies the character used as the thousands separator.

Commonly used thousands separators are space, comma, and period. You may want to define thousands separators according to the locale.

Allowed values: a character that should be used as the thousands separator in prices.

By default, the thousands separator is a non-breaking space  

after/before:

By using the after and before attributes you can define content that is output either after or before the tag's output.

Allowed values:HTML and Interface markup.

E.g.

  • before: '<p>Tämä merkkaus näkyy ennen tagin omaa sisältöä.</p>'
  • after: '<p>Tämä taas näkyy tagin oman sisällön jälkeen.</p>'

If the tag does not produce any content, neither the content of the after and before attributes will be output.

escape:

Adds an escape character before quotation marks in the output.

The attribute makes it easier to process the tag-produced content when using JavaScript.

Allowed values:true/false. The default value is false.

or:

Defines alternative content that is displayed if the tag itself does not produce any content.

Allowed values:HTML and Interface markup.

E.g. or:'Sisältöä ei löytynyt.'