Get TLD pricing and registry requirements
GET /api/v2/products/domains/{tld}
Get prices and registry requirements for one TLD. It needs no API key. Prices cover registration, transfer, renewal and restore after expiry. Only the domainPricing[].years entries returned here can be ordered. Other periods are left out. When the TLD has no one-year registration price, billing.amount is 0, not null. Read register to tell a price from no price: it is null then.
Read it before you build a domain item for POST /api/v2/orders. registryRequirements.registration[] lists what a registration needs. registryRequirements.transfer[] lists what a transfer needs. Copy each acceptedTermsKey into the item’s acceptedTerms[].
Authentication: None. Anyone can call it.
Request
Path parameters
tldstringrequiredse or .se). The list is in GET /api/v2/products/domains.Query parameters
localestringsv gives Swedish. Any other value gives English. Default English.Example
curl "https://cloud.hostup.se/api/v2/products/domains/se"Responses
200 Prices and requirements for the TLD.
{ "tld": ".se", "register": { "amount": 99, "currencyCode": "SEK" }, "transfer": { "amount": 0, "currencyCode": "SEK" }, "renew": { "amount": 169, "currencyCode": "SEK" }, "redemption": { "amount": 0, "currencyCode": "SEK" }, "billing": { "amount": 99, "currencyCode": "SEK", "billingCycle": "annually" }, "domainPricing": [ { "years": 1, "register": { "amount": 99, "currencyCode": "SEK" }, "transfer": { "amount": 0, "currencyCode": "SEK" }, "renew": { "amount": 169, "currencyCode": "SEK" }, "redemption": { "amount": 0, "currencyCode": "SEK" } }, { "years": 2, "register": { "amount": 268, "currencyCode": "SEK" }, "transfer": null, "renew": { "amount": 338, "currencyCode": "SEK" }, "redemption": { "amount": 0, "currencyCode": "SEK" } }, { "years": 3, "register": { "amount": 437, "currencyCode": "SEK" }, "transfer": null, "renew": { "amount": 507, "currencyCode": "SEK" }, "redemption": { "amount": 0, "currencyCode": "SEK" } }, { "years": 5, "register": { "amount": 845, "currencyCode": "SEK" }, "transfer": null, "renew": { "amount": 845, "currencyCode": "SEK" }, "redemption": { "amount": 0, "currencyCode": "SEK" } } ], "configurableOptions": [], "registryRequirements": { "registration": [ { "key": "phoneNumber", "label": "Phone number", "required": true, "appliesTo": "register", "registrantType": "any", "reason": ".se and .nu domains require a registrant phone number before the order can be submitted.", "allowedCountryCodes": null, "allowedRegistrantTypes": null, "alternativeRequirementKey": null, "acceptedTermsKey": null }, { "key": "registrationIdentifier", "label": "Personal identity number or organization number", "required": true, "appliesTo": "register", "registrantType": "any", "reason": ".se and .nu domains require a personal identity number or organization number for the registrant.", "allowedCountryCodes": null, "allowedRegistrantTypes": null, "alternativeRequirementKey": null, "acceptedTermsKey": null }, { "key": "acceptedTerms", "label": ".se registration terms", "required": true, "appliesTo": "register", "registrantType": "any", "reason": ".se domain registrations require acceptance of the registry registration terms before the order can be submitted.", "allowedCountryCodes": null, "allowedRegistrantTypes": null, "alternativeRequirementKey": null, "acceptedTermsKey": "se_registration_terms" } ], "transfer": [ { "key": "phoneNumber", "label": "Phone number", "required": true, "appliesTo": "transfer", "registrantType": "any", "reason": ".se and .nu domains require a registrant phone number before the order can be submitted.", "allowedCountryCodes": null, "allowedRegistrantTypes": null, "alternativeRequirementKey": null, "acceptedTermsKey": null }, { "key": "registrationIdentifier", "label": "Personal identity number or organization number", "required": true, "appliesTo": "transfer", "registrantType": "any", "reason": ".se and .nu domains require a personal identity number or organization number for the registrant.", "allowedCountryCodes": null, "allowedRegistrantTypes": null, "alternativeRequirementKey": null, "acceptedTermsKey": null }, { "key": "eppCode", "label": "Authorization code", "required": true, "appliesTo": "transfer", "registrantType": "any", "reason": "Transfers for this domain extension require an authorization code from the current provider.", "allowedCountryCodes": null, "allowedRegistrantTypes": null, "alternativeRequirementKey": null, "acceptedTermsKey": null } ], "countryEligibility": { "required": false, "allowedCountryCodes": null, "reason": null } }, "availabilityStatus": "available", "available": true, "reason": null}Response fields
tldstringregisternullnull when the TLD has no registration price now.transfernull0 means free. null means no price is set.renewnullredemptionnullbillingobjectdomainPricing[] for other periods.amountnumber0 when the TLD has no one-year registration price. register is then null.currencyCodestringbillingCyclestringannually.domainPricingarray of objectyearsintegerregisternulltransfernullrenewnullredemptionnullconfigurableOptionsarray of objectregistryRequirements to decide what an order needs.registryRequirementsobjectregistrationarray of objectitems[].action is register).keystringeppCode, phoneNumber, registrationIdentifier, companyRegistrationNumber, birthDate, registrantCountry, registrantType, useDomicile, acceptedTerms, nameservers.labelstringrequiredbooleanappliesTostringregister in registration[], transfer in transfer[]. One of register, transfer, both.registrantTypestringany, private, organisation.allowedCountryCodesarray of any or nullallowedRegistrantTypesarray of any or nullalternativeRequirementKeystring or nullacceptedTermsKeystring or nullreasonstringtransferarray of objectitems[].action is transfer).keystringeppCode, phoneNumber, registrationIdentifier, companyRegistrationNumber, birthDate, registrantCountry, registrantType, useDomicile, acceptedTerms, nameservers.labelstringrequiredbooleanappliesTostringregister in registration[], transfer in transfer[]. One of register, transfer, both.registrantTypestringany, private, organisation.allowedCountryCodesarray of any or nullallowedRegistrantTypesarray of any or nullalternativeRequirementKeystring or nullacceptedTermsKeystring or nullreasonstringcountryEligibilityobjectrequiredbooleanallowedCountryCodesarray of any or nullreasonstring or nullavailabilityStatusstringavailable, out_of_stock, hidden.availablebooleanreasonstring or nullErrors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | Invalid request. The response body is an RFC 7807 Problem Details document. |
| 404 | Hostup does not sell this TLD. code is tld_not_supported. |
| 429 | Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. |
| 500 | Internal error. Retry later or contact support if the issue persists. |
| 502 | Prices could not be loaded. upstream_failed: the TLD catalog is unavailable. upstream_tld_product_shape_invalid: the prices for this TLD are unavailable. Retry later. |