Thanks for being patient while we implement your feedback to improve the developer experience.

Tax Settings

Manage tax settings

Get Tax Settings

GET /tax/settings

Request

Retrieves global-level tax settings.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string - required

    The MIME type of the response body.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/tax/settings' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

OK

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

{
  "data": {
    "tax_entered_with_prices": true,
    "price_display_settings": {
      "show_inclusive_in_control_panel": true,
      "invoice_price_display_strategy": "ZONE"
    },
    "fallback_strategy": "FIXED",
    "should_subtract_store_tax": true
  },
  "meta": {}
}

Update Tax Settings

PUT /tax/settings

Request

Updates global-level tax settings.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

Body

object | application/json

  • tax_entered_with_prices    boolean

    Whether prices entered on this store include a tax component or not.

  • price_display_settings    object

    Settings that describe how prices display at the global level.

  • fallback_strategy    string

    Decribes the fallback behaviour that applies when a tax provider produces an error. A merchant may decide to use a flat 10% fallback tax rate, their basic tax settings, or to block the transaction until a successful result can be achieved.

    Allowed: FIXED | BASIC | DISABLE

  • should_subtract_store_tax    boolean

    This setting applies only if a merchant enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax.

    Default: true

example

{
  "tax_entered_with_prices": true,
  "price_display_settings": {
    "show_inclusive_in_control_panel": true,
    "invoice_price_display_strategy": "ZONE"
  },
  "fallback_strategy": "FIXED",
  "should_subtract_store_tax": true
}

Response

OK

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

{
  "data": {
    "tax_entered_with_prices": true,
    "price_display_settings": {
      "show_inclusive_in_control_panel": true,
      "invoice_price_display_strategy": "ZONE"
    },
    "fallback_strategy": "FIXED",
    "should_subtract_store_tax": true
  },
  "meta": {}
}