OrderPreview Apex Class

When running a subscription action in Limio for Salesforce (e.g. cancel or switch), the flows perform accurate calculations for the order total against Zuora. What Zuora returns as the total is then stored on a Limio for Salesforce apex class, represented as a flow variable, and its attributes can be used across the flow to perform conditional logic (e.g. if order total = 0, skip payment), or to be used as merge fields to build dynamic text, see .

The flow variable in which these parameters are stored are in a global apex class, of type OrderPreview, and its properties are the following.

Variable type and name

String CurrencyCode

Integer Discount

Integer DiscountDuration

String DiscountPaymentFrequency

Date EndOfServicePeriod

Decimal InitialAmountWithoutTax

Decimal InitialPayment

Decimal InitialTaxAmount

Date NextPaymentDate

Decimal OrderTotal

String PaymentFrequency

String ProductName

Decimal RecurringPaymentAmount

Decimal RefundAmount

Since such variables are not relevant to all order types, below is an explanation of what each variable represents for each order type in which is used.

Order Preview: Acquisition Journey

Variable name

Populated (Y/N)

Content

CurrencyCode

Y

The currency of the order, in the format GBP, EUR, USD,...

Discount

N

DiscountDuration

N

DiscountPaymentFrequency

N

EndOfServicePeriod

N

InitialAmountWithoutTax

Y

Initial amount to pay (excl tax)

InitialPayment

Y

Initial amount to pay (incl tax)

InitialTaxAmount

Y

Initial tax amount to pay

NextPaymentDate

Y

Timestamp of the next billing date, following the first billing date (first billing date being today's date)

OrderTotal

N

PaymentFrequency

N

ProductName

Y

Name of the product(s) being purchased

RecurringPaymentAmount

Y

The amount to pay at the start of the next billing period, and thereafter (might be different from the initial one)

RefundAmount

N

Order Preview: Cancel/Cancel Save Journey

Variable name

Populated (Y/N)

Content

CurrencyCode

Y

The currency of the order, in the format GBP, EUR, USD,...

Discount

Y

If cancel save, the discount % (e.g. 20)

DiscountDuration

Y

How many terms the discount applies to

DiscountPaymentFrequency

Y

The frequency of the discount terms

EndOfServicePeriod

N

InitialAmountWithoutTax

Y

Initial amount to pay (excl tax)

InitialPayment

Y

Initial amount to pay (incl tax)

InitialTaxAmount

Y

Initial tax amount to pay

NextPaymentDate

Y

Timestamp of the next billing date, following the chosen effective date. This is not effective date, but the first payment date after that.

OrderTotal

Y

Same as InitialPayment

PaymentFrequency

N

ProductName

Y

Name of the product(s) being purchased

RecurringPaymentAmount

N

RefundAmount

N

Order Preview: Switch Journey

Variable name

Populated (Y/N)

Content

CurrencyCode

Y

The currency of the order, in the format GBP, EUR, USD,...

Discount

N

DiscountDuration

N

DiscountPaymentFrequency

N

EndOfServicePeriod

Y

The end date of the current billing period

InitialAmountWithoutTax

Y

Initial amount to pay (excl tax)

InitialPayment

Y

Initial amount to pay (incl tax)

InitialTaxAmount

Y

Initial tax amount to pay

NextPaymentDate

Y

Timestamp of the next billing date, following the chosen effective date. This is not effective date, but the first payment date after that.

OrderTotal

Y

Same as InitialPayment

PaymentFrequency

Y

How often they get charged (e.g. 1 month, 4 weeks, 1 year, etc)

ProductName

Y

Name of the product(s) being purchased

RecurringPaymentAmount

Y

Amount to pay after the first billing

RefundAmount

N

Last updated

Was this helpful?