GET
/
admin
/
tax-rates
/
{id}
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.retrieve("txrat_123")
.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.

Path Parameters

id
string
required

The tax rate's ID.

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.

Response

200
application/json

OK

The tax rate's details.