Price Charge Extension
Price Charge Extension Introduction
CLOSED
Introduction
The Price Charge Extension is a custom extension which may be used to retrieve the various charges associated with a domain name by use of the Extensible Provisioning Protocol (EPP). These charges include:
- Domain Registration Charges
- Domain Renewal Charges
- Domain Transfer Charges
- Domain Restore Charges
Registrars implementing the Price Charge Extension will be able to make a decision regarding registration of Premium Names by effectively using the EPP system to acknowledge the registration of a Premium Name.
NOTE: ZARC only requires the use of the Price Charge extension when registering a PREMIUM NAME. Registrars that have implemented the Price Charge extension may use the extension in other commands, but the only requirement for its use is for the registration of PREMIUM NAMES.
Notes & Procedures
- The extension may be used during Launch and General Availability for any of the supporting ZARC zones.
- Registrars wanting to use the extension may do so automatically through an EPP Login Command as outlined further down.
- Registrars who are making use of the extension and no longer want to use it may do so by contacting the Registry. The Registry will remove the registrar from the extension list.
- In order to register any Premium Names, the extension MUST be used. No Premium Name registrations will be accepted without the extension.
- During any Launch Period, the relative Launch Phase (“sunrise” or “landrush”) extension MUST be used in the sending command.
Documentation and Resources
EPP Charge Schema Version 1
The complete EPP Schema for the Price Charge Extension.
Price Charge Extension Documentation
The complete EPP commands and responses for the Price Charge extension.
Signing Up For The Extension
Signing Up For The Extension
- In order to signup for the extension, registrars must use the EPP Login command.
- Signing up for the extension only needs to be performed once.
- To successfully use the extension, the <extURI>http://www.unitedtld.com/epp/charge-1.0</extURI> must be declared in the services extension element of the Login command.
- Successfully logging into the EPP system with the extension will automatically set the registrar to use the extension for the gTLD.
- To be signed up for the extension, registrars must successfully login with the extension on every supported Production Server.
Domain Check
Domain Check Command
- The Domain Check command with the extension works for both Launch and General Availability commands. The Launch Command may be seen here. The General Availability Command may be seen here.
- There is no requirement for declaration of any extension on the Domain Check command.
- The response will contain the extension elements outlining the costs as well as category of the domain name.
- All costs represented in the response are INCLUSIVE of Value Added Tax.
- All costs represented in the response correspond to the currency applicable for the namespace.
Interpretation of Results
- The XML contained in the responses for Sunrise, Landrush and General Availability are standard responses as per the documentation available on Registry Website.
- All the information regarding the Price Charge Extension is available within the <charge:chkData> element and it child elements.
- The value represented in the <charge:category> element will identify the type of domain name. This will contain a value of “standard” for standard domain names, or “premium” for premium domain names.
- The associated costs are represented in the values of the various <charge:amount command=”COMMAND”> element.
- The value in the <charge:category name=”AAAA”> element identifies the type of domain name, being either “standard” or “premium”. The value MUST be used in the Domain Create command.
- The value in the <charge:amount command=”transfer”> element identifies the cost of the domain if it is to be transferred. This cost will be applied to the Gaining Registrar on successful transfer.
- The value in the <charge:amount command=”create”> element identifies the cost of the domain if it is to be registered. This value MUST be used for new registrations of PREMIUM NAMES.
- The value in the <charge:amount command=”renew”> element identifies the cost of the domain if it is to be renewed. This does not reflect the cost for renewing the domain while in Closed Redemption.
- The value in the <charge:amount command=”update” name=”restore”> element identifies the cost of the domain if it is to be restored at the time the response was received from the Registry. This amount may differ depending on the status of the domain.
Domain Info
Domain Info
- The Domain Info command with the extension works for both Launch and General Availability commands. The Launch Command may be seen here. The General Availability Command may be seen here.
- There is no requirement for declaration of any extension on the Domain Info command.
- The response will contain the extension elements outlining the costs as well as category of the domain name.
- All costs represented in the response are INCLUSIVE of Value Added Tax.
- All costs represented in the response correspond to the currency applicable for the namespace.
Interpretation of Results
- The XML contained in the responses for Sunrise, Landrush and General Availability are standard responses as per the documentation available on Registry Website.
- All the information regarding the Price Charge Extension is available within the <charge:infData> element and it child elements.
- The value represented in the <charge:category> element will identify the type of domain name. This will contain a value of “standard” for standard domain names, or “premium” for premium domain names.
- The associated costs are represented in the values of the various <charge:amount command=”COMMAND”> element.
- The value in the <charge:category name=”AAAA”> element identifies the type of domain name, being either “standard” or “premium”. The value MUST be used in the Domain Create command.
- The value in the <charge:amount command=”transfer”> element identifies the cost of the domain if it is to be transferred. This cost will be applied to the Gaining Registrar on successful transfer.
- The value in the <charge:amount command=”create”> element identifies the cost of the domain if it is to be re-registered after deletion.
- The value in the <charge:amount command=”renew”> element identifies the cost of the domain if it is to be renewed. This does not reflect the cost for renewing the domain while in Closed Redemption.
- The value in the <charge:amount command=”update” name=”restore”> element identifies the cost of the domain if it is to be restored at the time the response was received from the Registry. This amount may differe depending on the status of the domain.
Domain Create
Domain Create Command
- The Domain Create command with the extension works for both Launch and General Availability commands. The Launch Command may be seen here. The General Availability Command may be seen here.
- The extension must contain the <charge:agreement xmlns:charge=”http://www.unitedtld.com/epp/charge-1.0″> element and the required child elements as outlined below. This element acts as the EPP acknowledgement that a registrar has accepted the associated costs for the registration of the Premium Name.
- The extension must include the correct category of the domain in the value of the <charge:category name=”AAAA”> element. The category value may be one of “standard” or “premium”.
- The extension must contain the <charge:type> element with a value of “price”. The child element of this element must contain the price obtained from either the Domain Info or Domain Check commands as outlined above.
- The extension must contain the <charge:amount command=”create”> element with the attribute “command” along with the attribute value “create”. This represents acknowledgement of the price of registration using the Domain Create command. The element must contain a value reflecting the exact amount presented in the same element as obtained from the Domain Info or Domain Check command.
- The response will contain the extension elements outlining the costs as well as category of the domain name.
- All costs represented in the response are INCLUSIVE of Value Added Tax.
- All costs represented in the response correspond to the currency applicable for the namespace.
Possible Responses:
1001: Launch Create Command Completed Successfully
A response code of 1001 during a Launch Phase when using the Sunrise Create or Landrush Create command means that the command was processed successfully and the domain is in the queue for allocation. The response XML will contain the details for costing for reference to the registrar. Registrars are encouraged to match on the information provided in the <charge:amount command=”create”> element.
1000: General Availability Create Command Completed Successfully
A response code of 1000 during the General Availability Phase means the command was processed successfully and the domain name has been successfully registered. The response XML will contain the details for costing for reference to the registrar. Registrars are encouraged to match on the information provided in the <charge:amount command=”create”> element.
2201: Extension Required
A response code of 2201 means that a premium name was attempted be registered but the extension was not provided. Please review the Domain Create command to ensure that the extension has been provided. The response will contain one of the messages below based on the Phase of the namespace.
- “Charge extension registration required to register Sunrise premium names” : Price Charge extension was not provided for a Sunrise Premium Name Application.
- “Charge extension registration required to register Landrush premium names” : Price Charge extension was not provided for a Landrush Premium Name Application.
- “Required extension ‘http://www.unitedtld.com/epp/charge-1.0’ not provided” : Price Charge extension was not provided for a General Availability Premium Name registration.
2104: Incorrect Price Specified
A response code of 2104 means that the price specified in the <charge:amount command=”create”> element does not match correctly to the amount specified in the response to a Domain Check or Domain Info command. Please review the price specified and ensure that it matches the correct amount for registration.
