Renewing a Domain Name
Synopsis
| Description: | A command for renewing domain names. |
| URL: | https://toolkit.centralnic.com/srv/issue_renewals |
| HTTP Method: | POST |
| Requires Authentication?: | Yes |
| Requires SSL?: | Yes |
| Query Parameters: | |
| test | The test flag (eg 1 or 0, optional) |
| user | Your Registrar Handle ID |
| password | Your encrypted Registrar password |
| period | Renewal period (integer, optional) |
| domains[] | The domain names to renew (multiple) |
| immediate | Whether or not to immediately issue an invoice (eg 1 or 0, integer, optional) |
This command allows your to generate renewal items for the specified domains. At the end of the day (or at the end of the week, depending on your billing cycle), these domains (and any others that have been renewed recently) will be placed on a single renewal pro-forma or invoice, which will then be issued to you.
You cannot request renewals for domains that already have an outstanding payment against them, or that are newly registered.
NB: On 2004-09-20, the behaviour of this function changed. Previously the function would generate a renewal immediately.
The renewal period is specified by the period paremeter. You can renew domains for a period between 2 and 10 years. If ommitted, the default period (2 years) is used. This renewal period will then be applied to all future renewals, unless it is subsequently changed by another transaction.
Adding the immediate=1 parameter to the request will force the immediate creation of a single renewal pro-forma or invoice for all the domain names supplied. If you're making lots of single-domain renewal requests, using this parameter is not recommended as it will result in a large paperwork overhead for your accounts team.
When a renewal is queued, the line-item's date is set to be the domain's expiry date. This means that you will sometimes see items on invoices that are dated in the future.
Response Format
The response is of the form
Transaction-ID: d8a56727424f16a757aa548b745f7975 Status: 0 Message: Renewal issued OK. Total: 90.00
When the immediate parameter is set, an additional field will appear in the response:
Proforma: 12345
Or, if you're a non-VAT customer:
Invoice: 12345
If you are billed by us in US dollars, a further field will appear in the response:
DollarAmount: 75.00
In the event of an error, the server will return something like this:
Transaction-ID: e2ca01ad7135e787a5e97ad5b421ed74 Status: 1 Message: Renewal period '11' is invalid.