Tax Region Object


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.

Properties
appIdstringformat GUID

The tax calculator ID to use to calculate tax for this region.

Call List Tax Calculators to retrieve a list of available calculators for a site.


countrystringformat COUNTRYminLength 2

2-letter country code in ISO-3166 alpha-1 format.


createdDatestringRead-onlyformat date-time

Date and time the tax region was created.


idstringRead-onlyformat GUID

Tax region ID.


revisionstringRead-onlyformat int64

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.


subdivisionstringmaxLength 50

Subdivision (such as state, prefecture, or province) in ISO-3166 alpha-2 format.


taxIncludedInPriceboolean

Whether tax is included in the price.


updatedDatestringRead-onlyformat date-time

Date and time the tax region was last updated.

Did this help?