deactivateRate

mutation

Requires commerce.tax:write.

Deactivate an existing rate.

Required headers

Header	Required	Description
`x-store-id`	Yes	ID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: `extensions.code: "UNAUTHENTICATED"`.

Go to Authentication for credential setup.

Arguments

id ID! required

Possible returns

Rate Rate — An individual tax rate.

mutation RunDeactivateRate($id: ID!) {  deactivateRate(id: $id) {    id    name    status    label    createdAt    updatedAt    value {      __typename      ... on RateAmount {        amount {          currencyCode          value        }      }      ... on RatePercentage {        percentage      }    }  }}

{  "data": {    "deactivateRate": {      "id": "ID_VALUE",      "name": "Example",      "status": "ACTIVE",      "label": "Example",      "createdAt": "2026-01-15T12:00:00.000Z",      "updatedAt": "2026-01-15T12:00:00.000Z",      "value": {        "__typename": "RateAmount",        "amount": {          "currencyCode": "USD",          "value": 1999        }      }    }  }}

Last updated on