POST /v1/tax_rates/{tax_rate}

Updates an existing tax rate.

Servers

Path parameters

Name Type Required Description
tax_rate String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
jurisdiction String No

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

active Boolean No

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.

description String No

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

expand[] Array No

Specifies which fields in the response should be expanded.

tax_type String No

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

Possible values:

  • "pst"
  • "communications_tax"
  • "sales_tax"
  • "rst"
  • "qst"
  • "hst"
  • "vat"
  • "gst"
  • "amusement_tax"
  • "jct"
  • "lease_tax"
  • "retail_delivery_fee"
  • "igst"
  • "service_tax"
display_name String No

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

metadata No

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.

country String No

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

state String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.