List subaccount orders

GET https://www.digicert.com/services/v2/account/subaccount/order

Use this endpoint to list all orders from both subaccounts and sub-subaccounts.

Example requests and responses

Example 1. cURL

curl -X GET \
  https://www.digicert.com/services/v2/account/subaccount/order \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'

Example 2. Python

import requests

url = "https://www.digicert.com/services/v2/account/subaccount/order"

headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example 3. Go

package main

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

func main() {

	url := "https://www.digicert.com/services/v2/account/subaccount/order"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example 4. NodeJS

var request = require("request");

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/account/subaccount/order',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Example 5. 200 OK

{
  "orders": [
    {
      "id": 123456,
      "subaccount": {
        "account_id": 112233,
        "account_type": "enterprise",
        "organization_name": "Sub account organization"
      },
      "product": {
        "name_id": "ssl_plus",
        "name": "Standard SSL",
        "type": "ssl_certificate"
      },
      "order_price": {
        "cost": 198,
        "currency": "USD"
      },
      "status": "pending",
      "number_of_sans": 1,
      "date_created": "2019-05-07T09:33:08+00:00",
      "validity_years": 1
    },
    {
      "id": 123457,
      "certificate": {
        "id": 101015,
        "thumbprint": "03F6",
        "serial_number": "0FDA",
        "common_name": "example.com",
        "dns_names": [
          "sub1.example.com",
          "sub2.example.com",
          "sub3.example.com",
          "sub4.example.com"
        ],
        "valid_till": "2020-06-15",
        "organization_units": [
          "IT Dept."
        ],
        "signature_hash": "sha256"
      },
      "subaccount": {
        "account_id": 123445,
        "account_type": "enterprise",
        "organization_name": "Sub account organization"
      },
      "product": {
        "name_id": "ssl_multi_domain",
        "name": "Multi-Domain SSL",
        "type": "ssl_certificate"
      },
      "order_price": {
        "cost": 358,
        "currency": "USD"
      },
      "status": "issued",
      "number_of_sans": 4,
      "date_created": "2019-06-11T07:08:04+00:00",
      "date_issued": "2019-06-11T07:09:00+00:00",
      "validity_years": 1
    },
    {
      "id": 123458,
      "certificate": {
        "id": 3179443638,
        "common_name": "example2.com",
        "dns_names": [
          "sub.example2.com"
        ],
        "organization_units": [
          "Finance Department"
        ],
        "signature_hash": "sha256"
      },
      "subaccount": {
        "account_id": 123445,
        "account_type": "enterprise",
        "organization_name": "Sub account organization"
      },
      "product": {
        "name_id": "ssl_securesite",
        "name": "Secure Site SSL",
        "type": "ssl_certificate"
      },
      "order_price": {
        "cost": 399,
        "currency": "USD"
      },
      "status": "pending",
      "number_of_sans": 1,
      "date_created": "2019-06-21T09:06:47+00:00",
      "validity_years": 1
    }
  ],
  "page": {
    "total": 3,
    "limit": 1000,
    "offset": 0
  }
}

Filters and URL query parameters

This endpoint supports filters, sorting, and pagination. For general information and examples of the syntax to use when applying filters and sorting results, see Services API - Filters, sorting, and pagination parameters.

Name	Req/Opt	Type	Description
filters[`{{property_name}}`]	optional	string	Filters results by the specified property. Replace `{{property_name}}` in your request with the property to use for filtering. This endpoint supports filtering by the following properties: `filters[id]` `filters[certificate_id]` `filters[valid_till]` `filters[common_name]` `filters[status]`: Use `pending`, `issued`, `rejected`, `revoked`, `waiting_pickup`, `reissue_pending`, or `canceled`. Note: The `issued` status filter includes any order where the certificate has been issued, even if the order has expired. `filters[product_name_id]`: See Glossary – Product identifiers. `filters[date_created]` `filters[subaccount]`: Use subaccount ID. `filters[account_type]`: See Glossary – Subaccount types.
sort	optional	string	Sorts results by the value of one or more properties. By default, sorts results in ascending alphabetical order (0-9, A-Z). To sort in descending alphabetical order (9-0, Z-A), prefix the property name with a minus (`-`). To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list. This endpoint supports sorting by the following properties: `id` `common_name` `product_name_id` `date_created` `validity_years`
offset	optional	int	Index of the first result to include in the response. Default:`0`
limit	optional	int	Total number of results to include in the response. Max:`1000` (default)

Response parameters

Name	Type	Description
orders	array	List of returned orders.
.. id	int	Order ID.
.. certificate	object	Details about the certificate ordered. Only returned for orders placed by immediate subaccounts.
.. .. id	int	Certificate ID.
.. .. thumbprint	string	Thumbprint of the certificate. Only returned if certificate status is `issued`.
.. .. serial_number	string	Serial number of the certificate. Only returned if certificate status is `issued`.
.. .. common_name	string	Name secured by the certificate.
.. .. dns_names	array	List of additional names secured by the certificate.
.. .. valid_till	string	Date when certificate validity ends. Only returned if certificate status is `issued`. Format:`yyyy-MM-dd`
.. .. organization_units	array	List of organization units on the certificate.
.. .. signature_hash	string	Signing algorithm used by the certificate.
.. subaccount	object	Details about the subaccount that ordered the certificate.
.. .. account_id	int	Subaccount ID.
.. .. account_type	string	Subaccount type.
.. .. organization_name	string	Primary organization of the subaccount.
.. product	object	Details about the ordered product.
.. .. name_id	string	Name ID of the product. See Glossary – Product identifiers.
.. .. name	string	Display name of the product. See Glossary – Product identifiers
.. .. type	string	Product type. See Glossary – Product types.
.. order_price	object	Details about the order price.
.. .. cost	int	Total order cost.
.. .. currency	string	Currency unit. Possible values:`USD`
.. status	string	Status of the order. See Glossary – Order status.
.. number_of_sans	int	Number of domains in the `dns_names` array.
.. date_created	string	Order creation date. Format: UTC timezone and ISO 8601 date
.. date_issued	string	Date when the certificate was issued. Only returned if certificate status is `issued`. Format:`yyyy-MM-dd`
.. validity_years	int	Number of years the certificate will be valid.
.. order_prices	array of objects	If the subaccount reissues a certificate on the order and the parent account is using a different currency than when the original order was placed, this endpoint returns an `order_prices` array. Each item in the `order_prices` array represents the total cost of reissues requested for the order in the given `currency`. When the subaccount reissues a certificate and the parent account is using the same currency as the when the original order was placed, the extra cost of the reissued certificate is added to the `cost` value in the `order_price` object.
.. .. cost	number	Total cost of reissues requested in the corresponding `currency`.
.. .. currency	string	Currency unit for the corresponding `cost` value.
page	object	Details about results. Modified using URL query strings.

In this section:

List subaccount orders

Example requests and responses

Filters and URL query parameters

Response parameters

Search results