The payment_terms object

Payment terms are accessible on the order object. Deferring payment at order creation in the admin will create payment terms for the order.

The payment_terms object has the following attributes:

payment_terms.name

Returns a string that describes the payment terms to Buyers, such as Net 30.

payment_terms.type

Returns the type of payment term. The following are the possible types:

  • net: Order amount is due a set number of days from the issue date.
  • fixed: Order amount is due on a fixed date.
  • receipt: Order amount is due upon receipt of the invoice.

payment_terms.next_payment

Returns an object representing the next payment due for the order.

If there's no upcoming payment due, all attributes of the object will return nil.

next_payment.amount_due

Returns the money amount due for the next payment.

Use the money filter to output a localized currency.

next_payment.due_at

Returns a timestamp of when the next payment is due.

Use the date filter to customize the format of the output.