Add a domain

The ADDDOMAIN action adds a new or additional Fully Qualified Domain Name (FQDN) or wildcard domain to the subscription. The included domain is added to the subscription associated with the specified ACME account, and becomes available to all ACME accounts that share the same external account binding (EAB) details.

In the standalone domain subscription model, adding your first domain initiates your subscription and billing.

In bundle-based subscriptions, adding a domain:

  • Requires at least one purchased bundle, which initiates the subscription and billing.

  • Consumes one domain slot from the purchased domain capacity (the Wallet).

  • Incurs no additional charges.

  • Returns an error if no domain slots are available.

For more information, see Add a bundle.

For more information about subscriptions and domains, see Subscription overview.

Action: ADDDOMAIN

Variable Name Type Max. Length Description

loginName

string

64 chars

Your account username.

This value is case sensitive.

loginPassword

string

128 chars

Your account password.

This value is case sensitive.

action

string

30 chars

The action to be taken.

In this case, the value is: ADDDOMAIN.

acmeAccountID

string

32 chars

Your Base64 URL-encoded ACME account ID.

domainName

string

255 chars

Your FQDN or wildcard domain name.

quoteOnly

string

1 char

Indicates whether to return a quote or perform the actual action.

The possible values are:

  • N — (Default) Performs the actual ADDDOMAIN action.

  • Y — Returns a quote for the requested action, valid at the time of request, but does not perform any action.

ovAnchorOrderNumber

string

128 chars

(OV certificates only) An organization pre-validation ID to associate with the domains.

This parameter is required for domains requiring OV certificates.

evAnchorOrderNumber

string

128 chars

(EV SSL and eIDAS QWAC‑Legal certificates only) An organization pre-validation ID for EV SSL and eIDAS QWAC issuance to associate with the domains.

This parameter is required when adding domains intended for EV SSL or eIDAS QWAC‑Legal certificates.

addAssociatedFQDN

string

1 char

Indicates whether to include an FQDN associated with the domain being added.

The possible values are:

  • N — (Default) Adds only the specified domain name, in which case a check is performed to determine whether it is eligible to be added for free.

  • Y — Also adds the domain name allowed for free based on the domain type being added.

    See Domain details for more details.
An associated domain can always be added for free throughout the validity of the subscription if needed. To do so, addAssociatedFQDN must be set to N. In this case, the system will perform a lookup for the domain in the subscription to associate it accordingly. Therefore, there is no need to automatically set addAssociatedFQDN = Y unless necessary, as this will complicate subscription management and unnecessarily expand the domain list.

Sample request

curl --location --request POST 'https://secure.trust-provider.com/products/!ACMEAdmin' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=loginName' \
--data-urlencode 'loginPassword=loginPassword' \
--data-urlencode 'action=ADDDOMAIN' \
--data-urlencode 'acmeAccountID=ABc_123xYZ456' \
--data-urlencode 'ovAnchorOrderNumber=12345678' \
--data-urlencode 'domainName=domain.com'

Response

Response parameters

The response may contain the following parameters:

Parameter Type Description

success

boolean

The status of the request.

cost

number

The cost of the subscription extension.

currency

string

The currency of the subscription extension cost.

billingBreakdown

array

A structured breakdown of the charges applied to the subscription.

The beginning of the billingBreakdown array

subscriptionTerm

string

Indicates whether the charge applies to the current subscription term or an extension.

chargedDays

number

The number of days charged for the segment.

totalSubscriptionDays

number

The total number of days in the full subscription term associated with the segment.

chargedAmount

number

The amount charged for the segment.

domains

array

The list of domains added to the subscription.

The beginning of the domains array

domainName

string

The domain name added to the subscription.

Sample success responses

Success response
{
    "success": true,
    "orderNumber": 123456789,
    "cost": 200.00,
    // displayed price is for sample purposes only
    "currency": "USD",
    "domains": [
        {
            "domainName": "domain.com"
        }
    ]
}
Success response with quoteOnly set to Y
{
    "success": true,
    "cost": 200.00,
    // displayed price is for sample purposes only
    "currency": "USD",
    "billingBreakdown": [
        {
            "subscriptionTerm": "current",
            "chargedDays": 338,
            "totalSubscriptionDays": 365,
            "chargedAmount": 23.89
        },
        {
            "subscriptionTerm": "extension",
            "chargedDays": 365,
            "totalSubscriptionDays": 365,
            "chargedAmount": 15
        }
    ],
    "domains": [
        {
            "domainName": "domain.com"
        }
    ]
}