rate

query

Requires commerce.tax:read.

Get a single rate.

value is a union. Select value { __typename ... on RatePercentage { percentage } ... on RateAmount { amount { value currencyCode } } }. There is no value { rate } field.

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 — The rate ID.

Possible returns

Rate Rate — An individual tax rate.

query GetRate($id: ID!) {  rate(id: $id) {    id    name    status    label    createdAt    updatedAt    value {      __typename      ... on RateAmount {        amount {          currencyCode          value        }      }      ... on RatePercentage {        percentage      }    }  }}

{  "data": {    "rate": {      "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

Required headers

Arguments

Possible returns

On this page