---
title: "Create voucher order"
source_url: https://dev.digicert.com/certcentral-apis/services-api/vouchers/create-voucher-order.html
api_method: POST
api_endpoint: "/services/v2/voucher"
api_url: "https://www.digicert.com/services/v2/voucher"
---

**POST** `https://www.digicert.com/services/v2/voucher`

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


> **Info**
>
> 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

```bash
curl --request POST 'https://www.digicert.com/services/v2/voucher' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '
{
  "vouchers": [
    {
      "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

```json
{
  "id": 25261,
  "name": "Example",
  "status": "completed",
  "cost": 10039.9,
  "cost_plus_tax": 10039.9,
  "created_date": "2022-03-03 15:38:43",
  "expiration_date": "2023-03-03",
  "receipt_id": 200896,
  "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"
    }
  ],
{
    "id": 1014,
    "name": "My test voucher order",
    "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

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Req/Opt</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>vouchers</td>
<td>required</td>
<td>array</td>
<td>List of object containers for new vouchers to order.</td>
</tr>
<tr>
<td>.. product_name_id</td>
<td>required</td>
<td>string</td>
<td>Product name identifier. See <a href="https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md">Glossary – Product identifiers.</a></td>
</tr>
<tr>
<td>.. no_of_fqdns</td>
<td>optional</td>
<td>integer</td>
<td>Number of FQDN SAN slots.<br>Range: 0-250. Note that the total number of SANs cannot exceed 250.</td>
</tr>
<tr>
<td>.. no_of_wildcards</td>
<td>optional</td>
<td>integer</td>
<td>Number of Wildcard SAN slots.<br>Range: 0-250. Note that the total number of SANs cannot exceed 250.</td>
</tr>
<tr>
<td>.. validity_years</td>
<td>conditional</td>
<td>integer</td>
<td>The number of years of order coverage. You must provide a value for either <code>validity_years</code> or <code>validity_days</code>.<br>Range: Maximum order validity varies by product. To get the maximum order validity period for a product, use the Product info endpoint.</td>
</tr>
<tr>
<td>.. validity_days</td>
<td>conditional</td>
<td>integer</td>
<td>The number of days of order coverage. Overrides <code>validity_years</code>. You must provide a value for either <code>validity_years</code> or <code>validity_days</code>.<br>Range: Maximum order validity varies by product. To get the maximum order validity period for a product, use the Product info endpoint.</td>
</tr>
<tr>
<td>.. quantity</td>
<td>required</td>
<td>integer</td>
<td>Quantity of certificates you want to order with this configuration. Each certificate receives a unique voucher code.<br>Range: 1-1000</td>
</tr>
<tr>
<td>.. shipping_method</td>
<td>conditional</td>
<td>string</td>
<td>For document signing and code signing certificates, choose how the requestor will provision or ship the certificates. Usage requirements depend on product type.<br><ul><li><strong>Document signing certificates:</strong><code>shipping_method</code> is required. Allowed values are <code>STANDARD</code> and <code>EXPEDITED</code>. Regardless of the shipping method, the requestor redeeming the voucher can choose a provisioning method of either Preconfigured Hardware Token (ship_token) or Use Existing Token (client_app). If they choose Preconfigured Hardware Token, they must use the same shipping method included on the voucher.</li><li><strong>Code signing certificates:</strong><code>shipping_method</code> is optional. Allowed values are <code>STANDARD</code>, <code>EXPEDITED</code>, and <code>KEYLOCKER</code>. The presence or absence of the <code>shipping_method</code> field determines which provisioning methods the requestor can use when redeeming the voucher. <ul><li><code>shipping_method</code> is <code>STANDARD</code> or <code>EXPEDITED</code>: Creates a voucher that allows the requestor to choose a provisioning method of <strong>DigiCert-provided hardware token</strong> (<code>ship_token</code>). Voucher cost includes price of both certificates and hardware tokens.</li><li><code>shipping_method</code> is <code>KEYLOCKER</code>: Creates a voucher that allows the requestor to choose a provisioning method of <a href="https://docs.digicert.com/en/digicert-one/digicert-keylocker.html" target="_blank" rel="noopener noreferrer">DigiCert KeyLocker</a> (<code>keylocker</code>). Voucher cost includes price of both certificates and DigiCert KeyLocker.</li><li><code>shipping_method</code> is omitted: Creates a voucher that allows the requestor to choose a provisioning method of <strong>Use existing token</strong> (<code>client_app</code>) or <strong>Install on HSM</strong> (<code>email</code>). Voucher cost includes price of certificates only.</li></ul></li><li><strong>Other products:</strong><code>shipping_method</code> is not used. Omit from your request.</li></ul></td>
</tr>
<tr>
<td>payment_method</td>
<td>required</td>
<td>string</td>
<td>Specify the payment method to use.<br>Allowed values:balance, card, wire_transfer</td>
</tr>
<tr>
<td>credit_card</td>
<td>conditional</td>
<td>object</td>
<td>Object with information about the credit card charged for the order. Required if <code>payment_method</code> is card; otherwise, ignored.</td>
</tr>
<tr>
<td>.. number</td>
<td>required</td>
<td>string</td>
<td>Credit card number.</td>
</tr>
<tr>
<td>.. expiration_month</td>
<td>required</td>
<td>integer</td>
<td>Credit card expiration month. Format as a two-digit number between <code>01</code> (Jan) and <code>12</code> (Dec).</td>
</tr>
<tr>
<td>.. expiration_year</td>
<td>required</td>
<td>integer</td>
<td>Credit card expiration year. Format as a four-digit number. For example: <code>2026</code></td>
</tr>
<tr>
<td>.. cvv</td>
<td>required</td>
<td>integer</td>
<td>Card verification value (CVV). Format as a three- or four-digit number. For example: <code>333</code> or <code>4444</code></td>
</tr>
<tr>
<td>.. cardholder_name</td>
<td>required</td>
<td>string</td>
<td>Cardholder’s first and last name.</td>
</tr>
<tr>
<td>billing_address</td>
<td>conditional</td>
<td>object</td>
<td>Object with information about the billing address. Required if <code>payment_method</code> is <code>card</code>; otherwise, ignored.</td>
</tr>
<tr>
<td>.. address</td>
<td>required</td>
<td>string</td>
<td>Billing street address.</td>
</tr>
<tr>
<td>.. address2</td>
<td>optional</td>
<td>string</td>
<td>Continuation of street address.</td>
</tr>
<tr>
<td>.. city</td>
<td>required</td>
<td>string</td>
<td>Billing city.</td>
</tr>
<tr>
<td>.. state</td>
<td>conditional</td>
<td>string</td>
<td>Billing state or province. Optional for some countries.</td>
</tr>
<tr>
<td>.. country</td>
<td>required</td>
<td>string</td>
<td>Billing country.</td>
</tr>
<tr>
<td>.. zip</td>
<td>conditional</td>
<td>string</td>
<td>Billing zip or postal code. Optional for some countries.</td>
</tr>
<tr>
<td>billing_contact</td>
<td>conditional</td>
<td>object</td>
<td>Billing contact to use for wire transfers. Required if <code>payment_method</code> is <code>wire_transfer</code>; otherwise, ignored.</td>
</tr>
<tr>
<td>.. name</td>
<td>required</td>
<td>string</td>
<td>Billing contact name.<br><strong>Character limit:</strong> 128</td>
</tr>
<tr>
<td>.. organization_name</td>
<td>required</td>
<td>string</td>
<td>Billing contact organization name.<br><strong>Character limit:</strong> 128</td>
</tr>
<tr>
<td>.. country</td>
<td>required</td>
<td>string</td>
<td>Two-letter country code for the country where the billing contact resides.<br><strong>Format:</strong> Must be a valid ISO 3166-1 alpha-2 code.</td>
</tr>
<tr>
<td>.. address</td>
<td>required</td>
<td>string</td>
<td>Billing contact address.<br><strong>Character limit:</strong> 64</td>
</tr>
<tr>
<td>.. address2</td>
<td>optional</td>
<td>string</td>
<td>Continuation of billing contact address.<br><strong>Character limit:</strong> 64</td>
</tr>
<tr>
<td>.. city</td>
<td>required</td>
<td>string</td>
<td>Billing contact city.<br><strong>Character limit:</strong> 64</td>
</tr>
<tr>
<td>.. state</td>
<td>optional</td>
<td>string</td>
<td>Billing contact state or province.<br><strong>Character limit:</strong> 64</td>
</tr>
<tr>
<td>.. zip</td>
<td>required</td>
<td>integer</td>
<td>Billing contact zip or postal code.<br><strong>Character limit:</strong> 10</td>
</tr>
<tr>
<td>.. email</td>
<td>required</td>
<td>string</td>
<td>Billing contact email address.<br><strong>Character limit:</strong> 255</td>
</tr>
<tr>
<td>.. phone</td>
<td>optional</td>
<td>string</td>
<td>Billing contact phone number.<br><strong>Character limit:</strong> 32</td>
</tr>
<tr>
<td>name</td>
<td>optional</td>
<td>string</td>
<td>Include a customer name or organization that this voucher order is intended for. Only for tracking and order management purposes.<br>Character limit:
128</td>
</tr>
<tr>
<td>notes</td>
<td>optional</td>
<td>string</td>
<td>Include any notes that help you with order management.<br>Character limit:
512</td>
</tr>
</tbody>
</table>

## Response parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>integer</td>
<td>Voucher order ID.</td>
</tr>
<tr>
<td>name</td>
<td>string</td>
<td>Voucher order name provided in request.</td>
</tr>
<tr>
<td>status</td>
<td>string</td>
<td>Status of Voucher order.<br>Possible values:active, used, canceled</td>
</tr>
<tr>
<td>cost</td>
<td>number</td>
<td>Voucher order cost, without tax.</td>
</tr>
<tr>
<td>cost_plus_tax</td>
<td>number</td>
<td>Voucher order cost, with tax.</td>
</tr>
<tr>
<td>created_date</td>
<td>string</td>
<td>Date and time the voucher order was created.<br><strong>Format:</strong> <code>YYYY-MM-DD hh-mm-ss</code></td>
</tr>
<tr>
<td>expiration_date</td>
<td>string</td>
<td>Date the voucher order expires.<br><strong>Format:</strong><code>YYYY-MM-DD</code></td>
</tr>
<tr>
<td>receipt_id</td>
<td>integer</td>
<td>Receipt ID. Returned when the <code>payment_method</code> for the order is <code>balance</code> or <code>card</code>. Not returned if <code>cost_plus_tax</code> is 0.</td>
</tr>
<tr>
<td>invoice_id</td>
<td>integer</td>
<td>Invoice ID. Returned when the <code>payment_method</code> for the order is <code>wire_transfer</code>. Not returned if <code>cost_plus_tax</code> is 0.</td>
</tr>
<tr>
<td>codes</td>
<td>array</td>
<td>List of objects with details about the voucher codes in this order. Each certificate in the order is returned as a separate object.</td>
</tr>
<tr>
<td>.. id</td>
<td>integer</td>
<td>Voucher code ID.</td>
</tr>
<tr>
<td>.. value</td>
<td>string</td>
<td>Unique voucher code.</td>
</tr>
<tr>
<td>.. product</td>
<td>object</td>
<td>Object with product details.</td>
</tr>
<tr>
<td>.. .. name_id</td>
<td>string</td>
<td>Name ID of the product. See <a href="https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md">Glossary – Product identifiers</a>.</td>
</tr>
<tr>
<td>.. no_of_fqdns</td>
<td>integer</td>
<td>Number of FQDN SAN slots.<br>Possible values: 0-250. Note that the total number of SANs cannot exceed 250.</td>
</tr>
<tr>
<td>.. no_of_wildcards</td>
<td>integer</td>
<td>Number of Wildcard SAN slots.<br>Possible values: 0-250. Note that the total number of SANs cannot exceed 250.</td>
</tr>
<tr>
<td>.. validity_years</td>
<td>integer</td>
<td>Number of years the certificate is valid. Only returned if the order request used <code>validity_years</code> to set the validity period.</td>
</tr>
<tr>
<td>.. validity_days</td>
<td>integer</td>
<td>Number of days the certificate is valid. Only returned if the order request used <code>validity_days</code> to set the validity period.</td>
</tr>
<tr>
<td>.. status</td>
<td>string</td>
<td>Voucher code status.</td>
</tr>
<tr>
<td>notes</td>
<td>string</td>
<td>Notes provided in request to help you manage the voucher order.</td>
</tr>
</tbody>
</table>