--- title: "Subaccount order info" source_url: https://dev.digicert.com/certcentral-apis/services-api/subaccount/subaccount-order-info.html api_method: GET api_endpoint: "/services/v2/account/subaccount/order/{{order_id}}" api_url: "https://www.digicert.com/services/v2/account/subaccount/order/{{order_id}}" --- **GET** `https://www.digicert.com/services/v2/account/subaccount/order/{{order_id}}` Use this endpoint to get details for a certificate order placed by a subaccount or sub-subaccount. ## Example requests and responses **cURL** ```bash curl -X GET \ 'https://www.digicert.com/services/v2/account/subaccount/order/{{order_id}}' \ -H 'Content-Type: application/json' \ -H 'X-DC-DEVKEY: {{api_key}}' ``` **Python** ```python import requests url = "https://www.digicert.com/services/v2/account/subaccount/order/{{order_id}}" headers = { 'X-DC-DEVKEY': "{{api_key}}", 'Content-Type': "application/json" } response = requests.request("GET", url, headers=headers) print(response.text) ``` **Go** ```go package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://www.digicert.com/services/v2/account/subaccount/order/{{order_id}}" 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)) } ``` **NodeJS** ```javascript var request = require("request"); var options = { method: 'GET', url: 'https://www.digicert.com/services/v2/account/subaccount/order/{{order_id}}', 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); }); ``` **200 OK (pending)** ```json { "id": 123456, "certificate": { "id": 101015, "common_name": "example.com", "dns_names": [ "sub.example.com" ], "signature_hash": "sha256", "ca_cert": { "id": "A937018B9FAF6CC2", "name": "DigiCert Global G2 TLS RSA SHA256 2020 CA1" } }, "organization": { "id": 334455, "name": "Real Organization, LLC", "assumed_name": "Real Organization", "display_name": "Real Organization, LLC (Real Organization)" }, "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 } ``` **200 OK (include_validation_status=true)** ```json { "id": 12345678, "certificate": { "id": 23456, "common_name": "example.com", "dns_names": [ "example.com", "subdomain.example.com" ], "signature_hash": "sha256", "ca_cert": { "id": "", "name": "" } }, "organization": { "id": 1875789, "name": "Example Co.", "assumed_name": "Example", "display_name": "Example Co. (Example)" }, "subaccount": { "account_id": 12345, "account_type": "retail", "organization_name": "Subaccount Inc." }, "product": { "name_id": "ssl_basic", "name": "Basic OV", "type": "ssl_certificate" }, "status": "pending", "date_created": "2023-12-11T22:12:26+00:00", "is_multi_year_plan": "1", "validity_years": 1, "order_price": { "cost": , "currency": "USD" }, "subaccount_order_validations": { "order_name_scope": "base_domain", "order_dcv_method": "dns-txt-token", "organization_validations": [ { "type": "ov", "name": "OV", "description": "Normal Organization Validation", "status": "pending", "verification_details": { "organization_type": "pending", "organization_status": "pending", "address_verification": "pending", "blacklist_fraud": "pending", "request_authenticity": "pending" } } ], "dns_name_validations": [ { "status": "unapproved", "dns_names": [ "subdomain.example.com" ], "base_domain": "example.com" }, { "status": "unapproved", "dns_names": [ "example.com" ], "base_domain": "example.com" } ] } } ``` **200 OK (issued)** ```json { "id": 12345678, "certificate": { "id": 34567891, "thumbprint": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX70C5B", "serial_number": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXC5F", "common_name": "example.com", "dns_names": [ "example.com" ], "valid_from": "2020-10-14", "valid_till": "2021-10-18", "days_remaining": 286, "signature_hash": "sha256", "ca_cert": { "id": "A937018B9FAF6CC2", "name": "DigiCert Global G2 TLS RSA SHA256 2020 CA1" } }, "organization": { "id": 123456, "name": "Example Organization", "display_name": "Example Organization" }, "subaccount": { "account_id": 2345678, "account_type": "enterprise", "organization_name": "Example account" }, "product": { "name_id": "ssl_basic", "name": "Basic OV", "type": "ssl_certificate" }, "order_price": { "cost": 358, "currency": "USD" }, "status": "issued", "date_created": "2020-10-14T15:18:50+00:00", "date_issued": "2020-10-14T15:18:52+00:00", "is_multi_year_plan": "1", "order_valid_from": "2020-10-14", "order_valid_till": "2021-10-19", "validity_years": 1 "cs_provisioning_method": "email" } ``` **200 OK (sub-subaccount order)** ```json { "id": 123456, "subaccount": { "account_id": 123445, "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 } ``` ## URL query parameters
Name Type Description
include_validation_status boolean If true, the response includes a subaccount_order_validations object with details about the status of domain and organization validations for the order. If false (default), the response omits the subaccount_order_validations object.
include_cs_provisioning_method boolean If true, the response includes a cs_provisioning_method parameter that indicates the provisioning method used for the certificate. See Glossary – CS provisioning methods.
Example cURL request
curl -X GET \ https://www.digicert.com/services/v2/order/certificate/{{order_id}}?include_cs_provisioning_method=true\ -H 'Content-Type: application/json' \ -H 'X-DC-DEVKEY: {{api_key}}'}, “status”: “pending”, “caa_status_message”: { “digicert.com”: “CAA check is not called yet” … },
## Response parameters
Name Type Description
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.
.. ca_cert object Details about the issuing CA certificate for the primary certificate on the order.
.. .. id string Issuing CA certificate ID.
.. .. name string Issuing CA certificate name.
organization object Details about the organization associated with the order. Only returned for orders placed by immediate subaccounts.
.. id int Organization ID.
.. name string Legal name of the organization.
.. assumed_name string Public name of the organization. Also called DBA name.
.. display_name string Full name of the organization. Constructed using name + assumed_name.
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. YYYY-MM-DDThh:mm:ssTZD
date_issued string Date when the certificate was issued. Only returned for issued certificate orders.
Format: UTC timezone and ISO 8601 date. YYYY-MM-DDThh:mm:ssTZD
is_multi_year_plan string Returns "1" if the order is a Multi-year Plan.
Only returned if the order is a Multi-year Plan.
order_valid_from string Start date of the order validity period.
Format:YYYY-MM-DD
Only returned for issued certificate orders.
order_valid_till string Expiration date of the order.
Format: YYYY-MM-DDOnly returned for issued certificate orders.
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.
subaccount_order_validations object Object with domain and organization validation details for the order. Only returned if the request URL contains include_validation_status=true.
.. order_name_scope string Domain validation scope for the order. Domain validation scope determines the specific domains that you must validate before DigiCert can issue your certificate.
Possible values:
  • base_domain: Validate each domain and subdomain in the request at the base domain level (such as example.com).
  • fqdn: Validate each domain and subdomain included in the order exactly as named in the request. When using fqdn:
    • If a domain is a subdomain of another domain included on the order, complete the DCV check for the higher-level domain.
    • For OV and EV certificate orders, if a higher-level domain exists in the account with an active validation, we validate the domain under the scope of the existing domain.
