Skip to main content
POST
Create a tax rate

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Tax rate to create

code
string
required

code is the unique alphanumeric case sensitive identifier for the tax rate (required)

name
string
required

name is the human-readable name for the tax rate (required)

description
string

description is an optional text description providing details about the tax rate

metadata
object

metadata contains additional key-value pairs for storing extra information

percentage_value
string

percentage_value is the percentage value (0-100)

scope
enum<string>
Available options:
INTERNAL,
EXTERNAL,
ONETIME
tax_rate_type
enum<string>
Available options:
percentage

Response

Created

code
string
created_at
string<date-time>
created_by
string
description
string
environment_id
string
id
string
metadata
object
name
string
percentage_value
string
scope
enum<string>
Available options:
INTERNAL,
EXTERNAL,
ONETIME
status
enum<string>
Available options:
published,
deleted,
archived
tax_rate_status
enum<string>
Available options:
ACTIVE,
INACTIVE
tax_rate_type
enum<string>
Available options:
percentage
tenant_id
string
updated_at
string<date-time>
updated_by
string