For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
        • Abandoned Carts
        • Carts
        • Channels
        • Checkouts
        • Currencies
        • Customer Segmentation
        • Geography
        • Infrastructure Hosting
        • Inventory
        • Orders
        • Order Operations
        • Pickup
        • Pickup Methods
        • Pickup Options
        • Pricing
        • Price Lists
        • Promotions
        • Promotion Settings
        • Redirects
        • Scripts
        • Settings
        • Shipping
        • Sites
        • Subscribers
        • System Logs
        • Tax
          • Tax Classes
              • GETList Tax Customers
              • PUTUpdate Tax Customers
              • DELDelete Tax Customers
        • Wishlists
      • Payments
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTAdminManagementTaxTax Customers

List Tax Customers

GET
https://api.bigcommerce.com/stores/:store_hash/v3/tax/customers
GET
/stores/:store_hash/v3/tax/customers
$curl https://api.bigcommerce.com/stores/store_hash/v3/tax/customers \
>     -H "X-Auth-Token: <apiKey>"
1{
2  "data": [
3    {
4      "customer_id": 157,
5      "tax_properties": {
6        "A-123456789": "26",
7        "B-6731789": "200"
8      }
9    }
10  ],
11  "meta": {}
12}
Retrieves a list of customer tax data.
Was this page helpful?
Previous

Get Tax Class

Next

Update Tax Customers

Built with

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Information & Settingsmodifystore_v2_information
Information & Settingsread-onlystore_v2_information_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Query parameters

customer_id:inlist of integersOptional

ID of customer. To target multiple customers, provide a comma-separated list of IDs such as 12,34,56.

Response

OK
datalist of objects
metaobject
Response metadata.

Errors

400
Bad Request Error