renew (domain)

Request parameters

Standard request parameters

action = renew
object = domain
registrant_ip = valid IP address of the registrant (optional)

Request attributes

Parameters within the attributes associative array are described below.

Parameter name	Obligation	Definition/Value
affiliate_id	Optional	ID that allows RSP's to track orders coming through various affiliates.
auto_renew	Required	A flag indicating whether the domain should be set to auto-renew. 0—Not set to auto-renew 1**—Set to auto-renew
currentexpirationyear	Required	The domain's current expiration year in the format YYYY; must match the data in the registry.
domain	Required	The name of the domain to be renewed. Domain must be registered, and must exist in both OpenSRS and the appropriate registry.
f_parkp	Optional	Enables the Parked Pages Program. When the Parked Pages Program is enabled, a customized page containing contextual ads is displayed. The ads generate revenue whenever a visitor clicks on one of the links, and that revenue is shared with you, the reseller. Important: Enabling Parked Pages changes the nameservers of that domain, and any existing website will not display. Parked Pages functionality is available for these TLDs: .COM, .NET, .ORG, .INFO, .BIZ, .MOBI, .NAME, .ASIA, .BE, .BZ, .CA, .CC, .CO, .EU, .IN, .ME, .NL, .TV, .UK, .US, .WS and .XXX. Y*—Enable Parked Pages for the domain N**—Do not enable ParkedPages for the domain If a reseller has opted out of Parked Pages, the default value (N) is used, even if Y is submitted.
handle	Required	Instructions for the processing of the order. (Overrides the RSP's 'process immediately' settings.). save—Pend the order for the RSP's later approval process**—Process the order immediately
period	Required	The renewal period, from 1 to 10 years. (May not exceed 10 years.)

Response parameters

Standard response parameters

object = domain
action= reply
is_success = Boolean indicating success or failure of the request.
response_code = Response code indicating outcome of the request.
response_text = Message describing the outcome of the request

Response attributes

If the request is successful, the attributes associative array may include the following:

Parameter name	Obligation	Definition/Value
admin_email	Returned if is_success = 1	The email address of the administrative contact for the domain.
auto_renew	Returned if is_success = 1	A flag indicating whether the domain is set to auto-renew. 0—Not set to auto-renew 1**—Set to auto-renew
id	Returned if is_success = 1 and order is not queued	The domain ID. If queue_request_id is returned, id is not returned.
order_id	Returned if is_success = 1	The order ID of the renewal.
queue_request_id	Returned if is_success = 1 and order is queued	The ID of the request as it occurs within the queue. Later, if you want to renew the order from the queue, you'll need this ID. If queue_request_id is returned, id is not returned.
registration expiration date	Returned if is_success = 1	The domain's current expiration year.

Response codes

Response Code	Response Text	Explanation
200	Command completed successfully	Success response.
480	Renew capability is not enabled for domain.tv	Renewals are not yet supported for this TLD.
465	Domain already renewed	Domain has already been successfully renewed, with the current expiration year matching the year provided by the user.
541	Invalid attribute value	Domain's current expiration year in registry doesn't match the year provided by user.
400	Fatal Server Error Domain already renewed; another renewal cannot be applied until the first request completes', at the registry, approximately six to eight weeks after the original expiration date (2003-03-19 12:12:00)	System error. Domain is already in 'renewal applied' state.

📘
Note:
When a renew operation fails, the reseller receives a message indicating which domain failed to be renewed. This message is only sent once in 24 hours, regardless of how many renewals failed within this period.

Example

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
  <header>
    <version>0.9</version>
  </header>
  <body>
    <data_block>
      <dt_assoc>
        <item key="protocol">XCP</item>
        <item key="object">domain</item>
        <item key="action">renew</item>
        <item key="attributes">
          <dt_assoc>
            <item key="domain">example.com</item>
            <item key="auto_renew">1</item>
            <item key="handle">process</item>
            <item key="currentexpirationyear">2022</item>
            <item key="period">1</item>
          </dt_assoc>
        </item>
      </dt_assoc>
    </data_block>
  </body>
</OPS_envelope>

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
  <header>
    <version>0.9</version>
  </header>
  <body>
    <data_block>
      <dt_assoc>
        <item key="protocol">XCP</item>
        <item key="object">DOMAIN</item>
        <item key="action">REPLY</item>
        <item key="is_success">1</item>
        <item key="attributes">
          <dt_assoc>
            <item key="id">682717</item>
            <item key="order_id">23732463</item>
            <item key="registration expiration date">2023-11-18 22:06:49</item>
            <item key="auto_renew">1</item>
            <item key="admin_email">[email protected]</item>
          </dt_assoc>
        </item>
        <item key="response_code">200</item>
        <item key="response_text">Command completed successfully</item>
      </dt_assoc>
    </data_block>
  </body>
</OPS_envelope>