Skip to main content
GET
/
taxes
/
rates
Get tax rates
curl --request GET \
  --url https://api.cloud.flexprice.io/v1/taxes/rates \
  --header 'x-api-key: <api-key>'
[
  {
    "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>*

Query Parameters

​
end_time
string
​
expand
string
​
limit
integer
Required range: 1 <= x <= 1000
​
offset
integer
Required range: x >= 0
​
order
enum<string>
Available options:
asc,
desc
​
scope
enum<string>
Available options:
INTERNAL,
EXTERNAL,
ONETIME
​
start_time
string
​
status
enum<string>
Available options:
published,
deleted,
archived
​
taxrate_codes
string[]
​
taxrate_ids
string[]

Response

OK

​
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