Skip to main content

A tax applied to products at a store, charged as a flat amount or a percentage.

id
string
required

Unique identifier for the record.

active
boolean
required

Whether the rate is charged at checkout. An inactive rate stays configured but is not applied.

category
enum<string>
required

The kind of tax this rate represents.

Available options:
other,
sales
created_at
string<date-time>
required

When the record was created.

name
string
required

Name of the tax rate, such as the jurisdiction that levies it or the category it covers.

updated_at
string<date-time>
required

When the record was last changed.

value
string
required

The rate charged. When value_type is percentage, this is a percentage of the taxable amount — 8.25 means 8.25%. When it is amount, this is a fixed amount of currency charged per unit sold.

Pattern: ^[0-9]+(\.[0-9]+)?$
Example:

"8.25"

value_type
enum<string>
required

How value is applied: a fixed amount or a percentage.

Available options:
amount,
percentage