tax_line

Information about a tax line of a checkout or order.

Properties

price number: The tax amount in the currency's subunit.

The value is output in the customer's local (presentment) currency.

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip
Use money filters to output a formatted price.
rate number: The decimal value of the tax rate.
rate_percentage number: The decimal value of the tax rate, as a percentage.
title string: The title of the tax.

{

"price": 1901,

"rate": 0.05,

"rate_percentage": 5,

"title": "GST"

}

{
  "price": 1901,
  "rate": 0.05,
  "rate_percentage": 5,
  "title": "GST"
}

Was this section helpful?