Get Tax Association

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

GET /taxes/associations/{id}

Get Tax Association

cURL

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

200

{
  "auto_apply": true,
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "currency": "<string>",
  "end_date": "2023-11-07T05:31:56Z",
  "entity_id": "<string>",
  "entity_type": "customer",
  "environment_id": "<string>",
  "id": "<string>",
  "metadata": {},
  "priority": 123,
  "start_date": "2023-11-07T05:31:56Z",
  "status": "published",
  "tax_rate": {
    "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>",
    "scope": "INTERNAL",
    "status": "published",
    "tax_rate_status": "ACTIVE",
    "tax_rate_type": "percentage",
    "tenant_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>"
  },
  "tax_rate_id": "<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 Config ID

Response

200

application/json

OK

auto_apply · boolean

Whether this tax should be automatically applied

created_at · string<date-time>

created_by · string

currency · string

Currency

end_date · string<date-time>

EndDate is the optional date until which this association is active

entity_id · string

ID of the entity this tax rate applies to

entity_type · enum<string>

Available options: customer, subscription, invoice, tenant

environment_id · string

EnvironmentID is the ID of the environment this tax rate config belongs to

id · string

ID of the ent.

metadata · object

Metadata holds the value of the "metadata" field.

Show child attributes

priority · integer

Priority for tax resolution (lower number = higher priority)

start_date · string<date-time>

StartDate is the date from which this association is active

status · enum<string>

Available options: published, deleted, archived

tax_rate · object

Show child attributes

tax_rate_id · string

Reference to the TaxRate entity

tenant_id · string

updated_at · string<date-time>

updated_by · string