Order voucher

POST
https://www.digicert.com/services/v2/vouchers

Use this endpoint to place a voucher order. To order multiple products at once, pass an object for each product configuration you want to order.

Each voucher order is intended to be used by the same customer. If you need to order vouchers for multiple customers, place separate orders for each customer.

Example requests and responses

cURL
{
  "subscriptions": [
    {
      "product_name_id": "ssl_ev_basic",
      "no_of_fqdns": 5,
      "validity_years": 1,
      "quantity": 1,
      "use_san_package": true
    },
    {
      "product_name_id": "ssl_ev_securesite_pro",
      "no_of_fqdns": 2,
      "validity_years": 2,
      "quantity": 1
    }
  ],
  "payment_method": "balance"
}
201 Created
{
    "id": 1014,
    "name": "My test subscription",
    "status": "completed",
    "cost": 2698,
    "expiration_date": "2021-07-09",
    "codes": [
        {
            "id": 2104,
            "value": "QWWQ7LQSO72QLPXEXMC5OA65SHS2CPWJ",
            "product": {
                "name_id": "ssl_ev_basic"
            },
            "no_of_fqdns": 5,
            "validity_years": 1,
            "status": "active"
        },
        {
            "id": 2105,
            "value": "WWXPP6EC2GUXRYY4AE52FMOZ33K32M7K",
            "product": {
                "name_id": "ssl_ev_securesite_pro"
            },
            "no_of_fqdns": 2,
            "validity_years": 2,
            "status": "active"
        }
    ],
}

Request parameters

Name Req/Opt Type Description
vouchers required object Container for new voucher order.
..product_name_id required string Name ID of the product. See Glossary – Product identifiers.
..no_of_fqdns optional int Number of FQDN SAN slots. Range1-250. Note that the total number of SANs cannot exceed 250.
..no_of_wildcards optional int Number of Wildcard SAN slots. Range1-250
..validity_years optional* int The number of years of order coverage. Range1-6. Note that the total number of SANs cannot exceed 250.
..validity_days optional* int The number of days of order coverage. Overrides validity_years.
..quantity required int Quantity of certificates you want to order with this configuration. Each certificate receives a unique voucher code. Range1-1000
..use_san_package optional boolean
payment_method required string Specify the payment method to use. Allowed values: balance, card, wire transfer
name optional string Include a customer name or organization that this voucher order is intended for. Only for tracking and order management purposes. Maximum allowed characters: 128
notes optional string Include any notes that help you with order management. Maximum allowed characters: 512

Response parameters

Name Type Description
id int Voucher order ID.
status string Status of Voucher order. Possible values: active, used, canceled,
codes object Container for voucher codes in this order. Each certificate in the order will be returned as a separate object.
..id int 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.
Range1-6
validity_days int Number of days the certificate is valid. Range1-2190