List tax rates

const options = {
  method: 'GET',
  headers: {'x-spree-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('http://{defaultHost}/api/v3/admin/tax_rates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "tax_UkLWZg9DAJ",
      "name": "TaxRate - 124492",
      "included_in_price": true,
      "show_rate_in_label": true,
      "metadata": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "deleted_at": null,
      "rate": "0.19",
      "rate_percent": "19",
      "tax_category_id": "taxcat_UkLWZg9DAJ",
      "store_id": "store_UkLWZg9DAJ",
      "country_code": "DE",
      "state_code": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

{
  "error": {
    "code": "authentication_required",
    "message": "Authentication required"
  }
}

List tax rates

Returns the store’s tax rates. Rates are the entire configuration of the built-in tax provider: each pairs a tax category with a jurisdiction (a country, optionally narrowed to one state) and a percentage, and decides whether the tax is already included in the product price (VAT-style) or added on top (US-style).

Markets using an external tax provider ignore these rows — that provider carries its own jurisdiction data.

Required scope: read_settings (for API-key authentication).

GET

api

admin

tax_rates

List tax rates

const options = {
  method: 'GET',
  headers: {'x-spree-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('http://{defaultHost}/api/v3/admin/tax_rates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "tax_UkLWZg9DAJ",
      "name": "TaxRate - 124492",
      "included_in_price": true,
      "show_rate_in_label": true,
      "metadata": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "deleted_at": null,
      "rate": "0.19",
      "rate_percent": "19",
      "tax_category_id": "taxcat_UkLWZg9DAJ",
      "store_id": "store_UkLWZg9DAJ",
      "country_code": "DE",
      "state_code": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

{
  "error": {
    "code": "authentication_required",
    "message": "Authentication required"
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[name_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`amount`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`country_code`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`included_in_price`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`name`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`state_code`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`tax_category_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Sort by: amount, country_code, created_at, id, included_in_price, name, state_code, tax_category_id, updated_at. Prefix a field with - to sort descending.

Authorizations

x-spree-api-key

string

header

required

Secret API key for admin access

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Bearer token for admin authentication

Query Parameters

q[search]

string

Matches any of name (partial, case-insensitive).

page

integer

Page number

limit

integer

Number of records per page

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

sort

string

Sort by field. Prefix with - for descending (e.g., -created_at).

Response

tax rates found

data

object[]

required

Show child attributes

API basics

Endpoints

List tax rates

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters