List unit orders

GET https://www.digicert.com/services/v2/units/order
Use this endpoint to get a list of unit orders.

Example requests and responses

curl --request GET 'https://www.digicert.com/services/v2/units/order' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json'
import requests

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

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

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

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

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

func main() {

		url := "https://www.digicert.com/services/v2/units/order"
		method := "GET"

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

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

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

		fmt.Println(string(body))
}
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://www.digicert.com/services/v2/units/order',
  'headers': {
    'X-DC-DEVKEY': {{api_key}},
    'Content-Type': 'application/json'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

200 OK

{
  "orders": [
    {
      "id": 1003,
      "unit_account_id": 1234567,
      "unit_account_name": "Example Subaccount",
      "cost": 10,
      "currency": "USD",
      "status": "completed",
      "expiration_date": "2021-11-02",
      "created_date": "2020-11-02 13:19:47"
    },
    {
      "id": 1007,
      "unit_account_id": 1234567,
      "unit_account_name": "Example Subaccount",
      "cost": 3,
      "currency": "USD",
      "status": "completed",
      "expiration_date": "2021-11-02",
      "created_date": "2020-11-02 13:24:16"
    },
    {
      "id": 1011,
      "unit_account_id": 1234567,
      "unit_account_name": "Example Subaccount",
      "cost": 15,
      "currency": "USD",
      "status": "completed",
      "expiration_date": "2021-11-03",
      "created_date": "2020-11-03 02:13:58"
    }
  ],
  "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.

NameReq/OptTypeDescription
filters[{{property_name}}]optionalstringFilters 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:
sortoptionalstringSorts 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:
offsetoptionalintegerIndex of the first result to include in the response.
Default:
0
limitoptionalintegerTotal number of results to include in the response.
Max: 1000 (default)

Response parameters

NameTypeDescription
ordersarrayList of objects with details for each unit order.
.. idintegerID of the order.
.. unit_account_idintegerAccount ID of the subaccount on the order.
.. unit_account_namestringName of the subaccount on the order.
.. costdoubleTotal order cost.
.. currencystringCurrency unit for order cost.
.. statusstringOrder status.
Possible values: completed, canceled
.. expiration_datestringExpiration date of the units.
Format:
YYYY-MM-DD
.. created_datestringCreation timestamp for the order.
Format:
YYYY-MM-DD hh:mm:ss
pageobjectPagination details for the results. Modified using URL query strings.