order_details_by_id

id

required

int

ID of the order to get details for.

account_id

string

Account ID associated with the order.

additional_emails

string

Additional email addresses on the order.

agreement_id

string

ID of the CSA agreed to.

auto_renew

string

Specify if the certificate should automatically renew.

Possible values: 0 (disabled), 1 (enabled)

ca_cert_id

string

ID of the issuing certificate authority.

certificate_tracker_id

string

Certificate ID.

common_name

string

Name secured by the certificate.

contacts_email

string

Organization contact email address.

container_id

string

Container ID of the order.

container_name

string

Container name of the order.

cost

string

Order cost.

csr

string

Certificate signing request (CSR).

custom_renewal_message

string

Custom message included in renewal notifications.

customer_order_id

string

Customer order ID.

date_created

string

Date the order was placed.

Format: yyyy-MM-dd HH:mm:ss

dcv_method

string

Domain control validation method configured for the domain. See Glossary – DCV methods.

disable_issuance_email

string

Specifies if issuance emails are sent.

Possible values: 0 (false), 1 (true)

disable_renewal_notifications

string

Specifies if renew notifications are enabled.

Possible values: 0 (false), 1 (true)

dns_names

string

Comma separated list of additional names secured by the certificate.

email

string

If certificate has an embedded email address (e.g., client certificates), returns the email address on the certificate.

firstname

string

First name of organization contact.

has_duplicates

int

Specifies if the certificate has duplicates.

Possible values: 0 (false), 1 (true)

id

string

Order ID.

is_out_of_contract

string

Contract status of the order.

Possible values: 0 (false), 1 (true)

is_renewed

string

Specifies if the order has been renewed.

Possible values: 0 (false), 1 (true)

issuer_common_name

string

Friendly name of the issuing certificate authority.

job_title

string

Job title of the organization contact.

lastname

string

Last name of the organization contact.

locale

string

Locale of the order. See Glossary – Locale codes.

metadata

string

Custom field details.

Format: {{metadata_id}} {{metadata_label}} {{metadata_value}}

Data separator: 0x1f

org_addr1

string

Organization address.

org_addr2

string

organization_city

string

City where the organization is located.

organization_country

string

Country where the organization is located.

organization_id

string

Organization ID associated with the order.

organization_name

string

Organization name.

organization_state

string

State where the organization is located.

organization_unit

string

Organization units on the certificate.

pay_type

string

Payment method used for the order.

Possible values: A (account balance), C (credit card)

plus_feature

string

Specifies if plus feature is enabled for the order.

Possible values: 0 (disabled), 1 (enabled)

product_id

string

ID of the product.

product_name

string

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

product_name_id

string

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

product_type

string

Product type. See Glossary – Product types.

purchased_dns_names

string

Number of additional SANs purchased.

receipt_id

string

Receipt ID.

Renewed

string

Specifies if the order has been renewed.

Possible values: FALSE, TRUE

renewed_order_id

string

Order ID of the previous order. Returned only if order is a renewal.

serial_number

string

Serial number of the certificate.

server_platform_id

string

Server platform ID. See Glossary – Server platforms.

signature_hash

string

Signature hash used to sign the certificate request.

status

string

Order status. See Glossary – Order status.

telephone

string

Phone number of organization contact.

thumbprint

string

Thumbprint of the certificate.

user_assignments

string

ID of the user assigned to the order.

user_email

string

Email address of user that requested the certificate.

user_first_name

string

First name of user that requested the certificate.

user_id

string

ID of the user that placed the order.

user_last_name

string

Last name of user that requested the certificate.

valid_from

string

Date when certificate validity starts.

Format: yyyy-MM-dd

valid_till

string

Date when certificate validity ends.

Format: yyyy-MM-dd

validity_years

string

Number of years the certificate is valid.

data

object

Container for returned query data.

.. order_details_by_id

object

Container for queried fields.

.. .. {{field}}

-

Queried field and value. Returned fields dependent on sent query.