Contents
On this page

List Tax Rates - Plugixa Car Parking

GET /plugixa-car-parking/v1/tax-rates

List tax rates, one page at a time. Active tax rates are added to every quote at the locations they apply to.

Needs Plugixa Car Parking Pro. The WordPress user needs the plugixa_carparking_view capability (view records).

Request

GET https://your-site.example/wp-json/plugixa-car-parking/v1/tax-rates?status__in=active&orderby=display_order&order=asc

Query parameters

The list parameters every paged list accepts. search matches the name. orderby accepts id, name, rate, status, display_order, created_at and modified_at; anything else sorts by id. view=trash lists trashed tax rates only.

Filterable fields: status and type (in, ne, empty, not_empty), rate (number comparisons), and created_at and modified_at (date comparisons). For example type__in=percent. See Filtering lists for the syntax.

Responses

200 OK. data is one page of tax rates.

{
  "success": true,
  "data": [
    {
      "id": 2,
      "name": "VAT",
      "rate": 20.0,
      "type": "percent",
      "is_compound": false,
      "applies_to": null,
      "status": "active",
      "display_order": 0,
      "created_by": 1,
      "modified_by": 1,
      "created_at": "2026-11-12 09:30:00",
      "modified_at": "2026-11-12 09:30:00",
      "deleted_at": null
    }
  ],
  "meta": {
    "total": 3,
    "pages": 1
  }
}
Field Type Meaning
data[].id integer The tax rate’s id
data[].name string Shown on the quote and the invoice beside the tax charged
data[].rate number A percentage when type is percent, an amount when it is fixed
data[].type string percent or fixed
data[].is_compound boolean Whether the rate is charged on the taxed price
data[].status string active or inactive
meta.total integer Tax Rates matching the search and filters, before paging
meta.pages integer Number of pages at this per_page

Errors

Status Code When
400 plugixa_carparking_unknown_filter A filter names a field this list cannot filter on.
400 plugixa_carparking_unknown_operator A filter uses an operator that does not work on that field.
400 plugixa_carparking_missing_value A filter has no value.
400 plugixa_carparking_invalid_date A date filter has a value that is not a date.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-car-parking/v1/tax-rates?status__in=active&orderby=display_order&order=asc" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query(['status__in' => 'active', 'orderby' => 'display_order', 'order' => 'asc']);
$ch = curl_init('https://your-site.example/wp-json/plugixa-car-parking/v1/tax-rates?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const query = new URLSearchParams({ status__in: 'active', orderby: 'display_order', order: 'asc' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-car-parking/v1/tax-rates?${query}`, {
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data, meta } = await response.json();

Quick Links

Share