Use this endpoint to list all voucher orders.
To get the list of orders in CSV format, set the Accept
header in the request to text/csv
.
curl --request GET 'https://www.digicert.com/services/v2/voucher' \
--header 'X-DC-DEVKEY: {{api_key}}
{
"voucher_orders": [
{
"id": 1002,
"name": "Example Organization",
"status": "canceled",
"cost": 100.5,
"cost_plus_tax": 100.5,
"created_date": "2020-04-17 09:41:22",
"expiration_date": "2021-04-17"
},
{
"id": 1003,
"name": "Example Organization",
"status": "completed",
"cost": 85.5,
"cost_plus_tax": 85.5,
"created_date": "2020-04-17 09:44:26",
"expiration_date": "2021-04-17"
}
],
"page": {
"total": 2,
"limit": 1000,
"offset": 0
}
}
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.
Name | Req/Opt | Type | Description |
---|---|---|---|
filters[{{property_name}} ]
|
optional | string |
Filters results by the specified property. Replace {{property_name}} in your request with the property to use for filtering.If the value of the property is a date (for example, created_date or expiration_date ), you can filter by date range.
Supported filters:
|
sort | optional | string |
Sorts results by the value of one or more properties. 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 ( - ).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. This endpoint supports sorting by the following properties:
|
limit | optional | integer |
Total number of results to include in the response. Max: 1000 (default)
|
offset | optional | integer |
Index of the first result to include in the response. Default: 0
|
Name | Type | Description |
---|---|---|
voucher_orders | array | List of voucher order objects. |
.. id | integer | Voucher order ID. |
.. status | string |
Status of voucher order. Possible values: completed , canceled
|
.. cost | number | Voucher order cost, without tax. |
.. cost_plus_tax | number | Voucher order cost, with tax. |
.. created_date | string |
Date the voucher order was created. Format: YYYY-MM-DD HH:MM:SS
|
.. expiration_date | string |
Voucher order expiration date. Format: YYYY-MM-DD
|
.. receipt_id | integer |
Receipt ID. Returned when the payment_method for the order is balance or card . Not returned if cost_plus_tax is 0 .
|
.. invoice_id | integer |
Invoice ID. Returned when the payment_method for the order is wire_transfer . Not returned if cost_plus_tax is 0 .
|
.. notes | string | Notes provided in request to help you manage the voucher order. |
page | object | Object with pagination details. |