Skip to main content
POST
/
taxes
/
rates
Create a tax rate
curl --request POST \
  --url https://api.cloud.flexprice.io/v1/taxes/rates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "code": "<string>",
  "description": "<string>",
  "fixed_value": 123,
  "metadata": {},
  "name": "<string>",
  "percentage_value": 123,
  "scope": "INTERNAL",
  "tax_rate_type": "percentage"
}'
{
  "code": "<string>",
  "created_at": "<string>",
  "created_by": "<string>",
  "description": "<string>",
  "environment_id": "<string>",
  "fixed_value": 123,
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "percentage_value": 123,
  "scope": "INTERNAL",
  "status": "published",
  "tax_rate_status": "ACTIVE",
  "tax_rate_type": "percentage",
  "tenant_id": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>"
}

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

​
fixed_value
number

fixed_value is the fixed monetary amount when tax_rate_type is "fixed"

​
metadata
object

metadata contains additional key-value pairs for storing extra information

​
percentage_value
number

percentage_value is the percentage value (0-100) when tax_rate_type is "percentage"

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

Response

Created

​
code
string
​
created_at
string
​
created_by
string
​
description
string
​
environment_id
string
​
fixed_value
number
​
id
string
​
metadata
object
​
name
string
​
percentage_value
number
​
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,
fixed
​
tenant_id
string
​
updated_at
string
​
updated_by
string