---
title: "List all voucher orders"
source_url: https://dev.digicert.com/certcentral-apis/services-api/vouchers/list-all-voucher-orders.html
api_method: GET
api_endpoint: "/services/v2/voucher"
api_url: "https://www.digicert.com/services/v2/voucher"
---

**GET** `https://www.digicert.com/services/v2/voucher`

Use this endpoint to list all voucher orders. For more information, see <a href="https://docs.digicert.com/en/certcentral/manage-certificates/vouchers.html" target="_blank" rel="noopener noreferrer">Vouchers</a>.

To get the list of orders in CSV format, set the `Accept` header in the request to `text/csv`.

## Example requests and responses

## cURL

```bash
curl --request GET 'https://www.digicert.com/services/v2/voucher' \
--header 'X-DC-DEVKEY: {{api_key}}'
```

## 200 OK

```json
{
  "voucher_orders": [
    {
      "id": 1002,
      "name": "Example Organization",
      "status": "canceled",
      "cost": 100.5,
      "currency": "USD",
      "cost_plus_tax": 100.5,
      "created_date": "2020-04-17 09:41:22",
      "expiration_date": "2021-04-17",
      "receipt_id": 12345
    },
    {
      "id": 1003,
      "name": "Example Organization",
      "status": "completed",
      "cost": 85.5,
      "currency": "USD",
      "cost_plus_tax": 85.5,
      "created_date": "2020-04-17 09:44:26",
      "expiration_date": "2021-04-17",
      "receipt_id": 12346
    }
  ],
  "page": {
    "total": 2,
    "limit": 1000,
    "offset": 0
  }
}
```

## Filters and URL query parameters

This endpoint supports filters, sorting, and pagination. For general information and examples of the syntax to use when applying filters and sorting results, see [Services API – Filters, sorting, and pagination parameters](https://dev.digicert.com/md/certcentral-apis/services-api.md#filters-sorting-and-pagination-parameters).

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Req/Opt</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>filters[<code>{{property_name}}</code>]</td>
<td>optional</td>
<td>string</td>
<td>Filters results by the specified property. Replace <code>{{property_name}}</code> in your request with the property to use for filtering.<br>If the value of the property is a date (for example, <code>created_date</code> or <code>expiration_date</code>), you can filter by date range.<br><ul><li>To filter by date range, separate the start date and end date with an ellipsis (<code>...</code>).</li><li>To return all results before a specific date, prefix the date with a less than (<code>&lt;</code>) character.</li><li>To return all results after a date, prefix the date with a greater than (<code>&gt;</code>) character.</li></ul><br>For examples of filtering by date range, see <a href="https://dev.digicert.com/md/certcentral-apis/services-api.md#filters-sorting-and-pagination-parameters">Services API – Filters, sorting, and pagination parameters</a>.<br><strong>Supported filters:</strong><br><ul><li><code>filters[product_name_id]</code>: Filters by product identifier. See <a href="https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md">Glossary – Product identifiers</a>.</li><li><code>filters[status]</code>: Filters by order status (<code>completed</code> or <code>canceled</code>).</li><li><code>filters[codes_status]</code>: Filters by voucher code usage status. Accepts <code>none</code> (no codes used), <code>unused</code> (one or more codes unused), <code>partial</code> (one or more codes used), and <code>used</code> (all codes used).</li><li><code>filters[created_date]</code>: Filters by order creation date.</li><li><code>filters[expiration_date]</code>: Filters by order expiration date.</li><li><code>filters[name]</code>: Filters by order name. By default, returns voucher orders with a name value that is an exact match for the provided filter value. To return orders with a name that is a partial match, prefix the filter value with a <code>%</code>. Example: <code>filters[name]=%partial</code></li><li><code>filters[id]</code>: Filters by order ID.</li></ul><br>For example, to retrieve only active voucher orders, you can use the following request URL: GET https://www.digicert.com/services/v2/voucher?filters[status]=active</td>
</tr>
<tr>
<td>sort</td>
<td>optional</td>
<td>string</td>
<td>Sorts results by the value of one or more properties.<br>By default, sorts results in ascending alphabetical order (0-9, A-Z). To sort in descending alphabetical order (9-0, Z-A), prefix the property name with a minus (<code>-</code>).<br>To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in the comma-separated list.<br>This endpoint supports sorting by the following properties:<br><ul><li><code>id</code></li><li><code>created_date</code></li><li><code>status</code></li><li><code>name</code></li><li><code>cost_plus_tax</code></li></ul><br>For example, to sort voucher orders by creation date in descending order, you can use the following request URL: <code>GET https://www.digicert.com/services/v2/voucher?sort=-created_date</code></td>
</tr>
<tr>
<td>limit</td>
<td>optional</td>
<td>integer</td>
<td>Total number of results to include in the response.<br><strong>Max:</strong><code>1000</code> (default)<br>For example, to fetch the second page of results with 50 orders per page, you can use the following request URL: <code>GET https://www.digicert.com/services/v2/voucher?limit=50&amp;offset=50</code></td>
</tr>
<tr>
<td>offset</td>
<td>optional</td>
<td>integer</td>
<td>Index of the first result to include in the response.<br><strong>Default:</strong><code>0</code><br>For example, to fetch the third page of results with 50 orders per page, you can use the following request URL: <code>GET https://www.digicert.com/services/v2/voucher?limit=50&amp;offset=100</code></td>
</tr>
</tbody>
</table>

## Response parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>voucher_orders</td>
<td>object</td>
<td>List of voucher order objects.</td>
</tr>
<tr>
<td>.. id</td>
<td>integer</td>
<td>Voucher order ID.</td>
</tr>
<tr>
<td>.. status</td>
<td>string</td>
<td>Status of voucher order.<br>Possible values:completed, canceled</td>
</tr>
<tr>
<td>.. cost</td>
<td>number</td>
<td>Voucher order cost, without tax.</td>
</tr>
<tr>
<td>.. cost_plus_tax</td>
<td>number</td>
<td>Voucher order cost, with tax.</td>
</tr>
<tr>
<td>.. currency</td>
<td>string</td>
<td>Currency unit for voucher order cost.</td>
</tr>
<tr>
<td>.. created_date</td>
<td>string</td>
<td>Date the voucher order was created.<br>Format:
YYYY-MM-DD HH:MM:SS</td>
</tr>
<tr>
<td>.. expiration_date</td>
<td>string</td>
<td>Voucher order expiration date.<br>Format:
YYYY-MM-DD</td>
</tr>
<tr>
<td>.. receipt_id</td>
<td>integer</td>
<td>Receipt ID. Returned when the <code>payment_method</code> for the order is <code>balance</code> or <code>card</code>. Not returned if <code>cost_plus_tax</code> is <code>0</code>.</td>
</tr>
<tr>
<td>.. invoice_id</td>
<td>integer</td>
<td>Invoice ID. Returned when the <code>payment_method</code> for the order is <code>wire_transfer</code>. Not returned if <code>cost_plus_tax</code> is <code>0</code>.</td>
</tr>
<tr>
<td>.. notes</td>
<td>string</td>
<td>Notes provided in request to help you manage the voucher order.</td>
</tr>
<tr>
<td><a href="https://dev.digicert.com/md/certcentral-apis/services-api/structures.md#page-details-object">page</a></td>
<td>object</td>
<td>Object with pagination details.</td>
</tr>
</tbody>
</table>