Tax Module

In this section of the documentation, you will find resources to learn more about the Tax Module and how to use it in your application.

Looking for no-code docs?Refer to the Medusa Admin User Guide to learn how to manage tax regions using the dashboard.

Medusa has tax related features available out-of-the-box through the Tax Module. A module is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Tax Module.

NoteLearn more about why modules are isolated in this documentation.

Tax Features#


How to Use Tax Module's Service#

In your Medusa application, you build flows around commerce modules. A flow is built as a Workflow, which is a special function composed of a series of steps that guarantees data consistency and reliable roll-back mechanism.

You can build custom workflows and steps. You can also re-use Medusa's workflows and steps, which are provided by the @medusajs/medusa/core-flows package.

For example:

src/workflows/create-tax-region.ts
1import { 2  createWorkflow, 3  WorkflowResponse,4  createStep,5  StepResponse,6} from "@medusajs/framework/workflows-sdk"7import { Modules } from "@medusajs/framework/utils"8
9const createTaxRegionStep = createStep(10  "create-tax-region",11  async ({}, { container }) => {12    const taxModuleService = container.resolve(Modules.TAX)13
14    const taxRegion = await taxModuleService.createTaxRegions({15      country_code: "us",16    })17
18    return new StepResponse({ taxRegion }, taxRegion.id)19  },20  async (taxRegionId, { container }) => {21    if (!taxRegionId) {22      return23    }24    const taxModuleService = container.resolve(Modules.TAX)25
26    await taxModuleService.deleteTaxRegions([taxRegionId])27  }28)29
30export const createTaxRegionWorkflow = createWorkflow(31  "create-tax-region",32  () => {33    const { taxRegion } = createTaxRegionStep()34
35    return new WorkflowResponse({ taxRegion })36  }37)

You can then execute the workflow in your custom API routes, scheduled jobs, or subscribers:

src/api/workflow/route.ts
5import { createTaxRegionWorkflow } from "../../workflows/create-tax-region"6
7export async function GET(8  req: MedusaRequest,9  res: MedusaResponse10) {11  const { result } = await createTaxRegionWorkflow(req.scope)12    .run()13
14  res.send(result)15}

Learn more about workflows in this documentation.


Configure Tax Module#

The Tax Module accepts options for further configurations. Refer to this documentation for details on the module's options.


Server Guides#

Learn how to use the Tax Module in your customizations on the Medusa application server.

Tax Provider Reference
Get Variant Price with Taxes

Storefront Guides#

Learn how to integrate the Tax Module's features into your storefront.

Example: Show Price with Taxes

References#

Find references for tools and resources related to the Tax Module, such as data models, methods, and more. These are useful for your customizations.

Workflows
JS SDK
Admin Widget Zones
Main Service Reference
Data Models Reference
Was this page helpful?
Edited Feb 26·Edit this page
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break