Skip to main content
POST
/
admin
/
tax-rates
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.taxRate.create({
  name: "VAT",
  tax_region_id: "txreg_123",
  code: "VAT",
  rate: 2, // 2%
})
.then(({ tax_rate }) => {
  console.log(tax_rate)
})
{
  "tax_rate": {
    "id": "<string>",
    "rate": 10,
    "code": "<string>",
    "name": "<string>",
    "metadata": {},
    "tax_region_id": "<string>",
    "is_combinable": true,
    "is_default": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "tax_region": {
      "id": "<string>",
      "country_code": "us",
      "province_code": "us-ca",
      "metadata": {},
      "parent_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "tax_rates": [
        {}
      ],
      "parent": {},
      "children": [
        {}
      ]
    },
    "rules": [
      {
        "reference": "product_type",
        "reference_id": "ptyp_1"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Body

application/json

The tax rate's details.

​
name
string
required

The tax rate's name.

Example:

"VAT"

​
tax_region_id
string
required

The ID of the tax region this rate belongs to.

​
code
string
required

The code the tax rate is identified by.

​
rate
number

The rate to charge.

Example:

10

​
rules
object[]

The tax rate's rules.

​
is_default
boolean

Whether the tax rate is the default in its tax region.

​
is_combinable
boolean

Whether the tax rate should be combined with parent rates.

​
metadata
object

The tax rate's metadata, used to store custom key-value pairs.

Response

OK

The tax rate's details.

​
tax_rate
object
required

The tax rate's details.