Registry Fee Extension for the Extensible Provisioning Protocol (EPP)

A detailed description of the EPP syntax and semantics can be found in .

This extension does not add any elements to the EPP <check> or <poll> commands or responses.

This extension defines additional elements for the EPP <info> command. The command frame MAY contain an <extension> element which contains a <fee:info> element with the following child elements: A <fee:currency> element that contains the currency the fee is charged in. This must be a three-character currency code from (Note: ISO 4217 provides the special "XXX" code which may be used if the server uses a non-currency based system for assessing fees, such as a system of credits). A <fee:action> element identifying the command. The element values supported by the server is a matter of repository policy, but MUST include as a minimum the following values: "create" indicating a <domain:create> command; "renew" indicating a <domain:renew> command; "transfer" indicating a <domain:transfer> command; If the server supports the Registry Grace Period Mapping, then the server MUST also support the "restore" value. The <fee:action> element MAY have an OPTIONAL "phase" attribute specifying a launch phase as described in . The <fee:action> element may also contain an OPTIONAL "subphase" attribute identifying the custom or sub-phase as described in . A <fee:period> element that contains the number of units to be added to the registration period of the domain object. Example <info> command:

C: <?xml version="1.0" encoding="UTF-8" standalone="no"?> C: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> C: <command> C: <info> C: <domain:info C: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> C: <domain:name hosts="all">example.com</domain:name> C: </domain:info> C: </info> C: <extension> C: <fee:info xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> C: <fee:currency>USD</fee:currency> C: <fee:action phase="sunrise">create</fee:action> C: <fee:period unit="y">1</fee:period> C: </fee:info> C: </extension> C: <clTRID>ABC-12345</clTRID> C: </command> C: </epp> When the server receives an <info> command that includes the extension element described above, its response MUST (subject to the exceptions described below) contain an <extension> element, which MUST contain a child <fee:infData> element. The <fee:infData> MUST contain the following child elements: A <fee:currency> element that contains same currency code that appeared in the original <fee:check> element. A <fee:action> element that contains same action that appeared in the original <fee:check> element. This element MAY have the OPTIONAL "phase" and "subphase" elements, which MUST match the same attributes in the original <fee:check> element. A <fee:period> element that contains same unit that appeared in the original <fee:check> element. A <fee:fee> element that contains the fee associated with the specified transaction. If the domain name requested in the command is invalid, sponsored by another client, or otherwise ineligible for registration, the server MAY choose to omit the <fee:infData> element and return an error instead. Example <info> response:

S: <?xml version="1.0" encoding="UTF-8" standalone="no"?> S: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="1000"> S: <msg>Command completed successfully</msg> S: </result> S: <resData> S: <domain:infData S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> S: <domain:name>example.com</domain:name> S: <domain:roid>EXAMPLE1-REP</domain:roid> S: <domain:status s="ok"/> S: <domain:registrant>jd1234</domain:registrant> S: <domain:contact type="admin">sh8013</domain:contact> S: <domain:contact type="tech">sh8013</domain:contact> S: <domain:ns> S: <domain:hostObj>ns1.example.com</domain:hostObj> S: <domain:hostObj>ns1.example.net</domain:hostObj> S: </domain:ns> S: <domain:host>ns1.example.com</domain:host> S: <domain:host>ns2.example.com</domain:host> S: <domain:clID>ClientX</domain:clID> S: <domain:crID>ClientY</domain:crID> S: <domain:crDate>1999-04-03T22:00:00.0Z</domain:crDate> S: <domain:upID>ClientX</domain:upID> S: <domain:upDate>1999-12-03T09:00:00.0Z</domain:upDate> S: <domain:exDate>2005-04-03T22:00:00.0Z</domain:exDate> S: <domain:trDate>2000-04-08T09:00:00.0Z</domain:trDate> S: <domain:authInfo> S: <domain:pw>2fooBAR</domain:pw> S: </domain:authInfo> S: </domain:infData> S: </resData> S: <extension> S: <fee:infData xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> S: <fee:currency>USD</fee:currency> S: <fee:action phase="sunrise">create</fee:action> S: <fee:period unit="y">1</fee:period> S: <fee:fee>10.00</fee:fee> S: </fee:infData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54322-XYZ</svTRID> S: </trID> S: </response> S: </epp> Example <info> response where the domain name is not registered:

S: <?xml version="1.0" encoding="UTF-8" standalone="no"?> S: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="2303"> S: <msg>Object does not exist.</msg> S: </result> S: <extension> S: <fee:infData xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> S: <fee:currency>USD</fee:currency> S: <fee:action phase="sunrise">create</fee:action> S: <fee:period unit="y">1</fee:period> S: <fee:fee>10.00</fee:fee> S: </fee:infData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54322-XYZ</svTRID> S: </trID> S: </response> S: </epp>

This extension does not add any elements to the EPP <transfer> query command, but does include elements in the response, when the extension has been selected during a <login> command. When the <transfer> query command has been processed successfully, the client selected the extension when it logged in, and the client is authorised by the server to view information about the transfer, the server MAY include in the <extension> section of the EPP response a <fee:trnData> element that contains a <fee:fee> element containing the fee associated with this command. If no <fee:trnData> element is included in the response, then no fee has been assessed by the server for this transaction. Example <transfer> query response:

