Skip to main content
GET
/
api
/
v2
/
platform
/
tax_rates
Return a list of Tax Rates
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/tax_rates \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ],
  "meta": {
    "count": 123,
    "total_count": 123,
    "total_pages": 123
  },
  "links": {
    "self": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "last": "<string>",
    "first": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
per_page
integer
include
string

Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes

filter[zone_id_eq]
string
filter[amount_gt]
string
filter[tax_category_id_eq]
string

Response

Records returned

data
object[]
required
meta
object
required