Skip to main content

List used voucher codes

GET https://www.digicert.com/services/v2/voucher/download/used-codes

Use this endpoint to get a list of used voucher codes.

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

Example requests and responses

Example 1. cURL
curl --request GET 'https://www.digicert.com/services/v2/voucher/download/used-codes' \
--header 'X-DC-DEVKEY: {{api_key}}

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.

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, date_valid_till), you can filter by date range.

  • To filter by date range, separate the start date and end date with an ellipsis (...).

  • To return all results before a specific date, prefix the date with a less than (<) character.

  • To return all results after a date, prefix the date with a greater than (>) character.

For examples of filtering by date range, see Services API – Filters, sorting, and pagination parameters.

Supported filters:

  • filters[product_name_id]: Filters by product identifier. See Glossary – Product identifiers.

  • filters[voucher_order_id]: Filters by voucher order ID.

  • filters[certificate_order_id]: Filters by certificate order ID.

  • filters[date_valid_till]: Filters by order expiration date.

  • filters[code]: Filters by voucher code value.

  • filters[id]: Filters by voucher code ID.

Response parameters

Name

Type

Description

codes

array

List of used voucher codes. Each voucher code object has the key/value pairs listed below.

.. id

integer

Voucher code ID.

.. value

string

Voucher code.

.. product_name

string

Product the voucher code is for.

Possible values: See Glossary – Product identifiers.

.. no_of_fqdns

integer

Number of FQDNs the voucher allows.

.. no_of_wildcards

string

Number of wildcard domain names the voucher allows.

.. shipping_method

string

Voucher code shipping method.

Possible values: N/A, STANDARD, EXPEDITED

.. validity_years

integer

Order validity in years. Returns 0 if the order validity for the voucher code is set using days instead of years.

.. validity_days

integer

Order validity in days. Returns 0 if the order validity for the voucher code is set using years instead of days.

.. status

string

Voucher code status. For used voucher codes, the status is always used.

.. created_date

string

Date and time the voucher code was created.

Format: YYYY-MM-DD hh:mm:ss

.. voucher_order_id

integer

ID of voucher order associated with the voucher code.

.. cert_request_date

string

Date and time the voucher code was used to request a certificate.

Format: YYYY-MM-DD hh:mm:ss

.. cert_validity_start_date

string

Certificate validity start date. Returns an empty string (" ") if the certificate has not been issued.

.. cert_validity_end_date

string

Certificate validity end date. Returns an empty string (" ") if the certificate has not been issued.

.. cert_organization

string

Name of the organization on the certificate request.

.. cert_common_name

string

Value of the common name on the certificate request.

.. certificate_order_id

string

Certificate order ID. Use this ID with the Order info API to get more information about the certificate order.

.. voucher_validity_end_date

string

Voucher code expiration date.

Format: YYYY-MM-DD

.. order_valid_from

string

Order validity start date. Returns an empty string (" ") if the certificate has not been issued.

.. order_valid_till

string

Order validity end date. Returns an empty string (" ") if the certificate has not been issued.

.. server_licenses

integer

Number of server licenses included with the certificate.

In this section: