Skip to content

Tax Rates API

Tax rates are reusable, named rates you can reference on invoice line items instead of repeating raw percentages. Each rate stores a percentage (as a decimal string), whether it is tax-inclusive, and an optional jurisdiction label. Rates can be deactivated with is_active when they are no longer in use without deleting historical references.

Create Tax Rate

POST /api/v1/tax-rates

Request:

{
  "name": "California sales tax",
  "rate": "8.375",
  "inclusive": false,
  "jurisdiction": "US-CA"
}
Field Required Description
name Yes Display name for the tax rate
rate Yes Percentage as a decimal string (e.g. "8.375")
inclusive No Whether the rate is included in the price (default false)
jurisdiction No Jurisdiction label (e.g. US-CA)

Response 200 OK:

{
  "data": {
    "id": "txr_01ABC",
    "name": "California sales tax",
    "rate": "8.375",
    "inclusive": false,
    "jurisdiction": "US-CA",
    "is_active": true,
    "created_at": "2026-07-20T10:00:00Z",
    "updated_at": "2026-07-20T10:00:00Z"
  }
}
Try it

List Tax Rates

GET /api/v1/tax-rates?limit=50

Response:

{
  "data": [
    {
      "id": "txr_01ABC",
      "name": "California sales tax",
      "rate": "8.375",
      "inclusive": false,
      "jurisdiction": "US-CA",
      "is_active": true,
      "created_at": "2026-07-20T10:00:00Z",
      "updated_at": "2026-07-20T10:00:00Z"
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  }
}
Try it

Get Tax Rate

GET /api/v1/tax-rates/{tax_rate_id}

Response:

{
  "data": {
    "id": "txr_01ABC",
    "name": "California sales tax",
    "rate": "8.375",
    "inclusive": false,
    "jurisdiction": "US-CA",
    "is_active": true,
    "created_at": "2026-07-20T10:00:00Z",
    "updated_at": "2026-07-20T10:00:00Z"
  }
}
Try it

Update Tax Rate

PATCH /api/v1/tax-rates/{tax_rate_id}

Only include the fields you want to change:

{
  "rate": "8.5",
  "is_active": false
}
Field Required Description
name No Display name
rate No Percentage as a decimal string
inclusive No Whether the rate is included in the price
jurisdiction No Jurisdiction label
is_active No Enable or disable the rate

Response 200 OK:

{
  "data": {
    "id": "txr_01ABC",
    "name": "California sales tax",
    "rate": "8.5",
    "inclusive": false,
    "jurisdiction": "US-CA",
    "is_active": false,
    "created_at": "2026-07-20T10:00:00Z",
    "updated_at": "2026-07-20T15:00:00Z"
  }
}
Try it

Delete Tax Rate

DELETE /api/v1/tax-rates/{tax_rate_id}

Response:

{
  "data": {
    "deleted": true
  }
}
Try it