Tax rates
Create, retrieve, update, and list tax rates for invoices and subscriptions.
A tax rate represents a named percentage applied to invoice line items and subscriptions. You can attach one or more tax rates to a subscription or invoice item to calculate tax automatically.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The tax rate objectAsk
idstringUnique identifier for the tax rate, e.g. txr_4Hm9eLsV.
display_namestringThe name shown to customers on invoices, e.g. "VAT".
percentagefloatThe tax rate as a decimal percentage, e.g. 20.0 for 20%.
inclusivebooleanWhen true, the tax is included in the stated price. When false, tax is added on top.
Defaults to false.
activebooleanWhether this tax rate can be applied to new invoices. Defaults to true.
countrystringTwo-letter ISO 3166-1 country code this rate applies to, e.g. "DE". Optional.
createdintegerUnix timestamp of when the tax rate was created, e.g. 1716300000.
Create a tax rateAsk
Pass a display_name, percentage, and optionally inclusive and country to create a tax rate.
Retrieve a tax rateAsk
Update a tax rateAsk
Only active can be changed after creation. To correct the percentage or display name, create a
new tax rate and archive the old one.
List tax ratesAsk
Related eventsAsk
tax_rate.created and tax_rate.updated. See Events.
