Skip to main content

List replacement benefits

POST https://www.digicert.com/services/v2/competitive-replacement/certificates

Use this endpoint to get information about the discounts available when replacing the certificates on one or more of your domains with a DigiCert product.

Note

To use this endpoint, competitive replacement must be enabled and configured for your account. Contact your account manager or our support team to have this feature enabled.

Example requests and response

Example 1. cURL
curl -X POST 'https://www.digicert.com/services/v2/competitive-replacement/certificates' \
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}' \
-d '{
	"domains": ["exampledomain1.com", "exampledomain2.com"]
}'

Example 2. Python
import requests

url = "https://www.digicert.com/services/v2/competitive-replacement/certificates"

payload = "{\n\t\"domains\": [\"exampledomain1.com\", \"exampledomain2.com\"]\n}"
headers = {
  'Content-Type': 'application/json',
  'X-DC-DEVKEY': '{{api_key}}'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

Example 3. Go
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://www.digicert.com/services/v2/competitive-replacement/certificates"
  method := "POST"

  payload := strings.NewReader("{\n	\"domains\": [\"exampledomain1.com\", \"exampledomain2.com\"]\n}")

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-DC-DEVKEY", "{{api_key}}")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}

Example 4. NodeJS
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://www.digicert.com/services/v2/competitive-replacement/certificates',
  'headers': {
    'Content-Type': 'application/json',
    'X-DC-DEVKEY': '{{api_key}}'
  },
  body: JSON.stringify({"domains":["exampledomain1.com","exampledomain2.com"]})

};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

Request parameters

Name

Req/Opt

Type

Description

domains

required

array

List of domains to check for competitive replacement benefits.

URL query strings

Name

Req/Opt

Type

Description

offset

optional

int

Start list at the specified number for pagination.

Default: 0

limit

optional

int

Truncate list to the specified number for pagination.

Max: 1000 (default)

Response parameters

Name 

Type 

Description 

certificates 

array 

List of objects with competitive replacement details for the certificates that secure each domain in the request.

.. subject 

string 

Subject of the certificate. 

.. san_list 

array 

List of SANs the certificate secures. 

.. serial_number 

string 

Certificate serial number. 

.. issuer_ca 

string 

Name of the intermediate or root certificate authority that issued the certificate. 

.. issuer_brand 

string 

Brand name of the owner of the certificate authority that issued the certificate. 

.. not_before 

string 

Timestamp when certificate validity starts.

Format: UTC timezone and ISO 8601 date

.. not_after 

string 

Timestamp when certificate validity ends.

Format: UTC timezone and ISO 8601 date.

.. validation_type 

string 

Validation type used by the certificate.

Possible values: OV, EV, or DV

.. matched_domains_count 

int 

Number of domains from your request that this certificate secures. 

.. matched_domains 

array 

List of domains from your request that this certificate secures. 

.. certificate_replacement_benefits 

array 

List of objects with information about the discounts and other benefits available for replacing this certificate with a DigiCert product. 

.. .. to_product_type 

string 

Validation type for the products in this object.

Possible values: OV, EV, or DV.

.. .. bonus_type 

string 

Type of benefit available when you replace the certificate with a product in this category.

Possible values: DISCOUNT

.. .. bonus_unit 

float 

Percentage discount applied to order cost when you replace the certificate with a product in this category.

.. .. products 

array 

A list of objects with information about the products in this category to which the above discounts apply. 

.. .. .. product_name_id 

string 

Name ID of the DigiCert product. See Glossary – Product identifiers

.. .. .. product_name 

string 

Display name of the DigiCert product. See Glossary – Product identifiers

.. .. .. additional_discount 

int 

Additional percentage discount applied for this product.

page

object 

Details about results. Modified using URL query strings. 

In this section: