settings_tax_rates
Set or remove the tax rate for a place. Money is integer minor units (cents). Calling this changes nothing: it returns a preview of what would change and a confirmation link. Only the merchant, on that page, can make it happen.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | What it is called on the order: "Irish VAT", "NY sales tax". Required for a new rate; up to 60 characters. | |
| action | Yes | set: add a rate for the place, or change the one already there (only the fields given move). remove: delete the place's rate. | |
| country | Yes | ISO 3166-1 alpha-2, like PT or US. Empty or * is the catch-all for anywhere not named by another rate. | |
| rateBps | No | The rate in basis points: 23% is 2300, 8.875% is 888. Required for a new rate. | |
| province | No | State, county or region inside the country, as the checkout address spells it (CA, Dublin). Empty or * is the whole country. | |
| isEnabled | No | Whether the rate is applied at all; off keeps it in the list without charging it. New rates default to true. | |
| appliesToShipping | No | Whether the rate is charged on the delivery line as well as the goods. New rates default to true, the EU way. |