Skip to main content
POST
/
v1
/
tax_rates
Create a tax rate
curl --request POST \
  --url https://api.yorlet.com/v1/tax_rates \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "inclusive": true,
  "percentage": 50.005,
  "active": true,
  "country": "<string>",
  "description": "<string>",
  "jurisdiction": "<string>",
  "state": "<string>",
  "metadata": {},
  "tax_type": "gst"
}
'
{
  "id": "<string>",
  "created": 123,
  "object": "tax_rate",
  "active": true,
  "country": "<string>",
  "description": "<string>",
  "inclusive": true,
  "jurisdiction": "<string>",
  "name": "<string>",
  "percentage": 123,
  "state": "<string>",
  "tax_type": "gst",
  "account": "<string>",
  "deleted": false,
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
​
name
string
required

The name of the tax rate, which will be shown to users.

​
inclusive
boolean
required

Whether the tax rate is inclusive or exclusive.

​
percentage
number
required

The percentage of the tax rate out of 100.

Required range: 0.01 <= x <= 100
​
active
boolean

Whether the tax rate is active.

​
country
string

The country for the tax rate.

​
description
string

The description of the tax rate.

​
jurisdiction
string | null

The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

​
state
string

The state for the tax rate.

​
metadata
object

The metadata for the tax rate.

​
tax_type
enum<string>

The high-level tax type.

Available options:
gst,
sales_tax,
vat,
custom

Response

200 - application/json

Returns the tax rate object if the request succeeded.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
tax_rate
​
active
boolean
required

Whether the tax rate is active.

​
country
string | null
required

The country for the tax rate.

​
description
string | null
required

The description of the tax rate.

​
inclusive
boolean
required

Whether the tax rate is inclusive or exclusive.

​
jurisdiction
string | null
required

The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

​
name
string
required

The name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

​
percentage
number
required

The percentage of the tax rate out of 100.

​
state
string | null
required

The state for the tax rate.

​
tax_type
enum<string> | null
required

The high-level tax type.

Available options:
gst,
sales_tax,
vat,
custom,
null
​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.

​
metadata
object

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.