Skip to main content
PATCH
/
api
/
v2
/
platform
/
tax_rates
/
{id}
Update a Tax Rate
curl --request PATCH \
  --url http://{defaultHost}/api/v2/platform/tax_rates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tax_rate": {
    "amount": 0.05,
    "tax_category_id": "1",
    "calculator_attributes": {
      "type": "Spree::Calculator::FlatRate",
      "preferences": {
        "amount": 0,
        "currency": "USD"
      }
    },
    "zone_id": "2",
    "included_in_price": true,
    "name": "California",
    "show_rate_in_label": false
  }
}
'
{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {},
    "relationships": {}
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Query Parameters

​
include
string

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

Body

application/json
​
tax_rate
object
required

Response

Record updated

​
data
object
required