> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetTaxRegion # Package: tax # Namespace: TaxRegionsService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/extensions/tax/tax-regions/get-tax-region.md ## Permission Scopes: Manage Orders: SCOPE.DC-STORES.MANAGE-ORDERS ## Introduction Retrieves a tax region. --- ## REST API ### Schema ``` Method: getTaxRegion Description: Retrieves a tax region. URL: https://www.wixapis.com/billing/v1/tax-regions/{taxRegionId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: taxRegionId Method parameters: param name: taxRegionId | type: none | required: true Return type: GetTaxRegionResponse - name: taxRegion | type: TaxRegion | description: Retrieved tax region. - name: id | type: string | description: Tax region GUID. - name: country | type: string | description: 2-letter country code in [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. - name: subdivision | type: string | description: Subdivision (such as state, prefecture, or province) in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. - name: appId | type: string | description: The tax calculator GUID to use to calculate tax for this region. Call List Tax Calculators to retrieve a list of available calculators for a site. - name: taxIncludedInPrice | type: boolean | description: Whether tax is included in the price. - name: revision | type: string | description: 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. - name: createdDate | type: string | description: Date and time the tax region was created. - name: updatedDate | type: string | description: Date and time the tax region was last updated. ``` ### Examples ### Get Tax Region Retrieve a tax region by ID ```curl curl -X GET \ 'https://www.wixapis.com/billing/v1/tax-regions/88a175be-7cc3-427d-bd79-d9aa21b10108' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.tax.TaxRegionsService.getTaxRegion(taxRegionId) Description: Retrieves a tax region. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: taxRegionId Method parameters: param name: taxRegionId | type: string | description: GUID of the tax region to retrieve. | required: true Return type: PROMISE - name: _id | type: string | description: Tax region GUID. - name: country | type: string | description: 2-letter country code in [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. - name: subdivision | type: string | description: Subdivision (such as state, prefecture, or province) in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. - name: appId | type: string | description: The tax calculator GUID to use to calculate tax for this region. Call List Tax Calculators to retrieve a list of available calculators for a site. - name: taxIncludedInPrice | type: boolean | description: Whether tax is included in the price. - name: revision | type: string | description: 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. - name: _createdDate | type: Date | description: Date and time the tax region was created. - name: _updatedDate | type: Date | description: Date and time the tax region was last updated. ``` ### Examples ### getTaxRegion ```javascript import { taxRegions } from '@wix/ecom'; async function getTaxRegion(taxRegionId) { const response = await taxRegions.getTaxRegion(taxRegionId); }; ``` ### getTaxRegion (with elevated permissions) ```javascript import { taxRegions } from '@wix/ecom'; import { auth } from '@wix/essentials'; async function myGetTaxRegionMethod(taxRegionId) { const elevatedGetTaxRegion = auth.elevate(taxRegions.getTaxRegion); const response = await elevatedGetTaxRegion(taxRegionId); } ``` ### getTaxRegion (self-hosted) 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.md). ```javascript import { createClient } from '@wix/sdk'; import { taxRegions } from '@wix/ecom'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { taxRegions }, // Include the auth strategy and host as relevant }); async function getTaxRegion(taxRegionId) { const response = await myWixClient.taxRegions.getTaxRegion(taxRegionId); }; ``` ---