Tax

Update tax configuration

Create or update the merchant's tax configuration. When autoTaxCalculation is false, provide defaultTaxRate as a decimal string between 0 and 1.

POST
/tax/config/update

Authorization

bearerAuth
AuthorizationBearer <token>

Use your secret API key as the bearer token

In: header

Request Body

application/json

autoTaxCalculation?boolean

Enable automatic tax calculation; otherwise manual calculation uses defaultTaxRate.

defaultTaxRate?string|null

Decimal string between 0 and 1 (e.g., '0.0875'); set to null or omit to clear when using manual tax.

Match^\d+(\.\d{1,4})?$

Response Body

application/json

application/json

application/json

curl -X POST "https://api.getlumen.dev/v1/tax/config/update" \  -H "Content-Type: application/json" \  -d '{    "autoTaxCalculation": false,    "defaultTaxRate": "0.0875"  }'
{
  "id": "mer_tax_cfg_6FJ7xXk8Qp9zR2tSa1BcDe",
  "merchantId": "mer_4aExPpQ7R3tSa1BcDe9LmN",
  "autoTaxCalculation": false,
  "defaultTaxRate": "0.0875",
  "createdAt": "2025-01-15T19:22:14.000Z",
  "updatedAt": "2025-02-20T08:10:00.000Z"
}
{
  "error": [
    {
      "code": "custom",
      "message": "Tax rate must be a valid decimal number between 0 and 1 (e.g., '0.0875' for 8.75%) or null",
      "path": [
        "defaultTaxRate"
      ]
    }
  ]
}
{
  "error": "Internal server error"
}