Domains-domainName-renewTerms:GET

From Hostway API Documentation
(Difference between revisions)
Jump to: navigation, search
(Example of getting the available renewal terms and pricing.)
 
m (1 revision: Release 87)
 

Latest revision as of 15:22, 15 November 2013

[edit] GET /domains/{domainName}/renewTerms

Get the available renewal terms and pricing for a domain.

Contents

[edit] Request

GET /domains/{domainName}/renewTerms

[edit] 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.

[edit] URI Parameters

promotionCode
String (optional)

[edit] Request Headers

None.

[edit] Request Body

None.

[edit] Response

[edit] 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.

[edit] Response Body

List of the available renewal terms and pricing.

[edit] 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}]
 

[edit] See also


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox