Sign in

v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Update Tax Zone Rate

patch/sites/multiscreen/{site_name}/ecommerce/tax-zones/{zone_id}/rates/{rate_id}

Path parameters

site_namestring required

The unique identifier for the target site.

zone_idstring required

The unique identifier for the tax zone.

rate_idstring required

The unique identifier for the tax rate.

Request body

namestring required

Display name of the tax rate. This will be displayed in the merchant’s orders dashboard.

ratestring required

Decimal string of the tax applied on a given price e.g., "0.05".

tax_group_overridesobject

Key/Value pair of Tax Group IDs and a Decimal String. e.g., { "tg_123": "0.05" }

tax_number_for_invoicestring

String displayed alongside invoices tax line item breakdowns.

Response

200

idstring
namestring
rateinteger
tax_number_for_invoicestring

Example response

{
  "id": "string",
  "name": "string",
  "tax_number_for_invoice": "string"
}