Domains-domainName-prices/renew:GET
From Hostway API Documentation
(Difference between revisions)
Corinne.chui (Talk | contribs) m (1 revision) |
|||
(2 intermediate revisions by 2 users not shown) | |||
Line 10: | Line 10: | ||
=== URI Parameters === | === URI Parameters === | ||
− | + | ; filterCurrency- ''string'' | |
+ | : ''(OPTIONAL)'' | ||
+ | : Currency for which prices are displayed. If not provided will default to USD | ||
=== Request Headers === | === Request Headers === | ||
Line 33: | Line 35: | ||
'''Request''' | '''Request''' | ||
<nowiki> | <nowiki> | ||
− | GET /domains/example.com/prices/renew | + | GET /domains/example.com/prices/renew</nowiki> |
− | + | ||
− | + | ||
'''Response''' | '''Response''' | ||
Line 43: | Line 43: | ||
[ | [ | ||
− | {"currency": "USD", "amount": 8.9499999999999993, "type": "domain_renewal_fee", "monthlyCycle": 12}, | + | {"currency": "USD", "amount": 8.9499999999999993, "type": "domain_renewal_fee", "monthlyCycle": 12, "deferred": 0}, |
− | {"currency": "USD", "amount": 17.899999999999999, "type": "domain_renewal_fee", "monthlyCycle": 24}, | + | {"currency": "USD", "amount": 17.899999999999999, "type": "domain_renewal_fee", "monthlyCycle": 24, "deferred": 0}, |
− | {"currency": "USD", "amount": 26.850000000000001, "type": "domain_renewal_fee", "monthlyCycle": 36}, | + | {"currency": "USD", "amount": 26.850000000000001, "type": "domain_renewal_fee", "monthlyCycle": 36, "deferred": 0}, |
− | {"currency": "USD", "amount": 35.799999999999997, "type": "domain_renewal_fee", "monthlyCycle": 48}, | + | {"currency": "USD", "amount": 35.799999999999997, "type": "domain_renewal_fee", "monthlyCycle": 48, "deferred": 0}, |
− | {"currency": "USD", "amount": 44.75, "type": "domain_renewal_fee", "monthlyCycle": 60}, | + | {"currency": "USD", "amount": 44.75, "type": "domain_renewal_fee", "monthlyCycle": 60, "deferred": 0}, |
− | {"currency": "USD", "amount": 89.5, "type": "domain_renewal_fee", "monthlyCycle": 120} | + | {"currency": "USD", "amount": 89.5, "type": "domain_renewal_fee", "monthlyCycle": 120, "deferred": 0} |
− | ] | + | ]</nowiki> |
− | + | Note: Deferred flag is showing whether there is delayed billing configured. | |
− | + | ||
− | + | ||
== See also == | == See also == | ||
* [[Common Features]] | * [[Common Features]] |
Latest revision as of 13:35, 30 May 2016
[edit] GET /domains/{domainName}/prices/renew
Get renewal prices.
Contents |
[edit] Request
GET /domains/{domainName}/prices/renew
[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
- filterCurrency- string
- (OPTIONAL)
- Currency for which prices are displayed. If not provided will default to USD
[edit] Request Headers
None.
[edit] Request Body
None.
[edit] Response
[edit] Status Code
- 200 OK
- Returns the renewal prices.
- 404 Not Found
- No domain prices found.
[edit] Response Body
List of the available renew prices.
[edit] Example of getting renew prices.
Request
GET /domains/example.com/prices/renew
Response
200 OK Content-Type: application/json; charset=UTF-8 [ {"currency": "USD", "amount": 8.9499999999999993, "type": "domain_renewal_fee", "monthlyCycle": 12, "deferred": 0}, {"currency": "USD", "amount": 17.899999999999999, "type": "domain_renewal_fee", "monthlyCycle": 24, "deferred": 0}, {"currency": "USD", "amount": 26.850000000000001, "type": "domain_renewal_fee", "monthlyCycle": 36, "deferred": 0}, {"currency": "USD", "amount": 35.799999999999997, "type": "domain_renewal_fee", "monthlyCycle": 48, "deferred": 0}, {"currency": "USD", "amount": 44.75, "type": "domain_renewal_fee", "monthlyCycle": 60, "deferred": 0}, {"currency": "USD", "amount": 89.5, "type": "domain_renewal_fee", "monthlyCycle": 120, "deferred": 0} ]
Note: Deferred flag is showing whether there is delayed billing configured.
[edit] See also