Extend a subscription

The EXTENDDOMAINS action extends the subscription for all domains or domain capacity associated with the specified ACME account, and to any other ACME accounts that share the same external account binding details.

This action can only be performed within the subscription extension window. The subscription can be extended for 1, 2, or 3 years.

Standalone domain subscriptions

  • Subscription capacity is determined by the number of active domains in the subscription.

  • The extension applies to all active domains currently included in the subscription.

Bundle-based subscriptions

  • The extension applies to subscription capacity.

  • Subscription capacity is determined by the domain capacity created through bundle additions (not used domain slots).

  • Bundle capacity and structure may be adjusted during subscription extension using the renewalBundleList parameter.

  • If renewalBundleList is not provided, the existing bundle capacity and structure is preserved.

  • Capacity reduction cannot exceed the number of available domain slots in the Wallet.

  • Domains removed before subscription extension release capacity that becomes available when the subscription is extended.

  • The released capacity can be used for replacement domains.

  • Replacement domains can be updated or removed until a certificate is issued for them following the standard domain lifecycle rules. If removed, the corresponding domain slot remains available for reuse.

For more information about subscription extensions, see Subscription overview.

Action: EXTENDDOMAINS

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: EXTENDDOMAINS.

acmeAccountID

string

32 chars

Your Base64 URL-encoded ACME account ID.

quoteOnly

string

1 char

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

The possible values are:

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

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

years

integer

Specifies the subscription duration in years.

The possible values are: 1, 2, 3.

If not specified, the value defaults to 1 year.

days

integer

Specifies the subscription duration in days.

The possible values are: 365, 730, 1095.

This is an alternative to the years parameter. Either parameter may be used, but if both years and days are provided, only the years parameter is used.

renewalBundleList

array

(Bundle-based subscriptions only) Specifies the bundle configuration to apply during subscription extension. This parameter is optional.

By default, subscription extension preserves the existing bundle structure.

Use this parameter to:

  • Adjust subscription capacity during renewal.

  • Request a different bundle structure for billing purposes.

For example, if the current capacity consists of two three-domain bundles, you may request an equivalent capacity using a different supported bundle combination, such as one five-domain bundle and one-domain bundle.

Each item in the array must include the following items:

  • domainType — fqdn or wildcard

  • numberOfDomains — Integer value greater than 0 that defines the number of domains per bundle.

The value must match one of the supported bundle sizes:

  • FQDN bundles: 1, 3, 5, 10

  • Wildcard bundles: 1, 3, 5

    • quantity — (Optional) number of bundles. It defaults to 1.

If provided, the subscription capacity is updated according to the specified bundle configuration during extension.

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=EXTENDDOMAINS' \
--data-urlencode 'acmeAccountID=ABc_123xYZ456' \
--data-urlencode 'years=3'

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.

orderNumber

number

The order number for the subscription.

extensionDurationDays

number

The number of days by which the subscription has been extended. The extensionDurationDays value corresponds to the selected subscription duration.

Sample success responses

Success response
{
"success": true,
"orderNumber": 7654321,
"cost": 1000,
// displayed price is for sample purposes only
"currency": "USD",
"extensionDurationDays": 1095
}
Success response with quoteOnly set to Y
{
"success": true,
"cost": 1000.00,
// displayed price is for sample purposes only
"currency": "USD",
"extensionDurationDays": 1095
}