Tax
Update tax rate definition
Update fields of an existing tax rate definition.
Authorization
bearerAuth AuthorizationBearer <token>
Use your secret API key as the bearer token
In: header
Path Parameters
id*string
Tax rate definition ID
Match
^tax_rate_def_[A-Za-z0-9]{22}$Request Body
application/json
name?string|null
description?string|null
taxRate?string|null
Decimal string between 0 and 1 (e.g., '0.0875')
Match
^\d+(\.\d{1,4})?$jurisdiction?string|null
taxType?string|null
isActive?boolean|null
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.getlumen.dev/v1/tax/rate-definitions/string/update" \ -H "Content-Type: application/json" \ -d '{ "name": "Updated manual rate", "taxRate": "0.09", "description": "Updated fallback rate" }'{
"id": "tax_rate_def_1Abc9rQp3Kf4s6T8uYz0Lp",
"merchantId": "mer_4aExPpQ7R3tSa1BcDe9LmN",
"name": "Updated manual rate",
"description": "Updated fallback rate",
"taxRate": "0.09",
"jurisdiction": "US-CA",
"taxType": "manual",
"isActive": true,
"createdAt": "2025-02-01T10:00:00.000Z",
"updatedAt": "2025-02-21T10:00:00.000Z"
}{
"error": [
{
"code": "custom",
"message": "Tax rate must be between 0 and 1 (0% to 100%)",
"path": [
"taxRate"
]
}
]
}{
"error": "Tax rate definition not found"
}{
"error": "Internal server error"
}