Skip to content

List Tax Rates

Returns the store-wide list of tax rates in the standard { data, meta } envelope. Each row is one tax rate — a rule that defines the tax percentage applied to a location, identified by country/state and either a single zip code (isZip: false) or a zip-code range (isZip: true).

Endpoint

GET /api/admin/settings/tax-rates

Query parameters

All parameters are optional and combine in one request — filter, sort and paginate together.

Pagination

ParameterDescription
pagePage number (1-based).
per_pageItems per page (default 10, max 50).

Filters

Each filter narrows the result; supplying more than one combines with logical AND.

ParameterMatchExample
identifierPartial (contains).?identifier=AUDIT
countryExact — two-letter ISO code.?country=US
stateExact.?state=CA
tax_rate_fromMinimum tax rate (inclusive).?tax_rate_from=5
tax_rate_toMaximum tax rate (inclusive).?tax_rate_to=10

Sorting

ParameterValues
sortid (default), identifier, tax_rate
orderasc, desc (default desc)

For how tax rates fit together with tax categories, see the menu overview.

Released under the MIT License.