Get a tax rate

Use when you need to load a single tax rate (e.g. for display or when creating an association).

GET /taxes/rates/{id}

Get a tax rate

cURL

curl --request GET \
  --url https://us.api.flexprice.io/v1/taxes/rates/{id} \
  --header 'x-api-key: <api-key>'

200

{
  "code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "description": "<string>",
  "environment_id": "<string>",
  "fixed_value": "<string>",
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "percentage_value": "<string>",
  "tenant_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>"
}

Authorizations

x-api-key · string · header · required

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

Path Parameters

id · string · required

Tax rate ID

Response

200

application/json

OK

code · string

created_at · string<date-time>

created_by · string

description · string

environment_id · string

fixed_value · string

id · string

metadata · object

Show child attributes

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, fixed

tenant_id · string

updated_at · string<date-time>

updated_by · string