Component String Variables
This document is a place to centrally organise and document the variables that can be parsed from a string prop.
For instance, if a user to types in “Your subscription will end on {{termEndDate}}” into the Limio Prop in the PageBuilder then the component would display “Your subscription will end on 25th December 2021”. In the code this would look like:
Component |
Variable |
Props |
Purpose |
Cancel Save Offer
|
termEndDate |
subheading__limio_richtext
|
Shows the date when the subscription ends |
discountRate |
discountDetails |
Shows the percentage value of the discount on the offer. |
|
discountPeriod |
detailedSubheading |
The length of time the discount applies for e.g. 12 months |
|
currentPrice |
nextPaymentDetails__limio__richtext |
Price before discount |
|
nextPriceWithDiscount |
nextPaymentDetails__limio__richtext |
Price after discount |
|
discountEndDate |
confirmSubheading |
Discount end date |
|
Order Change Success
|
termEndDate |
heading subheading__limio_richtext
|
Shows the date when the subscription ends |
nextPaymentDate |
Shows the next payment date according to the schedule |
||
nextPaymentCost |
Shows the next payment cost according to the schedule |
||
currentPaymentCost |
Shows the current price of the sub |
||
discountEndDate |
Shows the date the discount ends |
||
Single Page Checkout
|
displayAmount |
authorisationMessage |
Shows the authorisation charge |
today |
initialTermDisplay
|
Displays today's date |
|
endDate |
Displays the term end date. |
||
totalCost |
consents (type: information) |
Displays the cost of all items in the basket. |
|
termEndDate |
Displays the term end date. |
||
city_name_type |
cityLabel |
Displays the country-specific city name type e.g city |
|
state_name_type |
stateLabel
invalidStateMessage |
Displays the country-specific state or county name e.g. region or state |
|
zip_name_type |
postalCodeLabel |
Displays the country-specific zip or post code e.g. zip |
|
Order confirmation
|
customerDetails.email
|
message |
Displays the logged in customers email |
recipientEmail |
giftMessage |
Displays the email of the giftee. Gift orders only. |
|
giftDate |
giftMessage |
Displays the email message for the giftee (if provided by the user in the checkout). Gift orders only. |
|
order_reference |
referenceMessage |
The Limio order reference number. |
|
sub_reference |
referenceMessage |
The subscription reference number. |
|
Cart Items
|
data.attributes.attributeName |
Offer Additional Information |
Display any offer attribute, custom or Limio out-of-the-box, by replacing attributeName with the name of the offer attribute. For example, {{data.attributes.display_name__limio}} would show the offer display name attribute. |
data.attributes.attributeName |
Add On Additional Information |
Display any add-on attribute, custom or Limio out-of-the-box, by replacing attributeName with the name of the add-on attribute. For example, {{data.attributes.description__limio}} would show the add-on description attribute. |
|
Promo Code Redeem |
promo_code |
Successful promo code message |
Applied promo code name |
Comments
1 comment
If we were using this in an immediate online cancellation scenario - how could we display the refund amount due within the Order Change Success component?
Please sign in to leave a comment.