TaxRate

Source: src/Stripe/TaxRate.ts

A Stripe Tax Rate — a percent tax applied to invoices, subscriptions, and Checkout Sessions. percentage and inclusive are immutable and changing them replaces the tax rate. Display name, active, description, jurisdiction fields, and metadata update in place.

Stripe does not hard-delete tax rates; destroying this resource deactivates it (active: false).

Creating a Tax Rate

Exclusive sales tax

const vat = yield* Stripe.TaxRate("vat", {
  displayName: "VAT",
  percentage: 20,
  inclusive: false,
});

Inclusive tax with metadata

const gst = yield* Stripe.TaxRate("gst", {
  displayName: "GST",
  percentage: 10,
  inclusive: true,
  taxType: "gst",
  metadata: { region: "au" },
});

Updating a Tax Rate

const vat = yield* Stripe.TaxRate("vat", {
  displayName: "VAT (paused)",
  percentage: 20,
  inclusive: false,
  active: false,
  metadata: { region: "eu" },
});

Deactivating a Tax Rate

// stack.destroy() / resource removal sets active: false
const vat = yield* Stripe.TaxRate("vat", {
  displayName: "VAT",
  percentage: 20,
  inclusive: false,
});