Creates a new tax rate.
Parameters
- display_
namestringRequired The display name of the tax rate, which will be shown to users.
- inclusivebooleanRequired
This specifies if the tax rate is inclusive or exclusive.
- percentagefloatRequired
This represents the tax rate percent out of 100.
- activeboolean
Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
- countrystring
Two-letter country code (ISO 3166-1 alpha-2).
- descriptionstring
An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
- jurisdictionstring
The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - statestring
ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.
More parameters
- tax_
typeenum The high-level tax type, such as
vat
orsales_
.tax Possible enum valuesamusement_
tax Amusement Tax
communications_
tax Communications Tax
gst
Goods and Services Tax
hst
Harmonized Sales Tax
igst
Integrated Goods and Services Tax
jct
Japanese Consumption Tax
lease_
tax Chicago Lease Tax
pst
Provincial Sales Tax
qst
Quebec Sales Tax
retail_
delivery_ fee Retail Delivery Fee
Show 3 more
Returns
The created tax rate object.
{ "id": "txr_1MzS4RLkdIwHu7ixwvpZ9c2i", "object": "tax_rate", "active": true, "country": null, "created": 1682114687, "description": "VAT Germany", "display_name": "VAT", "inclusive": false, "jurisdiction": "DE", "livemode": false, "metadata": {}, "percentage": 16, "state": null, "tax_type": null}