Contents
On this page

List Tax Rates - Plugixa Car Rental

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

List tax rates, one page at a time.

Needs Plugixa Car Rental Pro with the Tax app on. The user needs the plugixa_car_rental_view capability.

Request

GET https://your-site.example/wp-json/plugixa-car-rental/v1/tax-rates?status__in=published

Query parameters

This list takes the list parameters every paged list accepts. search matches name. orderby accepts id, name, rate, sort_order, status, created_at, modified_at.

Filters, as described in Filtering lists: status (in, ne, empty, not_empty), created_at and modified_at (dates).

Responses

200 OK. data is one page of tax rates.

{
  "success": true,
  "data": [
    {
      "id": 2,
      "name": "VAT 20%",
      "rate": 20.0,
      "type": "percent",
      "compound": false,
      "location_ids": [],
      "sort_order": 0,
      "status": "published",
      "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": 4,
    "pages": 1
  }
}
Field Type Meaning
data[].id integer The tax rate’s id
data[].name string As it appears on the bill
data[].rate number Percentage, or a fixed amount
data[].type string percent or fixed
data[].compound boolean Whether this percentage is charged on the taxes before it too
data[].location_ids integer[] Pickup locations it applies to. Empty: every location
data[].sort_order integer Order the taxes are applied in, lowest first
data[].status string published or unpublished. Only a published rate is charged
meta.total integer Tax Rates matching the search and filters, before paging
meta.pages integer Number of pages at this per_page

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-car-rental/v1/tax-rates?status__in=published" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'status__in' => 'published',
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-car-rental/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 auth = Buffer.from(`admin:${process.env.WP_APP_PASSWORD}`).toString('base64');
const query = new URLSearchParams({ status__in: 'published' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-car-rental/v1/tax-rates?${query}`, {
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data, meta } = await response.json();

Quick Links

Share