ISO 3166-2 subdivision code without country prefix (e.g., 'NY' for New York in the US, 'ON' for Ontario in Canada).
activeboolean
Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions.
countrystring
Two-letter country code per ISO 3166-1 alpha-2 standard.
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.
tax_typestring
The high-level tax type, such as vat or sales_tax. One of: amusement_tax, communications_tax, gst, hst, igst, jct, lease_tax, pst, qst, retail_delivery_fee, rst, sales_tax, service_tax, or vat.
descriptionstring
An arbitrary string attached to the tax rate for your own reference. It is not visible to your customers.
tax_rate_idstring
Required
The unique identifier of the tax rate to update.
display_namestring
The display name of the tax rate as shown to customers on receipts and invoices. Maximum 50 characters.
jurisdictionstring
The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. Maximum 50 characters.
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not