POST
Create 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.

Body

application/json

THERE IS NO CONVERGENCE GUARANTEE OUTSIDE THE IDEMPOTENCY WINDOW on this route. tax_rate has no unique column, so a create retried after the window mints a SECOND rate rather than colliding. Reconcile by listing, not by re-posting. The jurisdiction columns (tax_region_id, code, is_combinable) are refused here by name: they belong to PUT /api/v1/tax-rates/{taxRateId}/jurisdiction.

name
string
required

Required and must not be blank. Not unique: a merchant may run two rates called "GST" in two jurisdictions.

rate_bps
integer
required

Required. An integer count of BASIS POINTS: 1800 means 18.00%. Send percent * 100, or fraction * 10000. It is not defaulted, because a missing rate would silently create a zero-rated tax.

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

Optional, defaults to false. Setting it true CLEARS the store's existing default in the same transaction, because at most one default is allowed per store, so it changes what an unclassified line is charged at on a rate this call never named.

Response

Created

data
object