S: <?xml version="1.0" encoding="UTF-8" standalone="no"?> S: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> S: <response> S: <result code="1001"> S: <msg>Command completed successfully; action pending</msg> S: </result> S: <resData> S: <domain:trnData S: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> S: <domain:name>example.com</domain:name> S: <domain:trStatus>pending</domain:trStatus> S: <domain:reID>ClientX</domain:reID> S: <domain:reDate>2000-06-08T22:00:00.0Z</domain:reDate> S: <domain:acID>ClientY</domain:acID> S: <domain:acDate>2000-06-13T22:00:00.0Z</domain:acDate> S: <domain:exDate>2002-09-08T22:00:00.0Z</domain:exDate> S: </domain:trnData> S: </resData> S: <extension> S: <fee:trnData xmlns:fee="urn:ietf:params:xml:ns:fee-0.3"> S: <fee:fee>5.00</fee:fee> S: </fee:trnData> S: </extension> S: <trID> S: <clTRID>ABC-12345</clTRID> S: <svTRID>54322-XYZ</svTRID> S: </trID> S: </response> S: </epp>

This extension does not add any elements to the EPP <create> command, but does include elements in the response, when the extension has been selected during a <login> command. When the <create> command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the <extension> section of the EPP response a <fee:creData> element that contains a <fee:fee> element containing the fee associated with this command. If no <fee:creData> element is included in the response, then no fee has been assessed by the server for this transaction. Example <create> response:

This extension does not add any elements to the EPP <delete> command, but does include elements in the response, when the extension has been selected during a <login> command. When the <delete> command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the <extension> section of the EPP response a <fee:delData> element that contains a <fee:credit> element containing any credit associated with the deletion of the domain. If no <fee:delData> element is included in the response, then no credit has been assessed by the server for this transaction. Example <delete> response:

This extension does not add any elements to the EPP <renew> command, but does include elements in the response, when the extension has been selected during a <login> command. When the <renew> command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the <extension> section of the EPP response a <fee:renData> element that contains a <fee:fee> element containing the fee associated with this command. If no <fee:renData> element is included in the response, then no fee has been assessed by the server for this transaction. Example <renew> response:

This extension does not add any elements to the EPP <transfer> command, but does include elements in the response, when the extension has been selected during a <login> command. When the <transfer> command has been processed successfully, and the client selected the extension when it logged in, and if the "op" attribute of the <transfer> element of the request was "request", the server MAY include in the <extension> section of the EPP response a <fee:trnData> element that contains a <fee:fee> element containing the fee associated with this command. If no <fee:trnData> element is included in the response, then no fee has been assessed by the server for this transaction. Example <transfer> response:

This extension does not add any elements to the EPP <update> command, but does include elements in the response, when the extension has been selected during a <login> command. When the <update> command has been processed successfully, and the client selected the extension when it logged in, the server MAY include in the <extension> section of the EPP response a <fee:updData> element that contains a <fee:fee> element containing any fee associated with this command. If no <fee:updData> element is included in the response, then no fee has been assessed by the server for this transaction. Example <update> response:

An EPP object mapping is specified in XML Schema notation. The formal syntax presented here is a complete schema representation of the object mapping suitable for automated validation of EPP XML instances. Copyright (c) 2013 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of Internet Society, IETF or IETF Trust, nor the names of specific contributors, may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

BEGIN <?xml version="1.0" encoding="utf-8"?> <schema xmlns="http://www.w3.org/2001/XMLSchema" xmlns:fee="urn:ietf:params:xml:ns:fee-0.3" xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0" xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" targetNamespace="urn:ietf:params:xml:ns:fee-0.3" elementFormDefault="qualified"> <import namespace="urn:ietf:params:xml:ns:eppcom-1.0" /> <import namespace="urn:ietf:params:xml:ns:domain-1.0" /> <annotation> <documentation>Extensible Provisioning Protocol v1.0 domain name extension schema for fee information.</documentation> </annotation>  <element name="info" type="fee:infoType" /> <element name="infData" type="fee:infDataType" /> <element name="creData" type="fee:transformDataType" /> <element name="renData" type="fee:transformDataType" /> <element name="trnData" type="fee:transformDataType" /> <element name="updData" type="fee:transformDataType" /> <element name="delData" type="fee:deleteDataType" />  <complexType name="infoType"> <sequence> <element name="currency" type="fee:currencyType" /> <element name="action" type="fee:actionType" /> <element name="period" type="domain:periodType" /> </sequence> </complexType>  <complexType name="infDataType"> <sequence> <element name="currency" type="fee:currencyType" /> <element name="action" type="fee:actionType" /> <element name="period" type="domain:periodType" /> <element name="fee" type="fee:feeType" /> </sequence> </complexType>  <complexType name="transformDataType"> <sequence> <element name="fee" type="fee:feeType" /> </sequence> </complexType>  <complexType name="deleteDataType"> <sequence> <element name="credit" type="fee:feeType" /> </sequence> </complexType>  <simpleType name="currencyType"> <restriction base="string"> <pattern value="[A-Z]{3}" /> </restriction> </simpleType> <complexType name="actionType"> <simpleContent> <extension base="fee:actionTypeValue"> <attribute name="phase" type="token" /> <attribute name="subphase" type="token" /> </extension> </simpleContent> </complexType> <simpleType name="actionTypeValue"> <restriction base="token"> <minLength value="3"/> <maxLength value="16"/> </restriction> </simpleType> <simpleType name="feeType"> <restriction base="decimal" /> </simpleType> </schema> END