Properties
| Name | Type | Description |
|---|---|---|
| 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 | Describes the fallback behavior 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 unt |
| 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 |
| should_use_geolocation_to_determine_guest_shopper_tax_zone | boolean | This setting determines which tax zone a store uses to estimate tax for guest shoppers. When enabled, the store identifies a country-level tax zone based on the geolocation of a guest shopper. The sto |
| guest_shopper_tax_zone_id | integer | ID for the tax zone a store uses when estimating tax for guest shoppers. The store uses this zone if you disable `should_use_geolocation_to_determine_guest_shopper_tax_zone`. The store also uses this |
| store_tax_zone_id | integer | ID for the tax zone a store uses when subtracting store tax. This setting applies only if a merchant enters tax-inclusive prices and subtracts store tax before tax calculation. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Tax_Settings",
"title": "Tax_Settings",
"type": "object",
"properties": {
"tax_entered_with_prices": {
"type": "boolean",
"description": "Whether prices entered on this store include a tax component or not."
},
"price_display_settings": {
"type": "object",
"description": "Settings that describe how prices display at the global level.",
"properties": {
"show_inclusive_in_control_panel": {
"type": "boolean",
"description": "Whether to show prices as tax inclusive or tax exclusive in the BigCommerce control panel."
},
"invoice_price_display_strategy": {
"type": "string",
"description": "Whether to show prices as tax inclusive or tax exclusive across all invoices, or use the shopper\u02bcs tax zone for price display on invoices.",
"default": "ZONE",
"enum": [
"ZONE",
"INCLUSIVE",
"EXCLUSIVE"
]
}
}
},
"fallback_strategy": {
"type": "string",
"description": "Describes the fallback behavior 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 they achieve a successful result.",
"default": "FIXED",
"enum": [
"FIXED",
"BASIC",
"DISABLE"
]
},
"should_subtract_store_tax": {
"default": true,
"type": "boolean",
"description": "This setting applies only if a merchant enters tax-inclusive prices. When enabled, the store subtracts the item\u02bcs store tax rate before calculating tax using the shopper\u02bcs 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\u02bcs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax."
},
"should_use_geolocation_to_determine_guest_shopper_tax_zone": {
"default": false,
"type": "boolean",
"description": "This setting determines which tax zone a store uses to estimate tax for guest shoppers. When enabled, the store identifies a country-level tax zone based on the geolocation of a guest shopper. The store then applies the corresponding tax zone to estimate taxes. When disabled, the store identifies the zone using the provided `guest_shopper_tax_zone_id` field instead. Only the tax zones you configure can be matched to the guest shopper's geolocation."
},
"guest_shopper_tax_zone_id": {
"default": 1,
"type": "integer",
"description": "ID for the tax zone a store uses when estimating tax for guest shoppers. The store uses this zone if you disable `should_use_geolocation_to_determine_guest_shopper_tax_zone`. The store also uses this zone if there is no matching country-level tax zone for the geolocation."
},
"store_tax_zone_id": {
"default": 1,
"type": "integer",
"description": "ID for the tax zone a store uses when subtracting store tax. This setting applies only if a merchant enters tax-inclusive prices and subtracts store tax before tax calculation."
}
}
}