| Field | Required/Optional | Description | Valid values |
|---|---|---|---|
| st_vendors | Required | Define which tax engine is used for this specific merchant. | avalara (default), vertex, vindicia |
| action_on_tax_failure_id | Optional | Determine what the system behavior should be in case of tax vendor outage. | null or 0 - proceed with inclusive taxes (taxes will be calculated from the amount, not added) 1- proceed without taxes 2 - fall with error |
| merchant_tax_exempt | Optional | This is a global setting for the merchant, defining whether their transactions are tax exempt, and, therefore, whether Subscribe should calculate taxes (for both one-time and recurring transactions). | 0: Transactions are taxable (Default) 1: Transaction are tax exempt. |
| address_priority | Required | Define the address type priority for utilization during tax calculation. The address type is evaluated in the order indicated - meaning if there is no address defined for 1st address type ,the 2nd address type will be used and then the third. Users can define a different sequence or omit a letter to indicate to ignore a type of address | sbps- shipping address. For a subscription, this is the address provided when creating the account. For a one time purchase, this is the address passed on the purchase (transaction) in the shipping address ; b- Billing address. For a subscription, this will be the address defined on the payment method, for a one time purchase, this will be defined on the transaction source payment method billing address p - payment method address for one time transaction |
| st_call_logging | Indicates whether to log all the calls to a tax vendor for this merchant. By default we are logging only failures that are in the transport level. This value overrides the settings of the stack_conf variable of the almost-the-same namestv_call_logging (which will log for all merchants). Note: This impacts only tax calculations not tax commits calls | null or 0 - do not log (default)1 - log | |
| st_verified | This is a system generated item. Will hold the date when the credentials were last verified. | It is a best practice to verify the settings when the merchant is set, or every time the credentials are changed | |
| st_sanitize | Regular expression to identify fields in TaxVendors API’s to skip sanitization ( removing known bad data - like trailing and leading spaces). | null (default) any regex definedRegular expression Example: ^Item \d+ ItemCode$ | |
| st_sanitize_addr_alert | Optional | Currently only four countries are known (to tax vendors) to use anything but the country code in calculating taxes: Brazil, Canada, India, and the United States.This option allows to change the default countries above for which we are sanitizing the address. The settings will include a list of countries codes, space separated | Empty.When not set, the system level are used (e.g - FR US) which will flip the system settings. In this example, the list of countries that ultimately will be used is - BR,FR, CA and IN |
| st_no_nvperrors | Normally tax errors (“Unknown country”) are reported as named values (“vin:TaxError_1”) attached to transaction. In case a merchant doesn’t want to get the values, they can set this merchant option. | Null or 0 | |
| st_country_substitution | Note: Only relevant for merchants that operate in the UK A specific situation for the Channel Islands, where UK postal codes starting with GY will be identified with the Channel Island country code instead of the GB country code. | The value can be : Null or ) - to not substitute or 1 to do | |
| Parent topic:Taxes |
Generic Tax Settings
These settings should be configured for all merchants regardless of the tax vendor in use.