About the Tax Calculation Service Plugin

The Tax Calculation service plugin (formerly SPI) allows you to integrate a custom tax calculation service with Wix. Use the Tax Calculation service plugin together with the Tax Groups API and the Tax Regions API to customize your tax calculations.

The integration is done via an app created in the app dashboard with the Tax Calculation service plugin.

Learn more about implementing an service plugin with Wix.

Use case

• Calculate tax for the United Kingdom

Terminology

• Tax Region: A location, defined by country and subdivision with a specific tax treatment. Tax is calculated based on the tax region and the tax group associated with a line item. See the Tax Regions API.
• Tax Group: A category of products that share the same tax treatment. Tax is calculated based on the tax group and the tax region associated with a line item. See the Tax Groups API.
• Tax Calculator: An app that is used under the hood to calculate tax for a Wix site. The app calculates tax based on the tax group of the product and the tax region of the sale. By integrating with the Tax Calculation service plugin, your app becomes a tax calculator.

Configuration

With the Tax Calculation service plugin integrated into your app, Wix will call your app with Calculate Tax whenever tax needs to be recalculated on a site. For example, when line items are updated in a cart or checkout. Follow these steps to add the service plugin and enable Wix to communicate with your app.

1. Go to Extensions in your app's dashboard.

2. Click + Create Extension in the top right.

3. Find Tax Calculation Provider and click + Create.

4. Use the JSON editor to create the extension's configuration file. Configure the parameters by referencing the table below or the Documentation section to the right of the editor. For each parameter, add the parameter name and value in the JSON editor.

   Name	Type	Description
   deploymentUri	string	Required. Base URI where the endpoints are called. Wix appends the endpoint path to the base URI. For example, to call the Calculate Tax endpoint at https://my-tax-calc.com/v1/calculateTax, the base URI you provide here is https://my-tax-calc.com/.
   calculatorDisplayName	string	Display name of the tax calculator.
   unsupportedCountries	array	List of countries, in ISO-3166 alpha-1 format, that the calculator does not support.
   componentName	string	A unique name for this component. This is an internal name that will only appear in the app dashboard.

5. Click Test Your App.