PUT
Set a tax class rate for one region

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

taxClassId
string
required
regionId
string
required

Body

application/json

An UPSERT addressed by the path pair, so it is idempotent IN EFFECT and not merely by Idempotency-Key: a reconciler retried outside the window converges on the same row. {regionId} names a MARKET region, from /api/v1/regions under read_regions, and NOT a tax region: the two are different tables with different id spaces. This rate is what a classed product is actually charged, since it is preferred over the store default.

rate_bps
integer
required

Required. An integer count of BASIS POINTS: 1800 means 18.00%. It is not defaulted, because a missing rate would silently zero-rate this class in this market.

Required range: 0 <= x <= 100000

Response

Success

data
object