Voucher price estimate

4 minute read

POST https://www.digicert.com/services/v2/finance/voucher-pricing

Use this endpoint to get price estimates for a voucher order.

Example requests and responses

cURL

curl --request POST 'https://www.digicert.com/services/v2/finance/voucher-pricing' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "vouchers": [
    {
      "product_name_id": "ssl_basic",
      "no_of_fqdns": 4,
      "no_of_wildcards": 1,
      "validity_years": 3,
      "quantity": 4
    },
    {
      "product_name_id": "ssl_ev_basic",
      "no_of_fqdns": 3,
      "validity_years": 3,
      "quantity": 3
    }
  ],
  "billing_address": {
    "country": "us",
    "state": "Washington",
    "city": "Seattle",
    "zip": "98101"
  }
}'

{
  "voucher_prices": [
    {
      "product_name_id": "ssl_basic",
      "no_of_fqdns": 4,
      "no_of_wildcards": 1,
      "validity_years": 3,
      "quantity": 4,
      "cost": 23088
    },
    {
      "product_name_id": "ssl_ev_basic",
      "no_of_fqdns": 3,
      "validity_years": 3,
      "quantity": 3,
      "cost": 13002
    }
  ],
  "total_cost": 36090,
  "total_tax": 3699.23,
  "total_cost_plus_tax": 39789.23,
  "currency": "USD"
}

{
  "errors": [
    {
      "code": "cannot_set_both_validity_years_and_validity_days_for_voucher",
      "message": "Cannot set both validity years and validity days for voucher."
    }
  ]
}

Request parameters

Name	Req/Opt	Type	Description
vouchers	required	array	List of objects with details about each voucher configuration to request a price estimate for.
.. product_name_id	required	string	Product name identifier. See Glossary – Product identifiers.
.. no_of_fqdns	optional	int	Number of FQDN SAN slots. Range: 0-250. Note that the total number of SANs cannot exceed 250.
.. no_of_wildcards	optional	int	Number of Wildcard SAN slots. Range: 0-250. Note that the total number of SANs cannot exceed 250.
.. shipping_method	conditional	string	For document and code signing certificates, choose how the requestor will provision or ship the certificates. Usage requirements depend on product type. Document signing certificates:`shipping_method` is required. Allowed values are `STANDARD` and `EXPEDITED`. `shipping_method` is `STANDARD`: For certificates provisioned using preconfigured hardware token with standard shipping, or for certificates provisioned using an existing token. Estimate includes cost of certificates. Preconfigured hardware token and standard shipping are included in certificate cost. `shipping_method` is `EXPEDITED`: For certificates provisioned using a preconfigured hardware token with expedited shipping. Estimate includes cost of certificates and expedited shipping. Preconfigured hardware token is included in certificate cost. Code signing certificates:`shipping_method` is optional. Allowed values are `STANDARD`, `EXPEDITED`, and `KEYLOCKER`. `shipping_method` is `STANDARD` or `EXPEDITED`: For certificates provisioned using a DigiCert-provided hardware token. Estimate includes cost of certificates, hardware tokens, and hardware token shipping. `shipping_method` is `KEYLOCKER`: For certificates provisioned using DigiCert KeyLocker. Estimate includes cost of both certificates and DigiCert KeyLocker. `shipping_method` omitted: For certificates that will be installed on an existing token or HSM. Estimate includes cost of certificates only. Other products:`shipping_method` is not used. Omit from your request.
.. validity_years	conditional	int	The number of years of order coverage. You must provide a value for validity_years or validity_days. Range: Maximum order validity varies by product. To get the maximum order validity period for a product, use the Product info endpoint.
.. validity_days	conditional	int	The number of days of order coverage. You must provide a value for validity_days or validity_years. Range: Maximum order validity varies by product. To get the maximum order validity period for a product, use the Product info endpoint.
.. quantity	required	int	Quantity of certificates you want to order with this configuration. Each certificate receives a unique voucher code. Range: 1-1000
billing_address	optional	object	Billing address details. Used to calculate estimated tax. If not provided, we calculate estimated tax using the billing address associated with the account used to send the request.
.. country	required	string	Billing country.
.. city	required	string	Billing city.
.. state	conditional	string	Billing state or province. Optional for some countries.
.. zip	conditional	string	Zip/postal code. Optional for some countries.
.. address	optional	string	Billing address.
.. address2	optional	string	Continuation of the billing address.

Response parameters

Name	Type	Definition
voucher_prices	array	List of objects with details about each voucher configuration included in the request.
.. product_name_id	string	Name ID of the product.
.. no_of_fqdns	int	Number of FQDN SAN slots.
.. no_of_wildcards	int	Number of Wildcard SAN slots. Range: 0-250
.. shipping_method	string	Shipping method. Omitted if none exists.
.. validity_years	int	The number of years of order coverage. Only returned if you use validity_years to specify order validity in the request.
.. validity_days	int	The number of days of order coverage. Only returned if you use validity_days to specify order validity in the request.
.. quantity	int	Quantity of certificates you want to order with this configuration.
.. cost	float	Estimated cost, excluding tax.
total_cost	float	Estimated total cost, excluding tax.
total_tax	float	Estimated tax on total cost. Returns `0` if an error prevents tax calculation. Note: Estimated tax may change when you place your order.
total_cost_plus_tax	float	Estimated total cost including tax.
currency	string	Price estimate currency.