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,
    "zone_id": "2",
    "tax_category_id": "1",
    "included_in_price": true,
    "name": "California",
    "show_rate_in_label": false,
    "calculator_attributes": {
      "type": "Spree::Calculator::FlatRate",
      "preferences": {
        "amount": 0,
        "currency": "USD"
      }
    }
  }
}'
{
  "data": {
    "id": "19",
    "type": "tax_rate",
    "attributes": {
      "amount": "25.9",
      "included_in_price": true,
      "created_at": "2022-11-08T19:35:45.406Z",
      "updated_at": "2022-11-08T19:35:45.637Z",
      "name": "TaxRate - 33807",
      "show_rate_in_label": true,
      "deleted_at": null,
      "public_metadata": {},
      "private_metadata": {}
    },
    "relationships": {
      "zone": {
        "data": {
          "id": "106",
          "type": "zone"
        }
      },
      "tax_category": {
        "data": {
          "id": "170",
          "type": "tax_category"
        }
      }
    }
  }
}

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: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

Body

application/json

Response

200
application/vnd.api+json

Record updated

The response is of type object.