ISO 3166-2 subdivision code without country prefix (e.g., 'NY' for New York).
activeboolean
Whether the tax rate is active. Inactive rates cannot be used with new applications but continue to work for existing subscriptions. Defaults to true.
countrystring
Two-letter ISO 3166-1 alpha-2 country code (e.g., 'US', 'CA').
metadataobject
Set of key-value pairs for storing additional structured information.
tax_typestring
The type of 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.
inclusiveboolean
Required
Whether the tax is included in the price (true) or added on top (false).
percentagenumber
Required
The tax percentage value (e.g., 8.5 for 8.5%). This value is out of 100.
descriptionstring
An arbitrary string for internal use only. Not displayed to customers.
display_namestring
Required
The display name of the tax rate shown to users. Maximum 50 characters.
jurisdictionstring
The jurisdiction for the tax rate. Maximum 50 characters. Displayed on customer invoices for reporting purposes.
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