Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Update a tax rate 

Products
Tax Rate
Update a tax rate

Updates an existing tax rate.

Parameters

  • activeboolean

    Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

  • countrystring

    Two-letter country code (ISO 3166-1 alpha-2).

  • descriptionstring

    An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

  • display_namestring

    The display name of the tax rate, which will be shown to users.

  • jurisdictionstring

    The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • statestring

    ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

More parameters

  • tax_typeenum

    The high-level tax type, such as vat or sales_tax.

    Possible enum values
    amusement_tax

    Amusement Tax

    communications_tax

    Communications Tax

    gst

    Goods and Services Tax

    hst

    Harmonized Sales Tax

    igst

    Integrated Goods and Services Tax

    jct

    Japanese Consumption Tax

    lease_tax

    Chicago Lease Tax

    pst

    Provincial Sales Tax

    qst

    Quebec Sales Tax

    retail_delivery_fee

    Retail Delivery Fee

    Show 3 more

Returns

The updated tax rate.

POST /v1/tax_rates/:id
curl https://api.stripe.com/v1/tax_rates/txr_1MzS4RLkdIwHu7ixwvpZ9c2i \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d active=false
Response
{
  "id": "txr_1MzS4RLkdIwHu7ixwvpZ9c2i",
  "object": "tax_rate",
  "active": false,
  "country": null,
  "created": 1682114687,
  "description": "VAT Germany",
  "display_name": "VAT",
  "effective_percentage": 16,
  "inclusive": false,
  "jurisdiction": "DE",
  "livemode": false,
  "metadata": {},
  "percentage": 16,
  "state": null,
  "tax_type": null
}