List all voucher orders

  3 minute read  

GET https://www.digicert.com/services/v2/voucher
Use this endpoint to list all voucher orders. For more information, see Vouchers.

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

Example requests and responses

cURL

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

200 OK

{
  "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.

NameReq/OptTypeDescription
filters[{{property_name}}]optionalstringFilters 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.
For examples of filtering by date range, see Services API – Filters, sorting, and pagination parameters.
Supported filters:
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
sortoptionalstringSorts 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:
For example, to sort voucher orders by creation date in descending order, you can use the following request URL: GET https://www.digicert.com/services/v2/voucher?sort=-created_date
limitoptionalintegerTotal number of results to include in the response.
Max:1000 (default)
For example, to fetch the second page of results with 50 orders per page, you can use the following request URL: GET https://www.digicert.com/services/v2/voucher?limit=50&offset=50
offsetoptionalintegerIndex of the first result to include in the response.
Default:0
For example, to fetch the third page of results with 50 orders per page, you can use the following request URL: GET https://www.digicert.com/services/v2/voucher?limit=50&offset=100

Response parameters

NameTypeDescription
voucher_ordersobjectList of voucher order objects.
.. idintegerVoucher order ID.
.. statusstringStatus of voucher order.
Possible values:completed, canceled
.. costnumberVoucher order cost, without tax.
.. cost_plus_taxnumberVoucher order cost, with tax.
.. currencystringCurrency unit for voucher order cost.
.. created_datestringDate the voucher order was created.
Format:
YYYY-MM-DD HH:MM:SS
.. expiration_datestringVoucher order expiration date.
Format:
YYYY-MM-DD
.. receipt_idintegerReceipt ID. Returned when the payment_method for the order is balance or card. Not returned if cost_plus_tax is 0.
.. invoice_idintegerInvoice ID. Returned when the payment_method for the order is wire_transfer. Not returned if cost_plus_tax is 0.
.. notesstringNotes provided in request to help you manage the voucher order.
pageobjectObject with pagination details.