Skip to main content

Get voucher order details

GET https://www.digicert.com/services/v2/voucher/{id}

Use this endpoint to get voucher code details.

Example requests and responses

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.

currency

string

Currency unit for voucher order cost.

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.

..id

string

Voucher code ID

..value

string

Unique voucher code.

..product_name_id

string

Name ID of the product.

..no_of_fqdns

int

Number of FQDN SAN slots.

Range: 1-250. Note that the total number of SANs cannot exceed 250.

..no_of_wildcards

int

Number of Wildcard SAN slots.

Range: 1-250

..validity_years

int

Number of years the certificate order is valid.

*Can be replaced with validity_days.

..validity_days

int

Number of days the certificate order is valid.

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.