]>
Registry Fee Extension for the Extensible Provisioning Protocol (EPP)GoDaddy Inc.14455 N. Hayden Rd. #219ScottsdaleAZ85260USrcarney@godaddy.comhttp://www.godaddy.comCentralNic Group plc35-39 MoorgateLondonEnglandEC2R 6ARGB+44 20 33 88 0600gavin.brown@centralnic.comhttp://www.centralnic.comjothan@jothan.comhttp://jothan.comApplications and Real-Time
Registration Protocols ExtensionsThis document describes an Extensible Provisioning Protocol (EPP)
extension mapping for registry fees.
Historically, domain name registries have applied a simple fee
structure for billable transactions, namely a basic unit price applied to
domain <create>, <renew>, <transfer> and RGP [RFC3915]
restore commands. Given the relatively small number of EPP servers to
which EPP clients have been required to connect, it has generally been the
case that client operators have been able to obtain details of these fees
out-of-band by contacting the server operators.Given the recent expansion of the DNS namespace, and the proliferation
of novel business models, it is now desirable to provide a method for EPP
clients to query EPP servers for the fees and credits associated with
certain commands and specific objects.This document describes an extension mapping for version 1.0 of the
Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping
provides a mechanism by which EPP clients may query the fees and credits
associated with various billable transactions, and obtain their
current account balance.The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP 14
when, and only when, they appear
in all capitals, as shown here.XML is case sensitive. Unless stated otherwise, XML specifications
and examples provided in this document MUST be interpreted in the
character case presented in order to develop a conforming
implementation."fee" is used as an abbreviation for "urn:ietf:params:xml:ns:epp:fee-1.0".
The XML namespace prefix "fee" is used, but implementations MUST NOT
depend on it and instead employ a proper namespace-aware XML parser and
serializer to interpret and output the XML documents.In examples, "C:" represents lines sent by a protocol client and "S:"
represents lines returned by a protocol server. Indentation and white
space in examples are provided only to illustrate element relationships
and are not a REQUIRED feature of this protocol.
(Note to RFC Editor: remove this section before publication as an RFC.)Servers which implement this extension SHOULD provide a way for clients
to progressively update their implementations when a new version of the
extension is deployed.Servers SHOULD (for a temporary migration period) provide support for
older versions of the extension in parallel to the newest version, and
allow clients to select their preferred version via the <svcExtension>
element of the <login> command.If a client requests multiple versions of the extension at login, then,
when preparing responses to commands which do not include extension
elements, the server SHOULD only include extension elements in the
namespace of the newest version of the extension requested by the client.When preparing responses to commands which do include extension
elements, the server SHOULD only include extension elements for the
extension versions present in the command.The <fee:command> element is used in the EPP <check>
command to determine the fee which is applicable to the given command.The use of the <fee:command> keys off the use of the "name"
attribute to define which transform fees the client is requesting
information about. Here is the list of possible values for the "name"
attribute:"create" indicating a <create> command as defined in [RFC5730];"delete" indicating a <delete> command as defined in [RFC5730];"renew" indicating a <renew> command as defined in [RFC5730];"update" indicating a <update> command as defined in [RFC5730];"transfer" indicating a <transfer> command as defined in [RFC5730];If the server supports the Registry Grace Period Mapping [RFC3915],
then the server MUST also support the "restore" value as defined in
[RFC3915];"custom" indicating a custom command that uses the "customName"
attribute to define the custom operation.The <fee:command> element MAY have an OPTIONAL "phase"
attribute specifying a launch phase as described in
[RFC8334]. It may also contain an OPTIONAL
"subphase" attribute identifying the custom or sub-phase as described in
[RFC8334].The <fee:currency> element is used to indicate which currency
fees are charged in. This value of this element MUST be a
three-character currency code from [ISO4217].Note that 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.The use of <fee:currency> elements in client commands is OPTIONAL: if
a <fee:currency> element is not present in a command, the server
MUST determine the currency based on the server default currency or
based on the client's account settings which are agreed to by the client
and server via an out-of-band channel. However, the <fee:currency> element MUST be present in responses.Servers SHOULD NOT perform a currency conversion if a client uses an
incorrect currency code. Servers SHOULD return a 2004 "Parameter value
range" error instead.When querying for fee information using the <check> command,
the <fee:period> element is used to indicate the units to be added
to the registration period of objects by the <create>, <renew>
and <transfer> commands. This element is derived from the
<domain:period> element described in [RFC5731].The <fee:period> element is OPTIONAL in <check> commands,
if omitted, the server MUST determine the fee(s) using the server
default period. The <fee:period> element MUST be present in
<check> responses.Servers which implement this extension will include elements in
responses which provide information about the fees and/or credits
associated with a given billable transaction.The <fee:fee> and <fee:credit> elements are used to
provide this information. The presence of a <fee:fee> element in
a response indicates a debit against the client's account balance; a
<fee:credit> element indicates a credit. A <fee:fee>
element MUST have a non-negative value. A <fee:credit> element
MUST have a negative value.A server MAY respond with multiple <fee:fee> and <fee:credit>
elements in the same response. In such cases, the net fee or credit
applicable to the transaction is the arithmetic sum of the values of
each of the <fee:fee> and/or <fee:credit> elements. This
amount applies to the total additional validity period applied to the
object (where applicable) rather than to any incremental unit.The following attributes are defined for the <fee:fee> element.
These are described in detail below:description: an OPTIONAL attribute which provides a human-readable
description of the fee. Servers should provide documentation on the
possible values of this attribute, and their meanings.refundable: an OPTIONAL boolean attribute indicating whether the fee
is refundable if the object is deleted.grace-period: an OPTIONAL attribute which provides the time period
during which the fee is refundable.applied: an OPTIONAL attribute indicating when the fee will be
deducted from the client's account.The <fee:credit> element can take a "description" attribute as
described above. No other attributes are defined for this element.<fee:fee> elements MAY have an OPTIONAL "refundable"
attribute which takes a boolean value. Fees may be refunded under
certain circumstances, such as when a domain application is rejected
(as described in [RFC8334]) or when an object is
deleted during the relevant Grace Period (see below).If the "refundable" attribute is omitted, then clients SHOULD NOT
make any assumption about the refundability of the fee.[RFC3915] describes a system of "grace periods", which are time
periods following a billable transaction during which, if an object is
deleted, the client receives a refund.The "grace-period" attribute MAY be used to indicate the relevant
grace period for a fee. If a server implements the Registry Grace
Period extension [RFC3915], it MUST specify the grace period for all
relevant transactions.If the "grace-period" attribute is omitted, then clients SHOULD NOT
make any assumption about the grace period of the fee.If a <fee:fee> element has a "grace-period" attribute then it
MUST also be refundable. If the "refundable" attribute of a
<fee:fee> element is false then it MUST NOT have a
"grace-period" attribute.Fees may be applied immediately upon receipt of a command from a
client, or may only be applied once an out-of-band process (such as
the processing of applications at the end of a launch phase) has taken
place.The "applied" attribute of the <fee:fee> element allows
servers to indicate whether a fee will be applied immediately, or
whether it will be applied at some point in the future. This
attribute takes two possible values: "immediate" or "delayed".The <fee:balance> element is an OPTIONAL element which MAY be
included in server responses to transform commands. If present, it can
be used by the client to determine the remaining credit at the server.Whether or not the <fee:balance> is included in responses is a
matter of server policy. However, if a server chooses to offer support
for this element, it MUST be included in responses to all "transform" or
billable commands (e.g. <create>, <renew>, <update>,
<delete>, <transfer op="request">).The value of the <fee:balance> MAY be negative. A negative
balance indicates that the server has extended a line of credit to the
client (see below).If a server includes a <fee:balance> element in response to
transform commands, the value of the element MUST reflect the client's
account balance after any fees or credits associated with that command
have been applied.As described above, if a server returns a response containing a
<fee:balance> with a negative value, then the server has extended
a line of credit to the client. A server MAY also include a
<fee:creditLimit> element in responses which indicates the maximum
credit available to a client. A server MAY reject certain transactions
if the absolute value of the <fee:balance> is equal to or exceeds the
value of the <fee:creditLimit> element.Whether or not the <fee:creditLimit> is included in responses
is a matter of server policy. However, if a server chooses to offer
support for this element, it MUST be included in responses to all
"transform" commands (e.g. <create>, <renew>, <update>,
<delete>, <transfer op="request">).Objects may be assigned to a particular class, category, or tier,
each of which has a particular fee or set of fees associated with it.
The <fee:class> element, which MAY appear in <check> and
transform responses, is used to indicate the classification of an object.If a server makes use of this element, it should provide clients with
a list of all the values that the element may take via an out-of-band
channel. Servers MUST NOT use values which do not appear on this list.Servers which make use of this element MUST use a <fee:class>
element with the value "standard" for all objects that are subject to
the standard or default fee.The <fee:command> element has two attributes, phase and
subphase, that provide additional information related to a specific
launch phase as described in [RFC8334]. These
attributes are used as filters that should refine the server processing.If the client <fee:command> contains a server supported
combination of phase/subphase the server MUST return fee data (including
the phase/subphase attribute(s)) for the specific combination.If the client <fee:command> contains no phase/subphase
attributes and the server has only one active phase/subphase combination
the server MUST return data (including the phase/subphase attribute(s))
of the currently active phase/subphase.If the client <fee:command> contains no phase/subphase
attributes and the server has more than one active phase/subphase
combination the server MUST respond with a 2003 "Required
parameter missing" error.If the client <fee:command> contains no phase/subphase
attributes and the server is currently in a "quiet period" (e.g. not
accepting registrations or applications) the server MUST return data
consistent with the default general availability phase (e.g. "open" or
"claims") including the appropriate phase/subphase attribute(s).If the client <fee:command> contains a phase attribute with no
subphase and the server has only one active subphase (or no subphase) of
this phase, the server MUST return data (including the phase/subphase
attribute(s)) of the provided phase and currently active subphase.If the client <fee:command> contains a phase attribute with no
subphase and the server has more than one active subphase combination of
this phase, the server MUST respond with a 2003 "Required parameter
missing" error.If the client <fee:command> contains a subphase with no phase
attribute the server MUST respond with a 2003 "Required parameter
missing" error.If the client <fee:command> contains a phase attribute not
defined in [RFC8334] or not supported by server
the server MUST respond with a 2004 "Parameter value range" error.If the client <fee:command> contains a subphase attribute (or
phase/subphase combination) not supported by server the server MUST
respond with a 2004 "Parameter value range" error.The <fee:reason> element is used to provide server specific
text in an effort to better explain why a <check> command did not
complete as the client expected. An OPTIONAL "lang" attribute MAY be
present to identify the language of the returned text and has a default
value of "en" (English).The <fee:reason> element can be used within the server response
<fee:command> element or within the <fee:cd> element.If the server cannot calculate the relevant fees, because the object,
command, currency, period, class or some combination is invalid per
server policy, the server has two ways of handling error processing of
<fee:command> element(s):Fast-fail - The server, upon error identification, MAY stop
processing <fee:command> elements and return to the client a
<fee:cd> containing the <fee:objID> and a
<fee:reason> element detailing the reason for failure.
S: example.xyz
S: Only 1 year registration periods are
S: valid.
S:
]]>
Partial-fail - The server, upon error identification, MAY continue
processing <fee:command> elements and return to the client a
<fee:cd> containing successfully processed <fee:command>
elements and failed <fee:command> elements. All returned failed
<fee:command> elements MUST have a <fee:reason>
element detailing the reason for failure, and the server MAY
additionally include a <fee:reason> element at the
<fee:cd> level.
S: example.xyz
S:
S: 2
S: Only 1 year registration periods are
S: valid.
S:
S:
]]>
In either failure scenario the server MUST set the <fee:cd>
avail attribute to false (0) and the server MUST process all objects in
the client request.Depending on server policy, a client MAY be required to include the
extension elements described in this document for certain transform
commands. Servers must provide clear documentation to clients about the
circumstances in which this extension must be used.The server MUST return avail="0" in its response to a <check>
command for any object in the <check> command that does not
include the <fee:check> extension for which the server would
likewise fail a domain <create> command when no <fee>
extension is provided for that same object.If a server receives a <check> command from a client, which
results in no possible fee combination but where a fee is required, the
server MUST set the "avail" attribute of the <fee:cd> element to
false and provide a <fee:reason>.If a server receives a <check> command from a client, which
results in an ambiguous result (i.e. multiple possible fee combinations)
the server MUST reject the command with a 2003 "Required parameter
missing" error.If a server receives a command from a client, which does not include the
fee extension data elements required by the server for that command, then
the server MUST respond with a 2003 "Required parameter missing" error.If the currency or total fee provided by the client is less than
the server's own calculation of the fee for that command, then the server
MUST reject the command with a 2004 "Parameter value range" error.A detailed description of the EPP syntax and semantics can be found in
[RFC5730].This extension does not add any elements to the EPP <poll> or
<info> commands or responses.This extension defines a new command called the Fee Check Command
that defines additional elements for the EPP <check> command to
provide fee information along with the availability information of the
EPP <check> command.The command MAY contain an <extension> element which MAY
contain a <fee:check> element. The <fee:check> element
MAY contain one <fee:currency> element and MUST contain one or
more <fee:command> elements.The <fee:command> element(s) contain(s) a "name" attribute
(see Section 3.1), an OPTIONAL "phase" attribute, and an OPTIONAL
"subphase" attribute (see Section 3.8). The <fee:command>
element(s) MAY have the following child elements:An OPTIONAL <fee:period> element (as described in Section 3.3).Example <check> command:
C:
C:
C:
C:
C: example.com
C: example.net
C: example.xyz
C:
C:
C:
C:
C: USD
C:
C: 2
C:
C:
C:
C:
C:
C:
C: ABC-12345
C:
C: ]]>
When the server receives a <check> command that includes the
extension elements described above, its response MUST contain an
<extension> element, which MUST contain a child
<fee:chkData> element. The <fee:chkData> element MUST
contain a <fee:currency> element and a <fee:cd> for each
element referenced in the client <check> command.Each <fee:cd> element MUST contain the following child
elements:A <fee:objID> element, which MUST match an element
referenced in the client <check> command.An OPTIONAL <fee:class> element (as described in Section 3.7).A <fee:command> element matching each <fee:command>
(unless the "avail" attribute of the <fee:cd> if false) that
appeared in the corresponding <fee:check> of the client
command. This element MAY have the OPTIONAL "standard" attribute,
with a default value of "0" (or "false"), which indicates whether
the fee matches the fee of the "standard" classification (see
section 3.7). This element MAY have the OPTIONAL "phase" and
"subphase" attributes, which SHOULD match the same attributes in the
corresponding <fee:command> element of the client command if
sent by the client.The <fee:cd> element also has an OPTIONAL "avail"
attribute which is a boolean. If the value of this attribute evaluates
to false, this indicates that the server cannot calculate the relevant
fees, because the object, command, currency, period, class or some
combination is invalid per server policy. If "avail" is false then the
<fee:cd> or the <fee:command> element MUST contain a
<fee:reason> element (as described in Section 3.9) and the
server MAY eliminate some or all of the <fee:command> element(s).The <fee:command> element(s) MAY have the following child
elements:An OPTIONAL <fee:period> element (as described in Section 3.3), which contains the same
unit that appeared in the <fee:period> element of the
command. If the value of the preceding <fee:command> element
is "restore", this element MUST NOT be included, otherwise it MUST
be included. If no <fee:period> appeared in the client command
(and the command is not "restore") then the server MUST return its
default period value.Zero or more <fee:fee> elements (as described in Section 3.4).Zero or more <fee:credit> elements (as described in Section 3.4).An OPTIONAL <fee:reason> element (as described in Section 3.9).If the "avail" attribute of the <fee:cd> element is true and
if no <fee:fee> elements are present in a <fee:command>
element, this indicates that no fee will be assessed by the server for
this command.If the "avail" attribute is true, then the <fee:command>
element MUST NOT contain a <fee:reason> element.Example <check> response:
S:
S:
S:
S: Command completed successfully
S:
S:
S:
S:
S: example.com
S:
S:
S: example.net
S:
S:
S: example.xyz
S:
S:
S:
S:
S:
S: USD
S:
S: example.com
S: Premium
S:
S: 2
S: 10.00
S:
S:
S: 1
S: 10.00
S:
S:
S: 1
S: 10.00
S:
S:
S: 15.00
S:
S:
S:
S: example.net
S: standard
S:
S: 2
S: 5.00
S:
S:
S: 1
S: 5.00
S:
S:
S: 1
S: 5.00
S:
S:
S: 5.00
S:
S:
S:
S: example.xyz
S:
S: 2
S: Only 1 year registration periods are
S: valid.
S:
S:
S:
S:
S:
S: ABC-12345
S: 54322-XYZ
S:
S:
S: ]]>
This extension does not add any elements to the EPP <transfer>
query command, but does include elements in the response, when the
extension is included in the <login> command service extensions.When the <transfer> query command has been processed
successfully, if the client has included the extension in the <login>
command service <svcExtension> element, and if the client is
authorized by the server to view information about the transfer, then
the server MAY include in the <extension> section of the EPP
response a <fee:trnData> element, which contains the following
child elements:A <fee:currency> element (as described in Section 3.2).A <fee:period> element (as described in Section 3.3).Zero or more <fee:fee> elements (as described in Section
3.4) containing the fees that will be charged to the gaining client.Zero or more <fee:credit> elements (as described in
Section 3.4) containing the credits that will be refunded to the
losing client.Servers SHOULD omit <fee:credit> when returning a response to
the gaining client, and omit <fee:fee> elements when returning a
response to the losing client.If no <fee:trnData> element is included in the response, then
no fee will be assessed by the server for the transfer.Example <transfer> query response:
S:
S:
S:
S: Command completed successfully; action pending
S:
S:
S:
S: example.com
S: pending
S: ClientX
S: 2000-06-08T22:00:00.0Z
S: ClientY
S: 2000-06-13T22:00:00.0Z
S: 2002-09-08T22:00:00.0Z
S:
S:
S:
S:
S: USD
S: 1
S: 5.00
S:
S:
S:
S: ABC-12345
S: 54322-XYZ
S:
S:
S: ]]>
This extension adds elements to both the EPP <create> command
and response, when the extension is included in the <login>
command service extensions.When submitting a <create> command to the server, the client
MAY include in the <extension> element a <fee:create>
element which includes the following child elements:An OPTIONAL <fee:currency> element (as described in Section 3.2);One or more <fee:fee> elements (as described in Section 3.4).The server MUST fail the <create> command if the
<fee:fee> provided by the client is less than the server fee.When the <create> command has been processed successfully,
and the client included the extension in the <login> command
service extensions, and a fee was assessed by the server for the
transaction, the server MUST include in the <extension> section
of the EPP response a <fee:creData> element, which contains the
following child elements:A <fee:currency> element (as described in Section 3.2);Zero or more <fee:fee> elements (as described in Section 3.4);Zero or more <fee:credit> elements (as described in Section 3.4);An OPTIONAL <fee:balance> element (as described in Section 3.5);An OPTIONAL <fee:creditLimit> element (as described in Section 3.6).Example <create> command:
C:
C:
C:
C:
C: example.com
C: 2
C:
C: ns1.example.net
C: ns2.example.net
C:
C: jd1234
C: sh8013
C: sh8013
C:
C: 2fooBAR
C:
C:
C:
C:
C:
C: USD
C: 5.00
C:
C:
C: ABC-12345
C:
C: ]]>
Example <create> response:
S:
S:
S:
S: Command completed successfully
S:
S:
S:
S: example.com
S: 1999-04-03T22:00:00.0Z
S: 2001-04-03T22:00:00.0Z
S:
S:
S:
S:
S: USD
S: 5.00
S: -5.00
S: 1000.00
S:
S:
S:
S: ABC-12345
S: 54321-XYZ
S:
S:
S: ]]>
This extension does not add any elements to the EPP <delete>
command, but does include elements in the response, when the extension
is included in the <login> command service extensions.When the <delete> command has been processed successfully,
and the client included the extension in the <login> command
service extensions, the server MAY include in the <extension>
section of the EPP response a <fee:delData> element, which
contains the following child elements:A <fee:currency> element (as described in Section 3.2);Zero or more <fee:fee> elements (as described in Section 3.4);Zero or more <fee:credit> elements (as described in Section 3.4);An OPTIONAL <fee:balance> element (as described in Section 3.5);An OPTIONAL <fee:creditLimit> element (as described in Section 3.6).Example <delete> response:
S:
S:
S:
S: Command completed successfully
S:
S:
S:
S: USD
S: -5.00
S: 1005.00
S:
S:
S:
S: ABC-12345
S: 54321-XYZ
S:
S:
S: ]]>
This extension adds elements to both the EPP <renew> command
and response, when the extension is included in the <login>
command service extensions.When submitting a <renew> command to the server, the client
MAY include in the <extension> element a <fee:renew>
element which includes the following child elements:An OPTIONAL <fee:currency> element (as described in Section 3.2);One or more <fee:fee> elements (as described in Section 3.4).When the <renew> command has been processed successfully, and
the client included the extension in the <login> command service
extensions, the server MAY include in the <extension> section of
the EPP response a <fee:renData> element, which contains the
following child elements:A <fee:currency> element (as described in Section 3.2);Zero or more <fee:fee> elements (as described in Section 3.4);Zero or more <fee:credit> elements (as described in Section 3.4);An OPTIONAL <fee:balance> element (as described in Section 3.5);An OPTIONAL <fee:creditLimit> element (as described in Section 3.6).Example <renew> command:
C:
C:
C:
C:
C: example.com
C: 2000-04-03
C: 5
C:
C:
C:
C:
C: USD
C: 5.00
C:
C:
C: ABC-12345
C:
C: ]]>
Example <renew> response:
S:
S:
S:
S: Command completed successfully
S:
S:
S:
S: example.com
S: 2005-04-03T22:00:00.0Z
S:
S:
S:
S:
S: USD
S: 5.00
S: 1000.00
S:
S:
S:
S: ABC-12345
S: 54322-XYZ
S:
S:
S: ]]>
This extension adds elements to both the EPP <transfer>
command and response, when the value of the "op" attribute of the
<transfer> command element is "request", and the extension is
included in the <login> command service extensions.When submitting a <transfer> command to the server, the
client MAY include in the <extension> element a
<fee:transfer> element which includes the following child
elements:An OPTIONAL <fee:currency> element (as described in Section 3.2);One or more <fee:fee> elements (as described in Section 3.4).When the <transfer> command has been processed successfully,
and the client included the extension in the <login> command
service extensions, the server MAY include in the <extension>
section of the EPP response a <fee:trnData> element, which
contains the following child elements:A <fee:currency> element (as described in Section 3.2);Zero or more <fee:fee> elements (as described in Section 3.4);Zero or more <fee:credit> elements (as described in Section 3.4);An OPTIONAL <fee:balance> element (as described in Section 3.5);An OPTIONAL <fee:creditLimit> element (as described in Section 3.6).Example <transfer> command:
C:
C:
C:
C:
C: example.com
C: 1
C:
C: 2fooBAR
C:
C:
C:
C:
C:
C: USD
C: 5.00
C:
C:
C: ABC-12345
C:
C: ]]>
Example <transfer> response:
S:
S:
S:
S: Command completed successfully; action pending
S:
S:
S:
S: example.com
S: pending
S: ClientX
S: 2000-06-08T22:00:00.0Z
S: ClientY
S: 2000-06-13T22:00:00.0Z
S: 2002-09-08T22:00:00.0Z
S:
S:
S:
S:
S: USD
S: 5.00
S:
S:
S:
S: ABC-12345
S: 54322-XYZ
S:
S:
S: ]]>
This extension adds elements to both the EPP <update>
command and response, when the extension is included in the <login>
command service extensions.When submitting a <update> command to the server, the
client MAY include in the <extension> element a
<fee:update> element which includes the following child
elements:An OPTIONAL <fee:currency> element (as described in Section 3.2);One or more <fee:fee> elements (as described in Section 3.4).When the <update> command has been processed successfully,
and the client included the extension in the <login> command
service extensions, the server MAY include in the <extension>
section of the EPP response a <fee:updData> element, which
contains the following child elements:A <fee:currency> element (as described in Section 3.2);Zero or more <fee:fee> elements (as described in Section 3.4);Zero or more <fee:credit> elements (as described in Section 3.4);An OPTIONAL <fee:balance> element (as described in Section 3.5);An OPTIONAL <fee:creditLimit> element (as described in Section 3.6).Example <update> command:
C:
C:
C:
C:
C: example.com
C:
C: sh8013
C:
C:
C:
C:
C:
C: USD
C: 5.00
C:
C:
C: ABC-12345
C:
C: ]]>
Example <update> response:
S:
S:
S:
S: Command completed successfully
S:
S:
S:
S: USD
S: 5.00
S:
S:
S:
S: ABC-12345
S: 54321-XYZ
S:
S:
S: ]]>
One schema is presented here that is the EPP Fee Extension schema.The formal syntax presented here is a complete schema representation of
the object mapping suitable for automated validation of EPP XML instances.
The BEGIN and END tags are not part of the schema; they are used to note the
beginning and ending of the schema for URI registration purposes.Copyright (c) 2018 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.
Extensible Provisioning Protocol v1.0 Fee Extension
END]]>
The mapping extensions described in this document do not provide any
security services beyond those described by EPP [RFC5730], the EPP domain
name mapping [RFC5731], and protocol layers used by EPP. The security
considerations described in these other specifications apply to this
specification as well.This document uses URNs to describe XML namespaces and XML schemas
conforming to a registry mechanism described in .Registration request for the fee namespace:URI: urn:ietf:params:xml:ns:epp:fee-1.0Registrant Contact: IESGXML: None. Namespace URIs do not represent an XML specification.Registration request for the fee schema:URI: urn:ietf:params:xml:schema:epp:fee-1.0Registrant Contact: IESGXML: See the "Formal Syntax" section of this document.The EPP extension described in this document should be registered by
the IANA in the EPP Extension Registry described in [RFC7451]. The
details of the registration are as follows:Name of Extension: Registry Fee Extension for the Extensible
Provisioning Protocol (EPP)Document status: Standards TrackReference: (insert reference to RFC version of this document)Registrant Name and Email Address: IESG, <iesg@ietf.org>TLDs: AnyIPR Disclosure: NoneStatus: ActiveNotes: NoneNote to RFC Editor: Please remove this section and the reference to
[RFC7942] before publication.This section records the status of known implementations of the
protocol defined by this specification at the time of posting of this
Internet-Draft, and is based on a proposal described in [RFC7942]. The
description of implementations in this section is intended to assist the
IETF in its decision processes in progressing drafts to RFCs. Please note
that the listing of any individual implementation here does not imply
endorsement by the IETF. Furthermore, no effort has been spent to verify
the information presented here that was supplied by IETF contributors.
This is not intended as, and must not be construed to be, a catalog of
available implementations or their features. Readers are advised to note
that other implementations may exist.According to [RFC7942], "this will allow reviewers and working groups
to assign due consideration to documents that have the benefit of running
code, which may serve as evidence of valuable experimentation and feedback
that have made the implemented protocols more mature. It is up to the
individual working groups to use this information as they see fit".Organization: CentralNicName: RegistryEngine EPP ServiceDescription: Generic high-volume EPP service for gTLDs, ccTLDs and
SLDsLevel of maturity: Deployed in CentralNic's production environment as
well as two other gTLD registry systems, and two ccTLD registry systems.Coverage: All aspects of the protocol are implemented.Licensing: Proprietary In-House softwareContact: epp@centralnic.comURL: https://www.centralnic.comThe authors wish to thank the following persons for their feedback and
suggestions:James Gould of Verisign IncLuis Munoz of ISCMichael Young of ArchitelosBen Levac and Jeff Eckhaus of Demand MediaSeth Goldman of GoogleKlaus Malorny and Michael Bauland of KnippJody Kolker, Joe Snitker and Kevin Allendorf of Go DaddyMichael Holloway of Com LaudeSantosh Kalsangrah of Impetus InfotechAlex Mayrhofer of Nic.atThomas Corte of Knipp Medien und Kommunikation GmbHUpdated schema, moving the "standard" attribute of the "commandDataType" inside the <extension> block.Moved RFC 7451 reference from Normative to Informative section.Updated XML namespace and schema registration to be "epp" scoped -
global replace of XML namespace from urn:ietf:params:xml:ns:fee-1.0
to urn:ietf:params:xml:ns:epp:fee-1.0 and the XML schema
registration from urn:ietf:params:xml:schema:fee-1.0 to
urn:ietf:params:xml:schema:epp:fee-1.0.Updated references to current version of documents and moved the
"standard" attribute from the check command (commandType) to the
check response (commandDataType).Updated document per Working Group Last Call comments. Made minor
textual changes throughout for enhanced clarity per WGLC comments.Updated document per Working Group Last Call comments. Updated schema
to version 1.0 in anticipation of standardization, no changes were made
to the latest, 0.25, schema. Made minor textual changes throughout for
enhanced clarity per WGLC comments.Updated scheme to version 0.25 to allow tighter checking on
<fee:command> by splitting the client and server definitions,
moved the class element from the command to the object level and added
an optional standard attribute to the command element. Also updated
section 3.1 for clarity on name attribute; updated section 3.9 for
clarity on uses of <fee:reason>; removed second paragraph in
section 5.2.1 as it was duplicative of second to last paragraph in 4.0;
and updated section 5.1.1 to add section references.Updated section 3.8 and 5.1.1 to provide clarity on server processing
and response of various scenarios (i.e. "quiet" period processing).Updated section 3.8 and 4.0 to provide clarity on server processing
and response of various scenarios.Updated scheme to version 0.23 to allow the return of no
<fee:command> element(s) if an error situation occurs. Edited
section 3.8 extensively after input from interim meeting and REGEXT F2F
meeting at IETF-99. Added normative reference for
draft-ietf-eppext-launchphase.Updated scheme to version 0.21 to support the lang attribute for the
reason element of the objectCDType and the commandType types as well as
to add the update command to the commandEnum type. Updated section 3.1
to include language for the custom command. Added section 3.9 to provide
a description of the <fee:reason> element. Fixed typos and added
clarification text on when client fee is less than server fee in section
4. Additionally, I added description pointers to appropriate Section 3
definitions for element clarity throughout the document.Updated scheme to version 0.19 to correct typos and to replace the
commandTypeValue type with the commandEnum type and customName attribute for
stricter validation. Updated various text for grammar and clarity. Added
text to section 4 clarifying the <check> response when the client
provided no fee extension but the server was expecting the extension.Updated scheme to version 0.17 to simplify the check command syntax.
Moved fee avail to objectCDType to allow fast failing on error
situations. Removed the objectCheckType as it was no longer being used.
Updated examples to reflect these scheme changes. Added language for
server failing a <create> if the <fee:fee> passed by the
client is less than the server fee.Updated scheme to version 0.15 to fix errors in CommandType,
objectCDType, transformCommandType and transformResultType definitions.Added Roger Carney as author to finish draft. Moved Formal Syntax
section to main level numbering. Various grammar, typos, and
administrative edits for clarity. Removed default value for the
"applied" attribute of <fee:fee> so that it can truly be
optional. Added support for the <delete> command to return a
<fee:fee> element as well. Modified default response on the
<check> command for the optional <fee:period> when it was
not provided in the command, leaving it to the server to provide the
default period value. Extensive edits were done to the <check>
command, the <check> response and to the fee extension schema
(checkType, objectCheckType, objectIdentifierType, objectCDType,
commandType) to support requesting and returning multiple transformation
fees in a single call. Added section on Phase/Subphase to provide more
context on the uses.Updated to be REGEXT WG document.Codes for the representation of currenciesInternational Organization for Standardization
&RFC2119;
&RFC3688;
&RFC3915;
&RFC5730;
&RFC5731;
&RFC7942;
&RFC8174;
&RFC8334;
&RFC7451;