Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

options

CalculateTaxOptions

Calculates tax for the provided line items.

Tax is calculated for each line item based on the tax region (see TaxRegions API) that corresponds to the address provided in `lineItems.addressIndex` and the tax group (see TaxGroups API) in `taxGroupId`. If no tax region is found for the line item's address then no tax will be calculated for this line item. If no tax group with that `taxGroupId` is found then the default tax group is used to calculate tax. To check the default tax groups, use `listDefaultTaxGroups()` in the TaxGroups API.

The tax is calculated by a tax calculator app installed on the site.
Use `listTaxCalculators()` to see which tax calculators are available. To provide your own tax calculations, use the Tax Calculation service plugin.

The breakdown of calculated tax returned, includes:
+ `taxSummary`: The overall total tax calculated.
+ `taxSummary.aggregatedTaxBreakdown`: The total tax calculated for each jurisdiction.
+ `lineItemTaxDetails.taxSummary`: The total tax calculated for each line item.
+ `lineItemTaxDetails.taxBreakdown`: The tax calculated for each line item in each jurisdiction.

import { taxCalculation } from '@wix/billing';

async function calculateTax(options) {
  const response = await taxCalculation.calculateTax(options);
};

calculateTax: Wix-hosted

import { createClient } from '@wix/sdk';
import { taxCalculation } from '@wix/billing';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { taxCalculation },
  // Include the auth strategy and host as relevant
});


async function calculateTax(options) {
  const response = await myWixClient.taxCalculation.calculateTax(options);
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

calculateTax: Self-hosted

calculateTax

Manage eCommerce - all permissions

Manage Stores - all permissions

Manage Orders

Manage Restaurants - all permissions

CalculateTaxResponse

Retrieves a list of installed tax calculators.

Wix uses these calculators to `calculateTax()`.

import { taxCalculation } from '@wix/billing';

async function listTaxCalculators() {
  const response = await taxCalculation.listTaxCalculators();
};

listTaxCalculators: Wix-hosted

import { createClient } from '@wix/sdk';
import { taxCalculation } from '@wix/billing';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { taxCalculation },
  // Include the auth strategy and host as relevant
});


async function listTaxCalculators() {
  const response = await myWixClient.taxCalculation.listTaxCalculators();
};

listTaxCalculators: Self-hosted

listTaxCalculators

ListTaxCalculatorsResponse

---
title: Introduction
---

# Introduction

The Tax Calculation API allows you to retrieve the available tax calculators for a site and to calculate tax. Use the Tax Calculations API together with the
[Tax Groups API](https://dev.wix.com/docs/sdk/backend-modules/billing/tax-groups) and the
[Tax Regions API](https://dev.wix.com/docs/sdk/backend-modules/billing/tax-regions) to customize the application of tax for your business.

## Before you begin
It's important to note the following before starting to code:
+ Tax is calculated based on the [tax region](https://dev.wix.com/docs/sdk/backend-modules/billing/tax-regions) and a tax region requires an `appId` for an available tax calculator. Use [`listTaxCalculators()`](https://dev.wix.com/docs/sdk/backend-modules/billing/tax-calculation/list-tax-calculators) to retrieve a list of available tax calculators for a site, then create and manage your [tax regions](https://dev.wix.com/docs/sdk/backend-modules/billing/tax-regions) before [calculating tax](https://dev.wix.com/docs/sdk/backend-modules/billing/tax-calculation/calculate-tax).
+ You can provide additional tax calculations with the [Tax Calculation Integration service plugin](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-calculation-integration-service-plugin/introduction).

## Terminology
- **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. A site assigns each tax region to the Wix manual tax calculator or an external calculator app to properly calculate tax.
- **Wix manual tax calculator**: The default tax calculator installed with a Wix site. The tax rates to apply for this calculator can be manually adjusted in the [Tax Settings in the Wix dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fecom-platform/tax/).




To use the TaxCalculation API, install the `@wix/billing` package using npm or Yarn:
  ```console
npm install @wix/billing
```

or

```console
yarn add @wix/billing
```

Then import `{ taxCalculation }` from `@wix/billing`:

```js
import { taxCalculation } from '@wix/billing'
```
  

billing_tax-calculation

Address

Main address line, usually street and number as free text.

addressLine1

string

Free text providing more detailed address information, such as apartment, suite, or floor.

addressLine2

city

2-letter country code in [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.

country

postalCode

Subdivision (such as state, prefecture, or province) in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.

subdivision

AddressIndex

Multiple addresses to use for a sale. For example, some tax calculations may require both the address where an item is shipped from,
as well as the address the item is shipped to.

multipleAddresses

Single address to use for a sale location when only one address is required for tax calculations. The index is zero-based.

singleAddress

AggregatedTaxBreakdown

Total amount of this tax for this jurisdiction.

aggregatedTaxAmount

Jurisdiction that taxes were calculated for.

jurisdiction

Type of jurisdiction that taxes were calculated for.

jurisdictionType

JurisdictionType

Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`.

rate

taxName

taxType

ApplicationError

code

data

description

Array of addresses. Each line item can individually reference the address to apply with `lineItems.addressIndex`.

addresses

3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.

currency

Optional ID of the entity that tax is being calculated for. For example, a cart ID.

externalId

lineItems

Errors that occurred during the tax calculation.

errors

Details of each tax applied to each line item.

lineItemTaxDetails

taxSummary

TaxSummary

LineItem

Index of the address from `addresses` to use to calculate tax for this specific line item. The index is zero-based.

addressIndex

ID of the app providing the catalog for this line item.

You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).

For items from Wix catalogs, the following values always apply:
+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`

appId

Stock keeping unit for this line item. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).

itemCode

itemName

price

quantity

number

Tax group ID for this line item. If not provided, the default tax group applies.

taxGroupId

taxIncludedInPrice

boolean

LineItemTaxDetails

Array of each tax applied, grouped by `jurisdiction`.

taxBreakdown

Summary of this line item's total price and tax.

LineItemTaxSummary

ID of the calculator app that calculated tax for this line item.

Total price for this line item.
To determine the price for each individual unit of this line item, divide by `quantity`.

fullPrice

Total amount of tax calculated for this line item.

taxAmount

taxableAmount

taxCalculatorDetails

MultipleAddresses

destination

origin

TaxBreakdown

Type of jurisdiction that taxes were calculated for. For example, `"State"`, `"Çounty"`, `"City"`, `"Special"`, etc.

nonTaxableAmount

Amount of this tax calculated for this jurisdiction.

Name of the tax that was calculated. For example, `"NY State Sales Tax"`, `"Quebec GST"`, etc.

Type of tax that was calculated. For example, `"Sales Tax"`, `"Income Tax"`, `"Value Added Tax"`, etc.

TaxCalculatorDetails

displayName

List of countries, in [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format, that the calculator does not support.

unsupportedCountries

Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdiction_type"`, `"tax_type"`, `"tax_name"` and `"tax_rate"`.

aggregatedTaxBreakdown

totalAmount

Total amount of tax calculated for all line items.
Note that due to rounding, `totalTax` may not equal the sum of `lineItemTaxDetails.taxSummary.taxAmount`.

totalTax

Total amount of `totalTax` that is included in price. Applies to line items with `taxIncludedInPrice` set to `true`.

Setup