Log inTalk to us
Developer tools

List the tax presets

get/v1/tax-presets
No authentication

Public: editable starting points for a location's tax lines (PUT .../locations/{location_id}/tax with preset and confirm_preset true): Canada's provinces and territories (GST, HST, PST, QST, RST) and the US states with a per-kWh EV charging excise. Ivora does not guarantee their legal correctness: the operator is the seller, checks what applies and files the tax. US sales tax depends on state, county and city and has no preset.

Returns · 200

  • dataarray of TaxPresetRequired
    Child attributes
    • idstringRequired
      ISO 3166 country and region: pass it as preset.
    • countrystringRequired
    • regionstringRequired
    • namestringRequired
    • price_modeenumRequired
      One of tax_exclusive, tax_inclusive
    • linesarray of TaxPresetLineRequired
      Child attributes
      • namestringRequired
      • typeenumRequired
        One of percent, per_kwh
      • ratestringRequired
      • compoundbooleanRequired
    • notestringRequired
    • as_ofstringRequired
      When Ivora last reviewed the rates.
  • disclaimerstringRequired
GET /v1/tax-presets
curl --fail-with-body "https://api.ivoracharge.com/v1/tax-presets"
Response · 200JSON
{
  "data": [
    {
      "id": "CA-AB",
      "country": "string",
      "region": "string",
      "name": "bay-01",
      "price_mode": "tax_exclusive",
      "lines": [
        {
          "name": "bay-01",
          "type": "percent",
          "rate": "string",
          "compound": false
        }
      ],
      "note": "string",
      "as_of": "string"
    }
  ],
  "disclaimer": "string"
}
Requires an approved production API keyProduction access starts with a request, a short meeting with Ivora and a card on file, after which Ivora staff grant your account access. How to request access
Try itproduction · api.ivoracharge.com

This operation needs no API key.