The Tax Regions API allows you to create and manage tax regions to apply different tax treatment based on location. Use the Tax Regions API together with the Tax Groups API and the Tax Calculation API to customize the application of tax for your business.
It's important to note the following before starting to code:
appId
for an available tax calculator. Use List Tax Calculators to retrieve a list of available tax calculators for a site.This article shares a possible use case your app could support, as well as a sample flow that could support the use case. This can be a helpful jumping off point as you plan your app's implementation.
When a business starts expanding its operations it needs to start charging tax in that new region.
To create a new tax region:
The following table shows field support for filters and sorting for the tax region object:
Field | Supported Filters | Sortable |
---|---|---|
id | $eq , $ne , $exists , $in , $hasSome , $startsWith | Sortable |
country | $eq , $ne , $exists , $in , $hasSome , $startsWith | Sortable |
subdivision | $eq , $ne , $exists , $in , $hasSome , $startsWith | Sortable |
appId | $eq , $ne , $exists , $in , $hasSome , $startsWith | Sortable |
createdDate | $eq , $ne , $exists , $in , $hasSome , $lt , $lte , $gt , $gte | Sortable |
updatedDate | $eq , $ne , $exists , $in , $hasSome , $lt , $lte , $gt , $gte | Sortable |
A tax region uses a location to define a specific tax treatment.
A location is defined by country
and subdivision
. The tax region also
dictates whether or not tax is included in the displayed price.
Tax region ID.
2-letter country code in ISO-3166 alpha-1 format.
Subdivision (such as state, prefecture, or province) in ISO-3166 alpha-2 format.
The tax calculator ID to use to calculate tax for this region.
Use List Tax Calculators to retrieve a list of available calculators for your site.
Whether tax is included in the price.
Revision number, which increments by 1 each time the tax region is updated. To prevent conflicting changes, the current revision must be passed when updating the tax region.
Ignored when creating a tax region.
Date and time the tax region was created.
Date and time the tax region was last updated.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a tax region.
Tax regions require a tax calculator appId
. Use
List Tax Calculators
to retrieve a list of available calculators for a site.
Wix uses tax regions to calculate tax.
You can only call this method when authenticated as a Wix app or Wix user identity.
Tax region to create.
Created tax region.
Creates a TaxRegion with basic info
curl --location 'https://www.wixapis.com/billing/v1/tax-regions' \
--header 'accept: application/json, text/plain, */*' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'authorization: <AUTH>' \
--header 'content-type: application/json' \
--data '{"taxRegion":{"country":"IE","appId":"7516f85b-0868-4c23-9fcb-cea7784243df","subdivision":"CN"}}'
{
"taxRegion": {
"id": "88a175be-7cc3-427d-bd79-d9aa21b10108",
"country": "IE",
"subdivision": "CN",
"appId": "7516f85b-0868-4c23-9fcb-cea7784243df",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-02-06T07:48:26.246Z",
"updatedDate": "2024-02-06T07:48:26.246Z"
}
}
There is 1 error with this status code:
There is 1 error with this status code:
There is 1 error with this status code:
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a tax region.
ID of the tax region to retrieve.
Retrieved tax region.
Gets a TaxRegion by id
curl --location 'https://www.wixapis.com/billing/v1/tax-regions/88a175be-7cc3-427d-bd79-d9aa21b10108' \
--header 'accept: application/json, text/plain, */*' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'authorization: <AUTH>' \
--header 'content-type: application/json' \
{
"taxRegion": {
"id": "88a175be-7cc3-427d-bd79-d9aa21b10108",
"country": "IE",
"subdivision": "CN",
"appId": "7516f85b-0868-4c23-9fcb-cea7784243df",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-02-06T07:48:26.246Z",
"updatedDate": "2024-02-06T07:48:26.246Z"
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deletes a tax region.
When a tax region is deleted, tax is not calculated and zero tax will be returned for addresses in this region.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of the tax region to delete.
Deletes TaxRegion by id
curl --location --request DELETE 'https://www.wixapis.com/billing/v1/tax-regions/88a175be-7cc3-427d-bd79-d9aa21b10108' \
--header 'accept: application/json, text/plain, */*' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'authorization: <AUTH>' \
--header 'content-type: application/json' \
{}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Updates a tax region.
Each time the tax region is updated, revision
increments by 1.
The current revision
must be passed when updating the tax region.
This ensures you're working with the latest tax region and prevents
unintended overwrites.
You can only call this method when authenticated as a Wix app or Wix user identity.
Tax region ID.
Tax region info to update.
Updated tax region.
Updates TaxRegion fields by id and revision
curl --location --request PATCH 'https://manage.wix.com/billing/v1/tax-regions/55c5da29-5a9c-48f6-bfbd-16d61cc23441' \
--header 'accept: application/json, text/plain, */*' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'authorization: <AUTH>' \
--header 'Content-Type: text/plain' \
--data '{"taxRegion":{"id":"55c5da29-5a9c-48f6-bfbd-16d61cc23441","country":"RU","subdivision":"ALT","appId":"7516f85b-0868-4c23-9fcb-cea7784243df","taxIncludedInPrice":false,"revision":"1","createdDate":"2024-01-28T07:56:11.570Z","updatedDate":"2024-01-28T07:56:11.570Z"}}'
{
"taxRegion": {
"id": "55c5da29-5a9c-48f6-bfbd-16d61cc23441",
"country": "RU",
"subdivision": "ALT",
"appId": "7516f85b-0868-4c23-9fcb-cea7784243df",
"taxIncludedInPrice": false,
"revision": "2",
"createdDate": "2024-01-28T07:56:11.570Z",
"updatedDate": "2024-02-06T08:15:56.768Z"
}
}
There is 1 error with this status code:
There is 1 error with this status code:
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of tax regions, given the provided paging, filtering, and sorting.
For field support for filters and sorting, see Tax Regions: Supported Filters and Sorting.
To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.
Query options.
Retrieved tax regions.
Paging metadata.
Returns all existing Tax Regions with basic info
curl --location 'https://www.wixapis.com/billing/v1/tax-regions/query' \
--header 'accept: application/json, text/plain, */*' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'authorization: <AUTH>' \
--header 'content-type: application/json' \
--data '{"query":{"cursorPaging":{},"sort":[{"fieldName":"createdDate","order":"DESC"}]}}'
{
"taxRegions": [
{
"id": "88a175be-7cc3-427d-bd79-d9aa21b10108",
"country": "IE",
"subdivision": "CN",
"appId": "7516f85b-0868-4c23-9fcb-cea7784243df",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-02-06T07:48:26.246Z",
"updatedDate": "2024-02-06T07:48:26.246Z"
},
{
"id": "5a073dd1-b44d-45f9-a396-9f027ebef98d",
"country": "IL",
"subdivision": "*",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-02-06T07:14:08.790Z",
"updatedDate": "2024-02-06T07:14:08.790Z"
},
{
"id": "4dc867ff-a989-4e54-9402-a46b0a8a2f6c",
"country": "GB",
"subdivision": "*",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-02-05T15:16:40.020Z",
"updatedDate": "2024-02-05T15:16:40.020Z"
},
{
"id": "55c5da29-5a9c-48f6-bfbd-16d61cc23441",
"country": "RU",
"subdivision": "ALT",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.570Z",
"updatedDate": "2024-01-28T07:56:11.570Z"
},
{
"id": "1611c351-680a-401e-8d0e-b6cdca7dd5b8",
"country": "RU",
"subdivision": "ORL",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.276Z",
"updatedDate": "2024-01-28T07:56:11.276Z"
},
{
"id": "0cc082ca-6a09-4b0c-9433-db89ad0e0f5c",
"country": "RU",
"subdivision": "IN",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.275Z",
"updatedDate": "2024-01-28T07:56:11.275Z"
},
{
"id": "b8295dc6-9706-4d0e-892b-0a40e862e688",
"country": "RU",
"subdivision": "VLG",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.275Z",
"updatedDate": "2024-01-28T07:56:11.275Z"
},
{
"id": "1affc1c1-9e69-471f-81e2-9096f2954afe",
"country": "RU",
"subdivision": "VOR",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.270Z",
"updatedDate": "2024-01-28T07:56:11.270Z"
},
{
"id": "3cdd1033-94ba-41ce-8ae1-7b8519c09bee",
"country": "RU",
"subdivision": "ULY",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.268Z",
"updatedDate": "2024-01-28T07:56:11.268Z"
},
{
"id": "db45b137-3dec-44d3-bb2c-3fae3dde9cfa",
"country": "RU",
"subdivision": "VGG",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.268Z",
"updatedDate": "2024-01-28T07:56:11.268Z"
},
{
"id": "f11d4d9c-0489-4514-beea-d6c88ed5b258",
"country": "RU",
"subdivision": "AST",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.266Z",
"updatedDate": "2024-01-28T07:56:11.266Z"
},
{
"id": "1b7ebaf5-cace-435e-abb5-be46651d1a06",
"country": "RU",
"subdivision": "UD",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.265Z",
"updatedDate": "2024-01-28T07:56:11.265Z"
},
{
"id": "3b28a30d-aaa8-4578-b6e3-861911491fed",
"country": "RU",
"subdivision": "NEN",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.265Z",
"updatedDate": "2024-01-28T07:56:11.265Z"
},
{
"id": "ead91e81-1f17-42fd-a729-60001c3b8fc8",
"country": "RU",
"subdivision": "TUL",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.265Z",
"updatedDate": "2024-01-28T07:56:11.265Z"
},
{
"id": "397f9d75-495a-4320-ba63-591177d4e4c3",
"country": "RU",
"subdivision": "ME",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.264Z",
"updatedDate": "2024-01-28T07:56:11.264Z"
},
{
"id": "453919cf-3c43-4af1-bf7c-43a96c3283da",
"country": "RU",
"subdivision": "VLA",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.264Z",
"updatedDate": "2024-01-28T07:56:11.264Z"
},
{
"id": "94383f50-f0aa-4d52-9f3d-1d09cc7cd754",
"country": "RU",
"subdivision": "NVS",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.264Z",
"updatedDate": "2024-01-28T07:56:11.264Z"
},
{
"id": "995810a0-ef76-4603-b688-2bce71fac9d6",
"country": "RU",
"subdivision": "TOM",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.264Z",
"updatedDate": "2024-01-28T07:56:11.264Z"
},
{
"id": "a5a08f20-1088-4649-b593-615acbfa1cb1",
"country": "RU",
"subdivision": "NIZ",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.264Z",
"updatedDate": "2024-01-28T07:56:11.264Z"
},
{
"id": "bb5ca70b-f83b-4336-9555-13d5eea7a1c9",
"country": "RU",
"subdivision": "CHE",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.264Z",
"updatedDate": "2024-01-28T07:56:11.264Z"
},
{
"id": "05bf83af-b957-4934-9fd9-a22b2ec25990",
"country": "RU",
"subdivision": "MOW",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.263Z",
"updatedDate": "2024-01-28T07:56:11.263Z"
},
{
"id": "620e9b93-da83-4644-90d5-0e8aedf87ee0",
"country": "RU",
"subdivision": "YEV",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.263Z",
"updatedDate": "2024-01-28T07:56:11.263Z"
},
{
"id": "92701350-da81-40a9-aca3-a177e885205a",
"country": "RU",
"subdivision": "BU",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.263Z",
"updatedDate": "2024-01-28T07:56:11.263Z"
},
{
"id": "b4f3ae0f-7632-4df1-9cdc-d6ef16571380",
"country": "RU",
"subdivision": "KC",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.263Z",
"updatedDate": "2024-01-28T07:56:11.263Z"
},
{
"id": "88ed06f2-5348-4233-a23f-d4e8c4ac7a1e",
"country": "RU",
"subdivision": "NGR",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.070Z",
"updatedDate": "2024-01-28T07:56:11.070Z"
},
{
"id": "7b63403f-a86f-4efe-a84c-82a06f74b1ab",
"country": "RU",
"subdivision": "BRY",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.069Z",
"updatedDate": "2024-01-28T07:56:11.069Z"
},
{
"id": "b1d35630-c0c1-45ce-add0-c01ccf4c035b",
"country": "RU",
"subdivision": "IRK",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:11.068Z",
"updatedDate": "2024-01-28T07:56:11.068Z"
},
{
"id": "100033c7-7126-4127-a6a4-69152e3f2156",
"country": "RU",
"subdivision": "KGN",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.965Z",
"updatedDate": "2024-01-28T07:56:10.965Z"
},
{
"id": "67d3a422-e9fd-40f5-850d-eb06df7af9f9",
"country": "RU",
"subdivision": "LIP",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.771Z",
"updatedDate": "2024-01-28T07:56:10.771Z"
},
{
"id": "2aaae893-79a0-40e1-bf9e-7c33b8bb26bf",
"country": "RU",
"subdivision": "ROS",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.770Z",
"updatedDate": "2024-01-28T07:56:10.770Z"
},
{
"id": "9873c48c-26b9-42f8-af83-1083a3ef824b",
"country": "RU",
"subdivision": "AD",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.766Z",
"updatedDate": "2024-01-28T07:56:10.766Z"
},
{
"id": "c2e70572-f4cd-4e7f-ad36-67b388af2ffd",
"country": "RU",
"subdivision": "SVE",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.676Z",
"updatedDate": "2024-01-28T07:56:10.676Z"
},
{
"id": "a73ee56b-243a-45fb-b851-497fbf1ba9cf",
"country": "RU",
"subdivision": "CU",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.578Z",
"updatedDate": "2024-01-28T07:56:10.578Z"
},
{
"id": "5b5d5040-dd85-4792-9111-24a0a7c73cf9",
"country": "RU",
"subdivision": "AMU",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.576Z",
"updatedDate": "2024-01-28T07:56:10.576Z"
},
{
"id": "d5ae6cfd-46d6-4575-b9dc-abba0da2deb2",
"country": "RU",
"subdivision": "TYU",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.574Z",
"updatedDate": "2024-01-28T07:56:10.574Z"
},
{
"id": "d6638a9d-ebfa-413d-83bc-8fc380451dc9",
"country": "RU",
"subdivision": "MUR",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.564Z",
"updatedDate": "2024-01-28T07:56:10.564Z"
},
{
"id": "50404d9d-41ac-4fe0-b1fe-364a2dcdc24a",
"country": "RU",
"subdivision": "PER",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.562Z",
"updatedDate": "2024-01-28T07:56:10.562Z"
},
{
"id": "f1b8d4dc-80c8-454c-91e7-b941642ce540",
"country": "RU",
"subdivision": "KEM",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.562Z",
"updatedDate": "2024-01-28T07:56:10.562Z"
},
{
"id": "b42041e7-7853-43cf-9d89-7b461a15dcad",
"country": "RU",
"subdivision": "SAM",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.475Z",
"updatedDate": "2024-01-28T07:56:10.475Z"
},
{
"id": "293215f8-4ad4-42c1-b0c0-dd0c945cded6",
"country": "RU",
"subdivision": "KRS",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.474Z",
"updatedDate": "2024-01-28T07:56:10.474Z"
},
{
"id": "1c0556b6-8c7c-4910-95a6-8984dddf0a59",
"country": "RU",
"subdivision": "ZAB",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.473Z",
"updatedDate": "2024-01-28T07:56:10.473Z"
},
{
"id": "39736633-6ae1-442f-a3b8-eb00cdc6a71a",
"country": "RU",
"subdivision": "KB",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.369Z",
"updatedDate": "2024-01-28T07:56:10.369Z"
},
{
"id": "b87e5b89-52f1-426b-a720-8585e7d40135",
"country": "RU",
"subdivision": "TY",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.286Z",
"updatedDate": "2024-01-28T07:56:10.286Z"
},
{
"id": "a4c8c647-1f27-465f-a567-d2c4844c295d",
"country": "RU",
"subdivision": "KK",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.285Z",
"updatedDate": "2024-01-28T07:56:10.285Z"
},
{
"id": "1875514d-4f9d-4558-830c-781e213aa9f8",
"country": "RU",
"subdivision": "DVD",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.284Z",
"updatedDate": "2024-01-28T07:56:10.284Z"
},
{
"id": "9f08cf54-4b10-41d8-8500-ef400ad5f7a7",
"country": "RU",
"subdivision": "YAN",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.283Z",
"updatedDate": "2024-01-28T07:56:10.283Z"
},
{
"id": "d96ee832-2f05-40d8-b1e7-8cbba5af2fcb",
"country": "RU",
"subdivision": "KIR",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.163Z",
"updatedDate": "2024-01-28T07:56:10.163Z"
},
{
"id": "189396d6-f41a-414a-8c0a-f5c533119c48",
"country": "RU",
"subdivision": "ORE",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.073Z",
"updatedDate": "2024-01-28T07:56:10.073Z"
},
{
"id": "fc72cd68-9bbe-4ba3-83fa-3ed62910676b",
"country": "RU",
"subdivision": "BEL",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.073Z",
"updatedDate": "2024-01-28T07:56:10.073Z"
},
{
"id": "f10083f9-e4dd-4125-8104-862a060fdc5a",
"country": "RU",
"subdivision": "CHU",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-01-28T07:56:10.069Z",
"updatedDate": "2024-01-28T07:56:10.069Z"
}
],
"pagingMetadata": {
"count": 50,
"cursors": {
"next": "bf320316c1c09f31d485f5bc4d566d6acc2f15a2.Gi0KDF9jcmVhdGVkRGF0ZRABGhsqGQoXCgokdGltZXN0YW1wEgkRAFCdGfHUeEIiJGYxMDA4M2Y5LWU0ZGQtNDEyNS04MTA0LTg2MmEwNjBmZGM1YQ"
},
"hasNext": true
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.billing.v1.tax_region
.
Event name. Expected created
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.billing.v1.tax_region_created",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "675c7555-45f9-49d4-b7a3-c1e56d2ee979",
"entityFqdn": "wix.billing.v1.tax_region",
"slug": "created",
"entityId": "5a073dd1-b44d-45f9-a396-9f027ebef98d",
"createdEvent": {
"entity": {
"id": "5a073dd1-b44d-45f9-a396-9f027ebef98d",
"country": "IL",
"subdivision": "*",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "1",
"createdDate": "2024-02-06T07:14:08.790Z",
"updatedDate": "2024-02-06T07:14:08.790Z"
}
},
"eventTime": "2024-02-06T07:14:08.797583507Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "1"
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a tax region is updated.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.billing.v1.tax_region
.
Event name. Expected updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.billing.v1.tax_region_updated",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "996dc2fc-bd7f-460f-975d-c350c00f3ded",
"entityFqdn": "wix.billing.v1.tax_region",
"slug": "updated",
"entityId": "037cae81-5550-4249-a13f-41bf465e3046",
"updatedEvent": {
"currentEntity": {
"id": "037cae81-5550-4249-a13f-41bf465e3046",
"country": "RU",
"subdivision": "KDA",
"appId": "57d13128-4a4c-494b-80b3-a6fb2e28018d",
"taxIncludedInPrice": false,
"revision": "3",
"createdDate": "2024-01-28T07:56:10.071Z",
"updatedDate": "2024-02-05T14:41:09.711Z"
}
},
"eventTime": "2024-02-05T14:41:09.721029391Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "3"
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a tax region is deleted.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.billing.v1.tax_region
.
Event name. Expected deleted
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.billing.v1.tax_region_deleted",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "23fae54c-9206-40d2-afe5-a593c80a71ef",
"entityFqdn": "wix.billing.v1.tax_region",
"slug": "deleted",
"entityId": "840a4bde-4a84-44c5-abdd-3cd3320a21d9",
"deletedEvent": {
"movedToTrash": true
},
"eventTime": "2024-02-06T07:12:56.447690894Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "2"
}