Update Tax Rates | BigCommerce Developer Center

Update one or more tax rates. Only the tax rate id field is required. Fields unspecified by the request will retain their current state.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Information & Settings	modify	`store_v2_information`
Information & Settings	read-only	`store_v2_information_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Information & Settings | modify | `store_v2_information` | | Information & Settings | read-only | `store_v2_information_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Request

This endpoint expects a list of objects.

idintegerRequired

Tax Rate ID. Internal identifier to update and delete a specific tax rate.

class_rateslist of objectsOptional

Tax rates for tax classes. You must assign at least one tax rate for each tax class defined on a store.

enabledbooleanOptionalDefaults to true

Indicates whether a tax rate is enabled. Tax operations are only for enabled zones.

namestringOptional

The human-readable name for this tax zone. The name appears in the store control panel and may be visible to shoppers, depending on store tax settings.

priorityintegerOptionalDefaults to 1

Allows for compounding tax rates, common in certain jurisdictions.

tax_zone_idintegerOptional

ID of an associated tax zone. You must associate a tax rate with a tax zone.

Response

datalist of objects

metaobject

Response metadata.

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/tax/rates"
4
5	payload = [
6	{
7	"id": 3,
8	"class_rates": [
9	{
10	"rate": 10,
11	"tax_class_id": 0
12	}
13	],
14	"enabled": True,
15	"name": "Sales Tax",
16	"priority": 1,
17	"tax_zone_id": 2
18	}
19	]
20	headers = {
21	"X-Auth-Token": "<apiKey>",
22	"Content-Type": "application/json"
23	}
24
25	response = requests.put(url, json=payload, headers=headers)
26
27	print(response.json())

1	{
2	"data": [
3	{
4	"class_rates": [
5	{
6	"rate": 10,
7	"tax_class_id": 0
8	}
9	],
10	"enabled": true,
11	"id": 3,
12	"name": "Sales Tax",
13	"priority": 1,
14	"tax_zone_id": 2
15	}
16	],
17	"meta": {}
18	}