Skip to main content

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

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.

page

object

Details about results. Modified using URL query strings.