Tax Customers

The Tax Customers API allows merchants to configure customer-specific tax data for use in tax calculations. This enables merchants to provide tax providers with additional customer-related information that may affect tax rates or exemptions.

This guide demonstrates how to use the Tax Customers API. For more, see the Tax Customers API Reference.

Tax customers

Tax customers rely on customer_id to associate tax data with specific customers. This data is sent to tax providers during tax calculations. The examples below demonstrate how to create, update, retrieve, and delete tax customer data.

Get tax customers

To retrieve a list of tax customers, send a request to the Get Tax Customers endpoint. You can filter the results by specifying one or more customer_id values.

GET https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/tax/customers?customer_id:in=157,158
X-Auth-Token: {{ACCESS_TOKEN}}
Content-Type: application/json
Accept: application/json

Update tax customers

To add or update tax data for one or more customers, send a request to the Update Tax Customers endpoint. This operation overwrites any existing values for the specified customers.

PUT https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/tax/customers
X-Auth-Token: {{ACCESS_TOKEN}}
Content-Type: application/json
Accept: application/json
 
[
  {
    "customer_id": 157,
    "tax_properties": {
      "A-123456789": "30",
      "B-6731789": "250"
    }
  },
  {
    "customer_id": 159,
    "tax_properties": {
      "A-123456789": "10"
    }
  }
]

Delete tax customers

To delete tax data associated with one or more customers, send a request to the Delete Tax Customers endpoint. Use the customer_id:in query parameter to specify the customers whose tax data you want to delete.

DELETE https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/tax/customers?customer_id:in=157
X-Auth-Token: {{ACCESS_TOKEN}}
Content-Type: application/json
Accept: application/json

Resources

• Tax Customers API Reference
• Tax Properties API Reference
• Tax Provider API Reference