PATCH
Update a tax rate

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

taxRateId
string
required

Body

application/json

An omitted key keeps its stored value. A PUT would make forgetting is_default silently unset the store's default rate, which is why this is a PATCH. The jurisdiction columns are refused by name and belong to PUT /api/v1/tax-rates/{taxRateId}/jurisdiction.

name
string

Must not be blank. Omit the key to leave it unchanged.

rate_bps
integer

An integer count of BASIS POINTS (1800 = 18.00%).

Required range: 0 <= x <= 100000
is_default
boolean

Setting it true clears the store's existing default in the same transaction.

Response

Success

data
object