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
.
curl --request GET 'https://www.digicert.com/services/v2/voucher/download/used-codes' \
--header 'X-DC-DEVKEY: {{api_key}}
{
"codes": [
{
"id": 49170,
"value": "ZVB3LWIH3H3U53AOZU5QZ4W4TUTRPPCS",
"product_name": "Basic OV",
"no_of_fqdns": 5,
"no_of_wildcards": 0,
"shipping_method": "N/A",
"validity_years": 6,
"validity_days": 0,
"status": "used",
"created_date": "2022-03-03 13:31:03",
"voucher_order_id": 25252,
"cert_request_date": "2022-03-03 13:41:41",
"cert_validity_start_date": " ",
"cert_validity_end_date": " ",
"cert_organization": "Example Inc.",
"cert_common_name": "example.com",
"certificate_order_id": "204928159",
"voucher_validity_end_date": "2023-03-03",
"order_valid_from": " ",
"order_valid_till": " ",
"server_licenses": "1"
}
]
}
id,value,product_name,no_of_fqdns,no_of_wildcards,shipping_method,validity_years,validity_days,status,created_date,voucher_order_id,cert_request_date,cert_validity_start_date,cert_validity_end_date,cert_organization,cert_common_name,certificate_order_id,voucher_validity_end_date,order_valid_from,order_valid_till,server_licenses
49170,ZVB3EWIHDH3U63AOZU5QZ4W4TUTRPPCS,"Basic OV",5,0,N/A,6,0,used,"2022-03-03 13:31:03",25252,"2022-03-03 13:41:41"," "," ","Example Inc.",example.com,204928159,2023-03-03," "," ",1
49178,ZGGRW6GCJIWCR2XHAU4M6TNNBAURHLJM,"Basic OV",5,0,N/A,6,0,used,"2022-03-03 14:43:28",25256,"2022-03-04 10:48:47"," "," ","Example Inc.",example.com,204928160,2023-03-03," "," ",1
49179,4U6P5PVRG6HMOWYNGRD3HBM6QUSJRDH5,"Secure Site Pro EV SSL",2,0,N/A,2,0,used,"2022-03-03 14:43:28",25256,"2022-03-04 10:49:38"," "," ","Example Corp.",example.com,204928161,2023-03-03," "," ",1
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.
Supported filters:
|
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 | integer | 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. |