Difference between revisions of "Liquid Template Variables - customer credit"

From Spiffy Stores Knowledge Base

(Created page with "The CustomerCredit object is available in credit update notification objects. The Liquid template variable '''customer_credit''' has the following attributes: == <code>custo...")
 
m
 
Line 1: Line 1:
The CustomerCredit object is available in credit update notification objects.
+
The CustomerCredit object is available in credit update notification email templates.
  
 
The Liquid template variable '''customer_credit''' has the following attributes:
 
The Liquid template variable '''customer_credit''' has the following attributes:
Line 5: Line 5:
 
== <code>customer_credit.id</code> ==
 
== <code>customer_credit.id</code> ==
  
Returns the unique internal number of the customer.
+
Returns the unique internal number of the customer credit.
  
 
This is normally only for internal usage.
 
This is normally only for internal usage.
 +
 +
== <code>customer_credit.amount</code> ==
 +
 +
Returns the amount of credit that has been added to the customer's account.
 +
 +
If the amount is negative, this represents that amount of the customer's account credit that was applied to an order.
 +
 +
== <code>customer_credit.description</code> ==
 +
 +
This is the text that was entered to describe the credit when it was created.
 +
 +
== <code>customer_credit.customer</code> ==
 +
 +
Return the [[Liquid Template Variables - customer|customer]] object associated with the credit.
 +
 +
== <code>customer_credit.order</code> ==
 +
 +
Return the [[Liquid Template Variables - order|order]] object associated with the credit that was used for an order.
  
 
== Further Reference ==
 
== Further Reference ==

Latest revision as of 14:18, 25 June 2018

The CustomerCredit object is available in credit update notification email templates.

The Liquid template variable customer_credit has the following attributes:

customer_credit.id

Returns the unique internal number of the customer credit.

This is normally only for internal usage.

customer_credit.amount

Returns the amount of credit that has been added to the customer's account.

If the amount is negative, this represents that amount of the customer's account credit that was applied to an order.

customer_credit.description

This is the text that was entered to describe the credit when it was created.

customer_credit.customer

Return the customer object associated with the credit.

customer_credit.order

Return the order object associated with the credit that was used for an order.

Further Reference