Examples of the Tax Module

In this guide, you’ll find common examples of how you can use the Tax Module in your application.

Create a Tax Region

• Medusa API Router
• Next.js App Router

import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { ITaxModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"

export async function GET(
  req: MedusaRequest,
  res: MedusaResponse
): Promise<void> {
  const taxModuleService: ITaxModuleService = req.scope.resolve(
    ModuleRegistrationName.TAX
  )

  const taxRegion = await taxModuleService.createTaxRegions({
    country_code: "US",
    default_tax_rate: {
      rate: 10,
      name: "Default rate",
    },
  })

  res.json({
    tax_region: taxRegion,
  })
}

import { NextResponse } from "next/server"

import {
  initialize as initializeTaxModule,
} from "@medusajs/tax"

export async function POST(request: Request) {
  const taxModuleService = await initializeTaxModule()

  const taxRegion = await taxModuleService.createTaxRegions({
    country_code: "US",
    default_tax_rate: {
      rate: 10,
      name: "Default rate",
    },
  })

  return NextResponse.json({
    tax_region: taxRegion,
  })
}

---

List Tax Regions

• Medusa API Router
• Next.js App Router

import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { ITaxModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"

export async function GET(
  req: MedusaRequest,
  res: MedusaResponse
): Promise<void> {
  const taxModuleService: ITaxModuleService = req.scope.resolve(
    ModuleRegistrationName.TAX
  )

  res.json({
    tax_regions: await taxModuleService.list(),
  })
}

import { NextResponse } from "next/server"

import {
  initialize as initializeTaxModule,
} from "@medusajs/tax"

export async function GET(request: Request) {
  const taxModuleService = await initializeTaxModule()

  return NextResponse.json({
    tax_regions: await taxModuleService.list(),
  })
}

---

Create Tax Rate with Rules

• Medusa API Router
• Next.js App Router

import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { ITaxModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"

export async function POST(
  req: MedusaRequest,
  res: MedusaResponse
): Promise<void> {
  const taxModuleService: ITaxModuleService = req.scope.resolve(
    ModuleRegistrationName.TAX
  )

  const taxRate = await taxModuleService.create({
    tax_region_id: "txreg_123",
    name: "Custom rate",
    rate: 15,
    rules: [
      {
        reference: "product_type",
        reference_id: "ptyp_1",
      },
      {
        reference: "product",
        reference_id: "prod_123",
      },
    ],
  })

  res.json({
    tax_rate: taxRate,
  })
}

import { NextResponse } from "next/server"

import {
  initialize as initializeTaxModule,
} from "@medusajs/tax"

export async function POST(
  request: Request
) {
  const taxModuleService = await initializeTaxModule()

  const taxRate = await taxModuleService.create({
    tax_region_id: "txreg_123",
    name: "Custom rate",
    rate: 15,
    rules: [
      {
        reference: "product_type",
        reference_id: "ptyp_1",
      },
      {
        reference: "product",
        reference_id: "prod_123",
      },
    ],
  })

  return NextResponse.json({
    tax_rate: taxRate,
  })
}

---

List Tax Rates

• Medusa API Router
• Next.js App Router

import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { ITaxModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"

export async function GET(
  req: MedusaRequest,
  res: MedusaResponse
): Promise<void> {
  const taxModuleService: ITaxModuleService = req.scope.resolve(
    ModuleRegistrationName.TAX
  )

  res.json({
    tax_rates: await taxModuleService.list(),
  })
}

import { NextResponse } from "next/server"

import {
  initialize as initializeTaxModule,
} from "@medusajs/tax"

export async function GET(
  request: Request
) {
  const taxModuleService = await initializeTaxModule()

  return NextResponse.json({
    tax_rates: await taxModuleService.list(),
  })
}

---

Get Tax Lines

• Medusa API Router
• Next.js App Router

import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { ITaxModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/modules-sdk"

export async function POST(
  req: MedusaRequest,
  res: MedusaResponse
): Promise<void> {
  const taxModuleService: ITaxModuleService = req.scope.resolve(
    ModuleRegistrationName.TAX
  )

  const taxLines = await taxModuleService.getTaxLines(
    [
      {
        id: "cali_123",
        product_id: "prod_123",
        unit_price: 1000,
      },
      {
        id: "casm_123",
        shipping_option_id: "so_123",
        unit_price: 2000,
      },
    ],
    {
      address: {
        country_code: "us",
        postal_code: "123456",
      },
      customer: {
        id: "cus_123",
        email: "user@example.com",
        customer_groups: ["VIP"],
      },
    }
  )

  res.json({
    tax_lines: taxLines,
  })
}

import { NextResponse } from "next/server"

import {
  initialize as initializeTaxModule,
} from "@medusajs/tax"

export async function POST(
  request: Request
) {
  const taxModuleService = await initializeTaxModule()

  const taxLines = await taxModuleService.getTaxLines(
    [
      {
        id: "cali_123",
        product_id: "prod_123",
        unit_price: 1000,
      },
      {
        id: "casm_123",
        shipping_option_id: "so_123",
        unit_price: 2000,
      },
    ],
    {
      address: {
        country_code: "us",
        postal_code: "123456",
      },
      customer: {
        id: "cus_123",
        email: "user@example.com",
        customer_groups: ["VIP"],
      },
    }
  )

  return NextResponse.json({
    tax_lines: taxLines,
  })
}

---

More Examples

The module interface reference provides a reference to all the methods available for use with examples for each.