TaxRates
Represents the tax rates applied to invoices, subscriptions, and Checkout sessions to collect tax, including the percentage, jurisdiction, and tax type details.
Table-Specific Information
SELECT
The component uses the Stripe API to filter the results by the following columns and operators:
| Column | Supported Operators |
| Id | = |
| Active | = |
| Created | >, >=, <, <=, = |
| Inclusive | = |
| AccountId | = |
The rest of the filter is executed client-side within the component.
You can select from the TaxRates table with the following queries:
SELECT * FROM TaxRates WHERE Id = '123124'
SELECT * FROM TaxRates WHERE Active = 'true'
SELECT * FROM TaxRates WHERE Created >= '2023-07-14T05:36:46.000-04:00'
SELECT * FROM TaxRates WHERE Inclusive = 'true'
INSERT
To create a new tax rate:
INSERT INTO TaxRates (Active, Country, Description, DisplayName, Inclusive, Jurisdiction, Percentage, TaxType) values ('true', 'IN', 'GST', 'GST India.', 'false', 'IN', '18', 'sales_tax')
UPDATE
To modify a tax rate, specify the Id:
UPDATE TaxRates SET Description = 'GST for Country India' WHERE Id = '123124'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the tax rate. | |
| Active | Boolean | False |
Indicates whether the tax rate can be used with new applications or Checkout sessions. Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout sessions, but still works for subscriptions and invoices that already have it set. | |
| Country | String | False |
A two-letter country code. | |
| Created | Datetime | True |
The time at which the tax rate was created, measured in seconds since the Unix epoch. | |
| Description | String | False |
An arbitrary string attached to the tax rate for your internal use only. It is not visible to your customers. | |
| DisplayName | String | False |
The display name of the tax rate as it appears to your customer on their receipt email, PDF, and the hosted invoice page. | |
| EffectivePercentage | Double | True |
The effective tax rate percentage out of 100. | |
| Inclusive | Boolean | False |
Indicates whether the tax rate is inclusive or exclusive. | |
| Jurisdiction | String | False |
The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. | |
| Livemode | Boolean | True |
Indicates whether the object exists in live mode. Has the value true if the object exists in live mode, or the value false if the object exists in test mode. | |
| Metadata | String | False |
The set of key-value pairs that you can attach to the tax rate. | |
| Percentage | Double | False |
The tax rate percentage out of 100. | |
| State | String | False |
An ISO 3166-2 subdivision code, without country prefix. | |
| TaxType | String | False |
The high-level tax type, such as vat or sales_tax. The allowed values are amusement_tax, communications_tax, gst, hst, igst, jct, lease_tax, pst, qst, rst, sales_tax, service_tax, vat, admissions_tax, attendance_tax, entertainment_tax, gross_receipts_tax, hospitality_tax, luxury_tax, resort_tax, retail_delivery_fee, tourism_tax. | |
| JurisdictionLevel | String | True |
The level of the jurisdiction that imposes this tax rate. This value is null for manually defined tax rates. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| AccountId | String |
The Id of the connected account to get tax rates for. |