Medusa

Create Tax Rule for a Rate

POST

/admin/tax-rates/{id}/rules

Tax Rates

Create a tax rule for a rate.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST '{{BASE_URL}}/admin/tax-rates//rules' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reference": "product_type",
    "reference_id": "ptype_123"
}'

Response Example

200 - Example 1

{
    "tax_rate": {
        "tax_region": {
            "id": "string",
            "country_code": "us",
            "metadata": {},
            "parent_id": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "created_by": "string",
            "parent": {},
            "province_code": "us-ca",
            "tax_rates": [
                {}
            ],
            "children": [
                {}
            ]
        },
        "id": "string",
        "rate": 10,
        "code": "string",
        "name": "string",
        "metadata": {},
        "tax_region_id": "string",
        "is_default": true,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "created_by": "string",
        "rules": [
            {
                "reference": "product_type",
                "reference_id": "ptyp_1"
            }
        ],
        "is_combinable": true
    }
}

Request

Authorization

Path Params

string

required

The tax rate's ID.

Query Params

fields

string

fields

optional

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 Params application/json

The tax rate rule's details.

reference

string

reference

required

The name of a table in the database that this rule points to.

Example:

product_type

reference_id

string

reference_id

required

The ID of a record in the table specified in reference.

Example:

ptype_123

Examples

Responses

🟢200OK

application/json

Body

The tax rate's details.

tax_rate

object (AdminTaxRate)

required

The tax rate's details.

tax_region

object (AdminTaxRegion)

required

The tax region's details.

string

required

The tax rate's ID.

rate

number

rate

required

The rate to charge.

Example:

code

string

code

required

The code the tax rate is identified by.

name

string

name

required

The tax rate's name.

metadata

object

required

The tax rate's metadata, can hold custom key-value pairs.

tax_region_id

string

tax_region_id

required

The ID of the tax region this rate belongs to.

is_default

boolean

is_default

required

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

created_at

string <date-time>

created_at

required

The date the tax rate was created.

updated_at

string <date-time>

updated_at

required

The date the tax rate was updated.

deleted_at

string <date-time>

deleted_at

required

The date the tax rate was deleted.

created_by

string

created_by

required

The ID of the user that created the tax rate.

rules

array[object (AdminTaxRateRule) {2}]

required

The tax rate's rules.

is_combinable

boolean

is_combinable

required

Whether the tax rate should be combined with parent rates.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:10:32

List Stores

Delete a Tax Rate