Need help? Call Live Support at +31 (0) 38 453 07 59

Attention! You're currently using the OT&E environment.

Get

Used to get information about an ACME subscription

  • GETMethod
  • /v2/ssl/acme/acmeSubscriptionIdURL
URL fields
Name Type Description Restrictions
acmeSubscriptionId Integer The ID of the subscription
Request parameters
Name Type Required / Optional Description Restrictions
fields String Optional Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.

Successful request

Retrieved ACME subscription successfully
  • 200 OKHTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
id Integer Required ID of subscription
product String Required Product name
domainNames List <String> Optional List of domain names
organization String Optional Organization or individual name
address String Optional Street address
city String Optional City
state String Optional State or province
postalCode String Optional Postal or ZIP code
country String Optional Country code (ISO)
createdDate Timestamp Required Subscription created date
updatedDate Timestamp Optional Subscription updated date
expiryDate Timestamp Required Subscription expiry date
period Integer Required Subscription period
directoryUrl String Required ACME directory endpoint
autoRenew Boolean Required Automatically renew subscription
certValidity Integer Optional Certificate validity in days
orgValidUntil Timestamp Optional Organization validation expiry (OV/EV)
status Enum Required Subscription status

Possible values:

  • ACTIVE: ACME subscription is active
  • SUSPENDED: ACME subscription is suspended
  • REVOKED: ACME subscription is revoked
  • PENDING_ORGANIZATION_VALIDATION: ACME subscription is pending completion of organization validation
approver approver Optional Approver of the ACME subscription, see requiredFields/optionalFields in ssl product metadata for usage.
approver
Name Type Required / Optional Description
firstName String Required First name of the approver
lastName String Required Last name of the approver
jobTitle String Optional Job title of the approver
email String Required Email address of the approver
voice String Required The voice telephone number of the approver

Failed requests

Generic errors can be expected.

URL fields
The ID of the subscription
Request parameters
Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.
Request

GET /v2/ssl/acme/acmeSubscriptionId

Response