Skip to main content
POST
Create tax rate

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

Body

application/json
rate
number
required

Tax rate as a decimal (e.g. 0.0825 for 8.25%)

name
string

Human-friendly name for the tax rate (alias for display_name; if both provided, display_name wins).

Example:

"TX Sales Tax"

display_name
string

Canonical display name stored in DB. Accepted alongside 'name' alias.

Example:

"TX Sales Tax"

description
string
tax_type
enum<string>
default:sales
Available options:
sales,
use,
vat,
gst,
hst,
pst,
excise,
other
jurisdiction_country
string

ISO 3166-1 alpha-2 country code

Example:

"US"

jurisdiction_state
string
Example:

"TX"

jurisdiction_county
string
jurisdiction_city
string
jurisdiction_postal_code
string
inclusive
boolean
default:false
is_active
boolean
default:true
effective_from
string<date>
effective_to
string<date>
metadata
object

Response

Created tax rate

The response is of type object.