Domains-domainName-renewTerms:GET
From Hostway API Documentation
Revision as of 15:22, 15 November 2013 by Mike.robski (Talk | contribs)
GET /domains/{domainName}/renewTerms
Get the available renewal terms and pricing for a domain.
Contents |
Request
GET /domains/{domainName}/renewTerms
Parameters
- domainName - string
- The domain name. IE: example.com is a valid domain name, whereas http://www.example.com or www.example.com are not. If the domain name is invalid, or is otherwise not registerable such as for a non-existent or non-supported TLD, an error will be returned. Domain names are case insensitive. The domain name must be an open or suspended product under the authenticated franchise.
URI Parameters
- promotionCode
- String (optional)
Request Headers
None.
Request Body
None.
Response
Status Code
- 200 OK
- Returns the available renewal terms and pricing.
- 404 Not Found
- No domain records found for the given domain name.
- 500 Internal Server Error
- If the back end returns no renewal terms and/or pricing.
Response Body
List of the available renewal terms and pricing.
Example of getting the available renewal terms and pricing.
Request
GET /domains/example.com/renewTerms
Response
200 OK
Content-Type: application/json; charset=UTF-8
[{"currency": "USD", "amount": 0.0, "cycleName": "Yearly", "monthlyCycle": 12},
{"currency": "USD", "amount": 0.0, "cycleName": "Two Yearly", "monthlyCycle": 24},
{"currency": "USD", "amount": 0.0, "cycleName": "Three Yearly", "monthlyCycle": 36},
{"currency": "USD", "amount": 0.0, "cycleName": "Four Yearly", "monthlyCycle": 48},
{"currency": "USD", "amount": 0.0, "cycleName": "Five Yearly", "monthlyCycle": 60},
{"currency": "USD", "amount": 0.0, "cycleName": "Ten Yearly", "monthlyCycle": 120}]
See also
