Tax Rates#

Tax Rates define the tax percentage to apply to invoice line items. You can create multiple tax rates for different jurisdictions and tax types.

The Tax Rate object#

Attribute	Type	Description
`id`	string	Unique identifier with `txr_` prefix
`object`	string	Always `"tax_rate"`
`display_name`	string	Display name for the tax rate
`description`	string	Description
`percentage`	number	Tax percentage (e.g., 19.0 for 19%)
`inclusive`	boolean	Whether tax is included in the price
`jurisdiction`	string	Tax jurisdiction (e.g., `DE`, `GB`)
`tax_type`	enum	`vat`, `sales_tax`, `gst`, `other`
`active`	boolean	Whether the tax rate is active
`metadata`	hash	Key-value pairs
`created`	timestamp	Time at which the object was created

{
  "id": "txr_vat_de",
  "object": "tax_rate",
  "display_name": "VAT",
  "description": "German Value Added Tax",
  "percentage": 19.0,
  "inclusive": false,
  "jurisdiction": "DE",
  "tax_type": "vat",
  "active": true,
  "created": 1706140800
}

Create a Tax Rate#

POST /v1/tax_rates

curl https://api.casapay.com/v1/tax_rates \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "VAT",
    "percentage": 19.0,
    "inclusive": false,
    "jurisdiction": "DE",
    "tax_type": "vat"
  }'

Retrieve, Update, List#

GET /v1/tax_rates/:id

POST /v1/tax_rates/:id

GET /v1/tax_rates