Skip to Content

Order Payment Method

The order_payment_method object describes a payment method used for an order.

Usage Example

{%- comment -%} List all payment methods for an order {%- endcomment -%} <ul> {% for method in order.payment_methods %} <li>{{ method.title }}: {{ method.amount }}</li> {% endfor %} </ul>

Properties

amount

Returns the amount paid with this payment method.

currency

Returns the payment method currency.

description

Returns the payment method description.

fee

Returns the payment fee.

gift_card

If this payment method type is gift_card, this returns information about the gift card used as a payment method. The following properties are available:

  • value: The value of the gift card.
  • code: The code of the gift card.
  • expires: The expiration date of the gift card.
  • value_left: The remaining value on the gift card.

id

Returns the unique id for this payment method.

info

Returns additional information about the payment method.

is_paid

Returns true if this payment method status is paid.

net_fee

Returns the payment fee without tax.

Returns the paid amount.

rate

Returns the tax rate in decimals.

rate_percentage

Returns the tax rate as a percentage.

status

Returns the status of the payment method.

tax

Returns the tax amount.

title

Returns the title or name of the payment method.

type

Returns the type of the payment method.

Last updated on