Get voucher order details


Use this endpoint to get voucher code detail

Example requests and responses

curl -g --request GET '{id}' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json'
200 OK
    "id": {id},
    "name": "ACME CORP",
    "status": "completed",
    "cost": 37,
    "created_date": "2020-01-20 01:26:02",
    "expiration_date": "2021-01-20",
    "can_cancel": true,
    "codes": [
            "id": 1001,
            "value": "B6TEM44GLJE2KASGWXDI5LER7LK6MYYG",
            "product": {
                "group_name": "dv_ssl_certificate",
                "name_id": "ssl_dv_geotrust_flex",
                "name": "GeoTrust DV SSL"
            "no_of_fqdns": 1,
            "no_of_wildcards": 1,
            "validity_years": 1,
            "status": "active"
            "id": 1002,
            "value": "P2KLM44GLJE2KASGWXDI5LER7LK6MYYG",
            "product": {
                "group_name": "dv_ssl_certificate",
                "name_id": "ssl_dv_thawte",
                "name": "Thawte SSL123 DV"
            "no_of_fqdns": 5,
            "no_of_wildcards": 1,
            "validity_years": 1,
            "status": "active"
    "notes": "Example note",
    "page": {
        "total": 0,
        "limit": 0,
        "offset": 0

Response parameters

Name Type Description
id int Voucher order ID.
name string Organization name.
status string Status of Voucher order. Possible values: active, used, canceled,
cost int Total cost of order.
created_date string Date that voucher was created. Format: YYYY-MM-DD HH:MM:SS
expiration_date string Date that voucher expires. Format: YYYY-MM-DD
can_cancel boolean If order is eligible for cancelation.
codes object Container object. Each code is returned in a separate object. string Voucher code ID
..value string Unique voucher code.
..product_name_id string Name ID of the product. See Glossary – Server platforms
..no_of_fqdns int Number of FQDN SAN slots. Range1-250. Note that the total number of SANs cannot exceed 250.
..no_of_wildcards int Number of Wildcard SAN slots. Range1-250
..validity_years int Number of years the certificate is valid. *Can be replaced with validity_days.
..validity_days int Number of days the certificate is valid. Range1-2190
notes string Displays order note.
used_from string Date and time code was used for a certificate request.
valid_till string Date and time that voucher expires.