GET
List tax rate rules

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

reference
enum<string>

What kind of target to filter on. Must be sent together with reference_id; either half alone is a 400. A value outside this set is a 400 rather than an empty page, because an empty page means "this target carries no override", which is the ordinary state of most products and a different answer entirely.

Available options:
product,
product_type,
product_tax_class
reference_id
string

The id of the target, read according to reference. Must be sent together with reference. Omit both to receive every rule in the store, which is the shape a migration or an ERP needs: the rule is the layer that overrides a class rate, so a client that skipped it has reconstructed a tax matrix the store does not charge.

updated_after
string<date-time>

Rules touched at or after this RFC3339 instant, for reconciling incrementally instead of re-reading the whole rule set on every run. It composes with reference and reference_id: narrowing and ordering are independent, and all four combinations are served. Supplying it CHANGES THE ORDER of this endpoint: the default walk descends created_at, and this one climbs updated_at, because that is the only ordering in which a keyset walk over a mutable column cannot skip a row. A rule changed mid-walk moves forward past your position and is returned again, so the walk is AT LEAST ONCE. WHAT A MISS COSTS HERE IS A TAX NUMBER: a rule is the layer that OVERRIDES a class rate, so a client that missed one has reconstructed a tax matrix the store does not charge. A cursor from one ordering is refused by the other.

limit
integer
default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100
after
string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data
object[]
page
object