.. order_dcv_method string Domain control validation (DCV) method for the order.
.. organization_validations array of objects List of objects with details about organization validations that must be complete before DigiCert can issue the certificate.
Note: The organization_validations array is not returned for DV certificate orders.
.. .. type string Validation type ID. See Glossary – Validation types.
.. .. name string Friendly name of the validation type.
.. .. description string Description of the validation type.
.. .. date_created string Timestamp when validation was completed. UTC timezone and ISO 8601 date.
.. .. validated_until string Timestamp when validation will expire. UTC timezone and ISO 8601 date.
.. .. status string Validation status.
Possible values:pending, active
.. .. verified_contacts array of objects List of objects with details about verified contacts for the organization.
.. .. user_id string Contact user ID. Returns "0" if the verified contact is not a user in your CertCentral account.
.. .. name string Contact name.
.. .. first_name string Contact first name.
.. .. last_name string Contact last name.
.. .. job_title string Contact job title.
.. .. telephone string Contact telephone number.
.. .. email string Contact email address.
.. .. status string Contact approval status.
Possible values:pending, active
.. .. verification_details object Object containing the status of each component involved in verifying your certificate request.
.. .. .. organization_type string Status of verification of organization type. Only returned for OV certificate orders.
Possible values:pending, complete
.. .. .. organization_status string Status of verification that the business is still active. Returned for OV, code signing, and doc signing certificate orders.
Possible values:pending, complete
.. .. .. address_verification string Status of verification of the legal physical address for the organization. Returned for OV, code signing, and doc signing certificate orders.
.. .. .. blacklist_fraud string Status of verification that the organization doesn’t appear on "do not issue" lists or "bad actor" lists. Returned for EV, OV, doc signing, and VMC certificate orders.
Possible values:pending, complete
.. .. .. blacklist_fraud_malware string Status of verification that the organization is not a known malware signer. Returned for code signing and EV code signing certificate orders.
Possible values:pending, complete
.. .. .. request_authenticity string Status of verification that the certificate requestor has authority to order a certificate for the organization. Only returned for OV certificate orders.
Possible values:pending, complete
.. .. .. operational_existence string Status of verification that the organization exists and is operational. Returned for EV, EV code signing, and VMC certificate orders.
Possible values:pending, complete
.. .. .. place_of_business_verification string Status of verification of the organization’s place of business. Returned for EV, EV code signing, and VMC certificate orders.
Possible values:pending, complete
.. .. .. phone_number_verification string Status of verification that the phone number given is valid and tied to the organization. Returned for EV, code signing, EV code signing, and VMC certificate orders.
Possible values:pending, complete
.. .. .. approver_verification string Status of verification that the approver is valid for this organization. Returned for EV, code signing, EV code signing, and VMC certificate orders.
Possible values:pending, complete
.. .. .. approver_blacklist string Status of verification that the approver doesn’t appear on "do not issue" or "bad actor" lists. Returned for EV, code signing, EV code signing, and VMC certificate orders.
Possible values:pending, complete
.. .. .. logo_trademark string Status of verification that the logo is a registered trademark for the organization on the order. Only returned for VMC certificate orders.
Possible values:pending, complete
.. dns_name_validations array of objects List of objects with validation details for each domain on the order. Returned for EV, OV, DV, and VMC certificate orders.
.. .. status Validation status.
Possible values:approved, unapproved
.. .. method DCV method for the domain. Only returned if the validation status for the domain is unapproved.
Note: For OV and EV orders, this parameter is omitted unless the order specifies a domain-level DCV method for the domain. For domains without a method, validate the domain using the DCV method set for the order (order_dcv_method).
.. .. name_scope Domain you must validate to prove you control the domain on the order. Only returned if the validation status for the domain is unapproved.
The name_scope value is useful when you need to validate a domain on the order by completing a DCV check for either the base domain or for a subdomain between the FQDN and base domain.
Note: For OV and EV orders, this parameter is omitted unless the order specifies a domain-level validation scope for the domain. For domains without a name_scope, validate the domain using the validation scope set for the order (order_name_scope).
.. .. dns_names List containing the SAN from the certificate order associated with the validation details in the dns_name_validations object.
.. base_domain Base domain of the hostname in the dns_names array.
cs_provisioning_method string Returns the provisioning method for the certificate. See Glossary – CS provisioning methods.