RFC 8748

Registry Fee Extension for the Extensible Provisioning Protocol (EPP)

๐Ÿ“… published March 2020, from ietf

RFC 8748: Registry Fee Extension for the Extensible Provisioning Protocol (EPP) ๐Ÿ’–

Heyy bestie, here's the title block tea โ˜•โœจ

  • Series: Internet Engineering Task Force (IETF) ๐ŸŒธ
  • Number: RFC 8748 ๐ŸŽ€
  • Authors: R. Carney (GoDaddy Inc.), G. Brown (CentralNic Group plc), and J. Frakes ๐Ÿฆ‹
  • Category: Standards Track ๐Ÿ‘‘
  • Date: March 2020 ๐Ÿ“…
  • ISSN: 2070-1721 ๐Ÿ”ฅ
  • Obsoletes and updates: this title block doesn't list anything it obsoletes or updates ๐Ÿ™ˆ

Abstract ๐Ÿ“

Okay so the DNS namespace is EXPANDING and there are sooo many novel business models now ๐Ÿ˜ญ which means it's super useful to let EPP clients ask EPP servers what fees and credits apply to different billable transactions, and also get the expected fees and credits for certain commands and objects. This document describes an EPP extension mapping for registry fees. It's giving organization โœจ


Status of This Memo ๐ŸŒˆ

This is an Internet Standards Track document. โญ

This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community, and it went through public review and got approved for publication by the Internet Engineering Steering Group (IESG). If you want more info on Internet Standards, check out Section 2 of RFC 7841. ๐Ÿ’…

Info about the current status of this document, any errata, and how to give feedback is at https://www.rfc-editor.org/info/rfc8748. Bookmark that one bestie ๐Ÿ”–


Copyright (c) 2020 IETF Trust and the persons identified as the document authors. All rights reserved.

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) as they stand on the date this document was published. Please read these carefully, because they spell out your rights and restrictions for this document. Code Components pulled out of this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions, and they come with no warranty, as described in the Simplified BSD License. Legal stuff, but it matters ๐Ÿซถ


Table of Contents ๐Ÿงš

1.  Introduction
  1.1.  Conventions Used in This Document
2.  Migrating to Newer Versions of This Extension
3.  Extension Elements
  3.1.  Client Commands
  3.2.  Currency Codes
  3.3.  Validity Periods
  3.4.  Fees and Credits
    3.4.1.  Refunds
    3.4.2.  Grace Periods
    3.4.3.  Correlation between Refundability and Grace Periods
    3.4.4.  Applicability
  3.5.  Account Balance
  3.6.  Credit Limit
  3.7.  Classification of Objects
  3.8.  "Phase" and "Subphase" Attributes
  3.9.  Reason
4.  Server Handling of Fee Information
5.  EPP Command Mapping
  5.1.  EPP Query Commands
    5.1.1.  EPP <check> Command
    5.1.2.  EPP Transfer Query Command
  5.2.  EPP Transform Commands
    5.2.1.  EPP <create> Command
    5.2.2.  EPP <delete> Command
    5.2.3.  EPP <renew> Command
    5.2.4.  EPP <transfer> Command
    5.2.5.  EPP <update> Command
6.  Formal Syntax
  6.1.  Fee Extension Schema
7.  Security Considerations
8.  IANA Considerations
  8.1.  XML Namespace
  8.2.  EPP Extension Registry
9.  References
  9.1.  Normative References
  9.2.  Informative References
Acknowledgements
Authors' Addresses

1. Introduction โœจ

Historically, domain name registries kept things simple with fees: basically one unit price for billable transactions, which covered domain <create>, <renew>, <transfer>, and Redemption Grace Period (RGP) [RFC3915] restore commands. Since EPP servers were relatively few and EPP clients only had to connect to a handful of them, client operators could usually find out the fees by contacting the server operators directly, outside the protocol. Cute and simple, right? ๐ŸŒธ

Then the DNS namespace expanded and novel business models showed up everywhere, so it's now desirable to give EPP clients a way to query EPP servers for the fees and credits tied to various billable transactions and to certain commands and specific objects. Main character energy for the registry world ๐Ÿ‘‘

This document describes an extension mapping for version 1.0 of the Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping gives clients a mechanism to query the fees and credits attached to various billable transactions, and to get their current account balance ๐Ÿ’ฐ

1.1. Conventions Used in This Document ๐Ÿ“–

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 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. These are the special words with special meaning, so watch the caps ๐Ÿ‘€

XML is case sensitive, so unless it says otherwise, the XML specifications and examples in this document MUST be interpreted in the character case they're shown in when you build a conforming implementation. No vibes-based casing here ๐Ÿ’…

"fee" is shorthand for "urn:ietf:params:xml:ns:epp:fee-1.0". The XML namespace prefix "fee" is used in the examples, but implementations MUST NOT depend on it. Instead, use a proper namespace-aware XML parser and serializer to read and write the XML documents. Prefixes are not the boss of you ๐Ÿ™…โ€โ™€๏ธ

In the examples, "C:" marks lines sent by a protocol client, and "S:" marks lines returned by a protocol server. Indentation and white space in the examples are only there to show how the elements relate, and they're not a required feature of this protocol. Spacing is just for the aesthetic ๐ŸŽ€


2. Migrating to Newer Versions of This Extension ๐Ÿฆ‹

Servers that implement this extension SHOULD provide a way for clients to update their implementations step by step when a new version of the extension gets deployed. Progressive updates are such a mood ๐ŸŒˆ

Servers SHOULD (for a temporary migration period) keep supporting older versions of the extension alongside the newest version, and let clients pick their preferred version through the <svcExtension> element of the <login> command. Choice is iconic โœจ

If a client requests multiple versions of the extension at login, then, when preparing responses to commands that don't include extension elements, the server SHOULD only include extension elements in the namespace of the newest version of the extension that the client requested. Newest version only, periodt ๐Ÿ’–

When preparing responses to commands that do include extension elements, the server SHOULD only include extension elements for the extension versions present in the command. Mirror the versions you were given, bestie ๐Ÿชž


3. Extension Elements ๐Ÿ“

3.1. Client Commands ๐Ÿ’Œ

The <fee:command> element is used in the EPP <check> command to figure out the fee that applies to a given command. It's the fee detective ๐Ÿ•ต๏ธโ€โ™€๏ธ

The "name" attribute of <fee:command> says which transform fees the client wants info about. The possible values for the "name" attribute are:

  • "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 registry grace period mapping [RFC3915], then the server MUST also support the "restore" value as defined in [RFC3915].
  • "custom", indicating a custom command that MUST set the "customName" attribute with a custom command name. The possible set of custom command name values is dictated by the server policy. Server rules get the final word on these names ๐Ÿ™ƒ

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 subphase as described in [RFC8334]. Launch phases with extra flavor, love that ๐Ÿš€

3.2. Currency Codes ๐Ÿ’ธ

The <fee:currency> element shows the currency the fees are charged in. The value of this element MUST be a three-character currency code from [ISO4217_2015]. Three letters, no more, no less ๐Ÿ”ค

[ISO4217_2015] has a special "XXX" code. It MAY be used if the server uses a non-currency-based system for assessing fees, such as a system of credits. So credits-only servers have a valid option too ๐ŸŽŸ๏ธ

Using <fee:currency> elements in client commands is OPTIONAL. If a <fee:currency> element isn't present in a command, the server MUST determine the currency from the server default currency or from the client's account settings, which the client and server agree on through an out-of-band channel. However, the <fee:currency> element MUST be present in the responses. So the server always tells you the currency in the reply, no ghosting ๐Ÿ‘ป

Servers SHOULD NOT perform a currency conversion if a client uses an incorrect currency code. Instead, servers SHOULD return a 2004 "Parameter value range error". No sneaky conversions, just an honest error ๐Ÿ™…โ€โ™€๏ธ๐Ÿ’…

3.3. Validity Periods ๐Ÿ—“๏ธ

When a client queries fee information with the <check> command, the <fee:period> element shows the validity period. That period gets added to extend the registration period of objects handled by the <create>, <renew>, and <transfer> commands. Validity periods are measured in years or months, and the unit gets specified with the "unit" attribute. Valid values for the "unit" attribute are "y" for years and "m" for months. This element is derived from the <domain:period> element described in [RFC5731]. It's basically the domain period's cool cousin ๐Ÿฆ‹

The <fee:period> element is OPTIONAL in <check> commands. If it's left out, the server MUST determine the fee(s) using the server default period. The <fee:period> element MUST be present in <check> responses, so the server always tells you the period it priced ๐ŸŒธโœจ

3.4. Fees and Credits ๐Ÿ’ธ

Okay so servers that implement this extension will include elements in responses that spill the tea on the fees and/or credits tied to a billable transaction. โœจ A fee subtracts from the Account Balance (more on that in Section 3.5), and a credit adds to the Account Balance (same deal, Section 3.5). ๐Ÿ’–

The <fee:fee> and <fee:credit> elements are how this info gets delivered. ๐ŸŽ€ If a <fee:fee> shows up in a response, that's a debit against the client's account balance, and a <fee:credit> means a credit. ๐Ÿฆ‹ A <fee:fee> element MUST have a zero or greater (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. ๐ŸŒธ When that happens, the net fee or credit for 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 for the object (where applicable). โญ

These attributes are defined for the <fee:fee> element, and I'll break them down below: ๐Ÿ‘‘

description: an OPTIONAL attribute that gives a human-readable description of the fee. ๐Ÿ“ Servers should provide documentation on the possible values of this attribute and what they mean. ๐Ÿ’œ An OPTIONAL "lang" attribute MAY be present, per the language structure in [RFC5646], to identify the language of the returned text, and it has a default value of "en" (English). ๐ŸŒˆ If the "description" attribute is not present, the "lang" attribute can be ignored. ๐Ÿ™ˆ

refundable: an OPTIONAL boolean attribute that says whether the fee is refundable if the object is deleted. ๐Ÿ’ฐ

grace-period: an OPTIONAL attribute that gives the time period during which the fee is refundable. โณ

applied: an OPTIONAL attribute that tells you when the fee will be deducted from the client's account. ๐Ÿ“…

The <fee:credit> element can take a "description" attribute, same as above. โœจ An OPTIONAL "lang" attribute MAY be present to identify the language of the returned text, and it has a default value of "en" (English). ๐Ÿ‡ฌ๐Ÿ‡ง

3.4.1. Refunds ๐Ÿ”

<fee:fee> elements MAY have an OPTIONAL "refundable" attribute that 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 Section 3.4.2). ๐Ÿฅน

If the "refundable" attribute is omitted, then clients SHOULD NOT make any assumptions about the refundability of the fee. ๐Ÿ™…โ€โ™€๏ธ

3.4.2. Grace Periods โฐ

[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 assumptions about the grace period of the fee. ๐Ÿคทโ€โ™€๏ธ

3.4.3. Correlation between Refundability and Grace Periods ๐Ÿ”—

If a <fee:fee> element has a "grace-period" attribute, then it MUST also be refundable, and the "refundable" attribute MUST be true. ๐Ÿ’ฏ If the "refundable" attribute of a <fee:fee> element is false, then it MUST NOT have a "grace-period" attribute. ๐Ÿšซ

3.4.4. Applicability ๐ŸŽฌ

Fees may be applied immediately upon receipt of a command from a client, or they 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 lets servers indicate whether a fee will be applied immediately or at some point in the future. โฉ This attribute takes two possible values: "immediate" or "delayed". โœŒ๏ธ

3.5. Account Balance ๐Ÿฆ

The <fee:balance> element is an OPTIONAL element that MAY be included in server responses to transform commands. ๐Ÿ’ณ If it's present, the client can use it to figure out the remaining credit at the server. ๐Ÿง 

Whether or not <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 Section 3.6). ๐Ÿ’ธ

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. ๐Ÿงพ If the "applied" attribute of the <fee:fee> element is "delayed", then the <fee:balance> MUST reflect the client's account balance without any fees or credits associated with that command. โธ๏ธ

3.6. Credit Limit ๐Ÿšฆ

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 in responses a <fee:creditLimit> element that 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 <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">). ๐ŸŽŸ๏ธ

3.7. Classification of Objects ๐Ÿ—‚๏ธ

Objects may be assigned to a particular class, category, or tier, and each one has a particular fee or set of fees attached. ๐Ÿท๏ธ 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 the element may take via an out-of-band channel. ๐Ÿ“ฌ Servers MUST NOT use values that do not appear on this list. ๐Ÿ›‘

Servers that 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. ๐ŸŒŸ

3.8. "Phase" and "Subphase" Attributes ๐ŸŒ™

The <fee:command> element has two attributes, "phase" and "subphase", that provide extra info related to a specific launch phase, as described in [RFC8334]. ๐Ÿš€ These attributes act 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 the fee data (including the phase/subphase attribute(s)) for that 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 the 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 the 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 the 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 the server, the server MUST respond with a 2004 "Parameter value range error". ๐Ÿšซ

3.9. Reason ๐Ÿ’ฌ

The <fee:reason> element is used to provide server-specific text that helps explain why a <check> command did not complete the way the client expected. ๐Ÿง An OPTIONAL "lang" attribute MAY be present to identify the language, per the language structure in [RFC5646], of the returned text, and it 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. ๐Ÿ“ฆ See Section 5.1.1 for details on the <fee:cd> "check data" 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 the error processing of <fee:command> element(s): โš ๏ธ

  1. Fast-fail: The server, upon error identification, MAY stop processing <fee:command> elements and return a <fee:cd> to the client containing the <fee:objID> and a <fee:reason> element detailing the reason for failure. โšก
S: <fee:cd avail="0">
S:   <fee:objID>example.xyz</fee:objID>
S:   <fee:reason>Only 1 year registration periods are
S:   valid.</fee:reason>
S: </fee:cd>
  1. Partial-fail: The server, upon error identification, MAY continue processing <fee:command> elements and return a <fee:cd> to the client containing the 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: <fee:cd avail="0">
S:   <fee:objID>example.xyz</fee:objID>
S:   <fee:command name="create">
S:     <fee:period unit="y">2</fee:period>
S:     <fee:reason>Only 1 year registration periods are
S:     valid.</fee:reason>
S:   </fee:command>
S: </fee:cd>

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. ๐Ÿฅณโœจ

4. Server Handling of Fee Information โœจ

okay bestie, depending on server policy, a client MAY be required to include the extension elements from this doc for certain transform commands ๐ŸŽ€ servers must provide clear documentation to clients about exactly when this extension has to be used, no vibes-based guessing ๐Ÿ’…

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, where the server would 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 that results in no possible fee combination, the server MUST set the "avail" attribute of the <fee:cd> element to false (0) and provide a <fee:reason>. bestie, that's the "nothing works here" response ๐Ÿ™ˆ

If a server receives a <check> command from a client that results in an ambiguous result (i.e., multiple possible fee combinations), the server MUST reject the command with a 2003 "Required parameter missing" error. multiple possible answers? not it ๐Ÿ˜ญ

If a server receives a command from a client that 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 total fee provided by the client is less than the server's own calculation of the fee, or the server determines the currency is inappropriate for that command, then the server MUST reject the command with a 2004 "Parameter value range error". that's a hard no, periodt ๐Ÿ”ฅ

5. EPP Command Mapping

A detailed description of the EPP syntax and semantics can be found in [RFC5730]. go read that if you want the full lore ๐Ÿ“–โœจ

5.1. EPP Query Commands

This extension does not add any elements to the EPP <poll> or <info> commands or responses. no new drama here, they stay exactly as they are ๐ŸŒธ

5.1.1. EPP <check> Command

This extension defines a new command called the Fee Check Command, which adds extra elements to the EPP <check> command so it can hand back fee info. this is the main character moment ๐Ÿ‘‘

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) MUST contain 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).

Here's an example <check> command, it's giving very organized ๐Ÿ’–

C: <?xml version="1.0" encoding="utf-8" standalone="no"?>
C: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:   <command>
C:     <check>
C:       <domain:check
C:         xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:         <domain:name>example.com</domain:name>
C:         <domain:name>example.net</domain:name>
C:         <domain:name>example.xyz</domain:name>
C:       </domain:check>
C:     </check>
C:     <extension>
C:       <fee:check xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0">
C:         <fee:currency>USD</fee:currency>
C:         <fee:command name="create">
C:           <fee:period unit="y">2</fee:period>
C:         </fee:command>
C:         <fee:command name="renew"/>
C:         <fee:command name="transfer"/>
C:         <fee:command name="restore"/>
C:       </fee:check>
C:     </extension>
C:     <clTRID>ABC-12345</clTRID>
C:   </command>
C: </epp>

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> element for each object referenced in the client <check> command. the server has to show up for every single object, no ghosting ๐Ÿ‘€

Each <fee:cd> (check data) 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> is 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 is the standard or default fee (see Section 3.7). This element MAY have the OPTIONAL "phase" and "subphase" attributes, which will 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). so when it's a no, there's always a reason why ๐Ÿ™…โ€โ™€๏ธ

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, if present, that appeared in the <fee:period> element of the command. If the value of the parent <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 (1) and 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. free real estate, literally ๐ŸŽ‰

If the "avail" attribute of the <fee:cd> element is true (1), then the <fee:command> element MUST NOT contain a <fee:reason> element. no reason needed when it's available, it's giving clean ๐Ÿ’…

Example <check> 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:chkData
S:         xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S:         <domain:cd>
S:           <domain:name avail="1">example.com</domain:name>
S:         </domain:cd>
S:         <domain:cd>
S:           <domain:name avail="1">example.net</domain:name>
S:         </domain:cd>
S:         <domain:cd>
S:           <domain:name avail="1">example.xyz</domain:name>
S:         </domain:cd>
S:       </domain:chkData>
S:     </resData>
S:     <extension>
S:       <fee:chkData
S:           xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0">
S:         <fee:currency>USD</fee:currency>
S:         <fee:cd avail="1">
S:           <fee:objID>example.com</fee:objID>
S:           <fee:class>Premium</fee:class>
S:           <fee:command name="create">
S:             <fee:period unit="y">2</fee:period>
S:             <fee:fee
S:               description="Registration Fee"
S:               refundable="1"
S:               grace-period="P5D">10.00</fee:fee>
S:           </fee:command>
S:           <fee:command name="renew">
S:             <fee:period unit="y">1</fee:period>
S:             <fee:fee
S:               description="Renewal Fee"
S:               refundable="1"
S:               grace-period="P5D">10.00</fee:fee>
S:           </fee:command>
S:           <fee:command name="transfer">
S:             <fee:period unit="y">1</fee:period>
S:             <fee:fee
S:               description="Transfer Fee"
S:               refundable="1"
S:               grace-period="P5D">10.00</fee:fee>
S:           </fee:command>
S:           <fee:command name="restore">
S:             <fee:fee
S:               description="Redemption Fee">15.00</fee:fee>
S:           </fee:command>
S:         </fee:cd>
S:         <fee:cd avail="1">
S:           <fee:objID>example.net</fee:objID>
S:           <fee:class>standard</fee:class>
S:           <fee:command name="create" standard="1">
S:             <fee:period unit="y">2</fee:period>
S:             <fee:fee
S:               description="Registration Fee"
S:               refundable="1"
S:               grace-period="P5D">5.00</fee:fee>
S:           </fee:command>
S:           <fee:command name="renew" standard="1">
S:             <fee:period unit="y">1</fee:period>
S:             <fee:fee
S:               description="Renewal Fee"
S:               refundable="1"
S:               grace-period="P5D">5.00</fee:fee>
S:           </fee:command>
S:           <fee:command name="transfer" standard="1">
S:             <fee:period unit="y">1</fee:period>
S:             <fee:fee
S:               description="Transfer Fee"
S:               refundable="1"
S:               grace-period="P5D">5.00</fee:fee>
S:           </fee:command>
S:           <fee:command name="restore" standard="1">
S:             <fee:fee
S:               description="Redemption Fee">5.00</fee:fee>
S:           </fee:command>
S:         </fee:cd>
S:         <fee:cd avail="0">
S:           <fee:objID>example.xyz</fee:objID>
S:           <fee:command name="create">
S:             <fee:period unit="y">2</fee:period>
S:             <fee:reason>Only 1 year registration periods are
S:               valid.</fee:reason>
S:           </fee:command>
S:         </fee:cd>
S:       </fee:chkData>
S:     </extension>
S:     <trID>
S:       <clTRID>ABC-12345</clTRID>
S:       <svTRID>54322-XYZ</svTRID>
S:     </trID>
S:   </response>
S: </epp>

5.1.2. EPP Transfer Query Command ๐Ÿฆ‹

okay so this one is lowkey the transfer lookup era ๐Ÿ‘‘ This extension doesn't add anything new to the EPP <transfer> query command itself, bestie ๐Ÿ’… BUT the fee info shows up in the response, as long as the client included the extension in the <login> command service <svcExtension> element ๐Ÿซถ

When the <transfer> query command gets processed successfully, the client included the extension in <login>, and the server has authorized that client to see info about the transfer, the server MAY include a <fee:trnData> element in the <extension> section of the EPP response ๐ŸŒธ That element has these child elements:

  • A <fee:currency> element (see Section 3.2) ๐Ÿ’–
  • A <fee:period> element (see Section 3.3) โœจ
  • Zero or more <fee:fee> elements (see Section 3.4) holding the fees that will be charged to the gaining client ๐Ÿ’ธ
  • Zero or more <fee:credit> elements (see Section 3.4) holding the credits that will be refunded to the losing client ๐Ÿงš

Servers SHOULD omit <fee:credit> when they respond to the gaining client, and SHOULD omit <fee:fee> elements when they respond to the losing client. Not me being picky, but the server SHOULD do this, periodt ๐Ÿ’…

If there's no <fee:trnData> element in the response, then the server won't assess any fee for the transfer. No fee, no drama ๐ŸŒˆ

Here's an 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>2019-06-08T22:00:00.0Z</domain:reDate>
S:         <domain:acID>ClientY</domain:acID>
S:         <domain:acDate>2019-06-13T22:00:00.0Z</domain:acDate>
S:         <domain:exDate>2021-09-08T22:00:00.0Z</domain:exDate>
S:       </domain:trnData>
S:     </resData>
S:     <extension>
S:       <fee:trnData xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0">
S:         <fee:currency>USD</fee:currency>
S:         <fee:period unit="y">1</fee:period>
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>

5.2. EPP Transform Commands โœจ

5.2.1. EPP <create> Command ๐ŸŽ€

This extension adds elements to both the EPP <create> command and its response when the client includes the extension in the <login> command service extensions ๐Ÿซถ

When the client submits a <create> command to the server, it MAY include a <fee:create> element in the <extension> element. That element has these child elements:

  • An OPTIONAL <fee:currency> element (see Section 3.2) ๐Ÿ’–
  • One or more <fee:fee> elements (see Section 3.4) ๐Ÿ’ธ

When the <create> command gets processed successfully, the client included the extension in <login>, and the server assessed a fee for the transaction, the server MUST include a <fee:creData> element in the <extension> section of the EPP response. That element has these child elements:

  • A <fee:currency> element (see Section 3.2) ๐Ÿ’–
  • Zero or more <fee:fee> elements (see Section 3.4) ๐Ÿ’ธ
  • Zero or more <fee:credit> elements (see Section 3.4) ๐Ÿงš
  • An OPTIONAL <fee:balance> element (see Section 3.5) ๐ŸŒธ
  • An OPTIONAL <fee:creditLimit> element (see Section 3.6) ๐Ÿ‘‘

Example <create> 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:     <create>
C:       <domain:create
C:         xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:         <domain:name>example.com</domain:name>
C:         <domain:period unit="y">2</domain:period>
C:         <domain:ns>
C:           <domain:hostObj>ns1.example.net</domain:hostObj>
C:           <domain:hostObj>ns2.example.net</domain:hostObj>
C:         </domain:ns>
C:         <domain:registrant>jd1234</domain:registrant>
C:         <domain:contact type="admin">sh8013</domain:contact>
C:         <domain:contact type="tech">sh8013</domain:contact>
C:         <domain:authInfo>
C:           <domain:pw>2fooBAR</domain:pw>
C:         </domain:authInfo>
C:       </domain:create>
C:     </create>
C:     <extension>
C:       <fee:create xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0">
C:         <fee:currency>USD</fee:currency>
C:         <fee:fee>5.00</fee:fee>
C:       </fee:create>
C:     </extension>
C:     <clTRID>ABC-12345</clTRID>
C:   </command>
C: </epp>

Example <create> 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:creData
S:         xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S:         <domain:name>example.com</domain:name>
S:         <domain:crDate>2019-04-03T22:00:00.0Z</domain:crDate>
S:         <domain:exDate>2021-04-03T22:00:00.0Z</domain:exDate>
S:       </domain:creData>
S:     </resData>
S:     <extension>
S:       <fee:creData xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0">
S:         <fee:currency>USD</fee:currency>
S:         <fee:fee
S:           description="Registration Fee"
S:           lang="en"
S:           refundable="1"
S:           grace-period="P5D">5.00</fee:fee>
S:         <fee:balance>-5.00</fee:balance>
S:         <fee:creditLimit>1000.00</fee:creditLimit>
S:       </fee:creData>
S:     </extension>
S:     <trID>
S:       <clTRID>ABC-12345</clTRID>
S:       <svTRID>54321-XYZ</svTRID>
S:     </trID>
S:   </response>
S: </epp>

5.2.2. EPP <delete> Command ๐Ÿ“

This extension doesn't add any elements to the EPP <delete> command, but it does include elements in the response when the client includes the extension in the <login> command service extensions ๐Ÿ™ˆ

When the <delete> command gets processed successfully and the client included the extension in <login>, the server MAY include a <fee:delData> element in the <extension> section of the EPP response. That element has these child elements:

  • A <fee:currency> element (see Section 3.2) ๐Ÿ’–
  • Zero or more <fee:fee> elements (see Section 3.4) ๐Ÿ’ธ
  • Zero or more <fee:credit> elements (see Section 3.4) ๐Ÿงš
  • An OPTIONAL <fee:balance> element (see Section 3.5) ๐ŸŒธ
  • An OPTIONAL <fee:creditLimit> element (see Section 3.6) ๐Ÿ‘‘

Example <delete> 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:     <extension>
S:       <fee:delData
S:         xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0">
S:         <fee:currency>USD</fee:currency>
S:         <fee:credit
S:           description="AGP Credit"
S:           lang="en">-5.00</fee:credit>
S:         <fee:balance>1005.00</fee:balance>
S:       </fee:delData>
S:     </extension>
S:     <trID>
S:       <clTRID>ABC-12345</clTRID>
S:       <svTRID>54321-XYZ</svTRID>
S:     </trID>
S:   </response>
S: </epp>

5.2.3. EPP <renew> Command ๐ŸŒˆ

This extension adds elements to both the EPP <renew> command and its response when the client includes the extension in the <login> command service extensions ๐Ÿ’œ

When the client submits a <renew> command to the server, it MAY include a <fee:renew> element in the <extension> element. That element has these child elements:

  • An OPTIONAL <fee:currency> element (see Section 3.2) ๐Ÿ’–
  • One or more <fee:fee> elements (see Section 3.4) ๐Ÿ’ธ

When the <renew> command gets processed successfully and the client included the extension in <login>, the server MAY include a <fee:renData> element in the <extension> section of the EPP response. That element has these child elements:

  • A <fee:currency> element (see Section 3.2) ๐Ÿ’–
  • Zero or more <fee:fee> elements (see Section 3.4) ๐Ÿ’ธ
  • Zero or more <fee:credit> elements (see Section 3.4) ๐Ÿงš
  • An OPTIONAL <fee:balance> element (see Section 3.5) ๐ŸŒธ
  • An OPTIONAL <fee:creditLimit> element (see Section 3.6) ๐Ÿ‘‘

Example <renew> 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:     <renew>
C:       <domain:renew
C:         xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:         <domain:name>example.com</domain:name>
C:         <domain:curExpDate>2019-04-03</domain:curExpDate>
C:         <domain:period unit="y">5</domain:period>
C:       </domain:renew>
C:     </renew>
C:     <extension>
C:       <fee:renew xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0">
C:         <fee:currency>USD</fee:currency>
C:         <fee:fee>5.00</fee:fee>
C:       </fee:renew>
C:     </extension>
C:     <clTRID>ABC-12345</clTRID>
C:   </command>
C: </epp>

Example <renew> 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:renData
S:         xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
S:         <domain:name>example.com</domain:name>
S:         <domain:exDate>2024-04-03T22:00:00.0Z</domain:exDate>
S:       </domain:renData>
S:     </resData>
S:     <extension>
S:       <fee:renData xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0">
S:         <fee:currency>USD</fee:currency>
S:         <fee:fee
S:           refundable="1"
S:           grace-period="P5D">5.00</fee:fee>
S:         <fee:balance>1000.00</fee:balance>
S:       </fee:renData>
S:     </extension>
S:     <trID>
S:       <clTRID>ABC-12345</clTRID>
S:       <svTRID>54322-XYZ</svTRID>
S:     </trID>
S:   </response>
S: </epp>

5.2.4. EPP <transfer> Command โœจ

okay bestie, transfers time ๐Ÿฆ‹ this extension sneaks extra stuff into both the <transfer> command and its response, but only when the op attribute on the <transfer> command element is "request" AND the extension was listed in the <login> service extensions. no cap, both conditions matter ๐Ÿ’…

When the client sends a <transfer> command, it MAY pop a <fee:transfer> element into the <extension> element, and that element can hold:

  • 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 goes through successfully and the client included the extension in the <login> service extensions, the server MAY include a <fee:trnData> element in the <extension> section of the EPP response. Its child elements are:

  • 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, which is giving main character energy ๐ŸŽ€:

C: <?xml version="1.0" encoding="utf-8" standalone="no"?>
C: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:   <command>
C:     <transfer op="request">
C:       <domain:transfer
C:         xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:         <domain:name>example.com</domain:name>
C:         <domain:period unit="y">1</domain:period>
C:         <domain:authInfo>
C:           <domain:pw roid="JD1234-REP">2fooBAR</domain:pw>
C:         </domain:authInfo>
C:       </domain:transfer>
C:     </transfer>
C:     <extension>
C:      <fee:transfer xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0">
C:        <fee:currency>USD</fee:currency>
C:        <fee:fee>5.00</fee:fee>
C:      </fee:transfer>
C:     </extension>
C:     <clTRID>ABC-12345</clTRID>
C:   </command>
C: </epp>

Example <transfer> 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>2019-06-08T22:00:00.0Z</domain:reDate>
S:         <domain:acID>ClientY</domain:acID>
S:         <domain:acDate>2019-06-13T22:00:00.0Z</domain:acDate>
S:         <domain:exDate>2021-09-08T22:00:00.0Z</domain:exDate>
S:       </domain:trnData>
S:     </resData>
S:     <extension>
S:       <fee:trnData xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0">
S:         <fee:currency>USD</fee:currency>
S:         <fee:fee
S:           refundable="1"
S:           grace-period="P5D">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>

5.2.5. EPP <update> Command ๐ŸŒˆ

this one is simpler, promise ๐Ÿซถ the extension adds stuff to both the <update> command and its response, as long as the extension is listed in the <login> service extensions.

When the client sends an <update> command, it MAY include a <fee:update> element in the <extension> element, and that element can hold:

  • 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 goes through successfully and the client included the extension in the <login> service extensions, the server MAY include a <fee:updData> element in the <extension> section of the EPP response. Its child elements are:

  • 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: <?xml version="1.0" encoding="utf-8" standalone="no"?>
C: <epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C:   <command>
C:     <update>
C:       <domain:update
C:         xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">
C:         <domain:name>example.com</domain:name>
C:         <domain:chg>
C:           <domain:registrant>sh8013</domain:registrant>
C:         </domain:chg>
C:       </domain:update>
C:     </update>
C:     <extension>
C:       <fee:update xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0">
C:         <fee:currency>USD</fee:currency>
C:         <fee:fee>5.00</fee:fee>
C:       </fee:update>
C:     </extension>
C:     <clTRID>ABC-12345</clTRID>
C:   </command>
C: </epp>

Example <update> 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:     <extension>
S:       <fee:updData xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0">
S:         <fee:currency>USD</fee:currency>
S:         <fee:fee>5.00</fee:fee>
S:       </fee:updData>
S:     </extension>
S:     <trID>
S:       <clTRID>ABC-12345</clTRID>
S:       <svTRID>54321-XYZ</svTRID>
S:     </trID>
S:   </response>
S: </epp>

6. Formal Syntax ๐Ÿงš

okay the schema era begins โœจ only one schema lives in this section, and it's the EPP Fee Extension schema ๐Ÿ‘‘

The formal syntax here is a complete schema representation of the object mapping, so you can use it for automated validation of EPP XML instances. it's giving strict but make it fashion ๐Ÿ’…

6.1. Fee Extension Schema ๐Ÿ’–

okay so this is the formal syntax, and it's a complete schema representation [W3C.REC-xmlschema-1-20041028] of the object mapping. that means you can use it to automatically validate EPP XML instances, which is so useful ๐Ÿซถ the <CODE BEGINS> and <CODE ENDS> tags aren't actually part of the schema. they just mark where it starts and stops for URI registration purposes ๐Ÿงš

<?xml version="1.0" encoding="utf-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema"
  xmlns:fee="urn:ietf:params:xml:ns:epp:fee-1.0"
  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:epp:fee-1.0"
  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 Fee Extension
    </documentation>
  </annotation>

  <!-- Child elements found in EPP commands and responses -->
  <element name="check" type="fee:checkType" />
  <element name="chkData" type="fee:chkDataType" />
  <element name="create" type="fee:transformCommandType" />
  <element name="creData" type="fee:transformResultType" />
  <element name="renew" type="fee:transformCommandType" />
  <element name="renData" type="fee:transformResultType" />
  <element name="transfer" type="fee:transformCommandType" />
  <element name="trnData" type="fee:transformResultType" />
  <element name="update" type="fee:transformCommandType" />
  <element name="updData" type="fee:transformResultType" />
  <element name="delData" type="fee:transformResultType" />

  <!-- client <check> command -->
  <complexType name="checkType">
    <sequence>
      <element name="currency" type="fee:currencyType"
        minOccurs="0" />
      <element name="command" type="fee:commandType"
        minOccurs="1" maxOccurs="unbounded" />
    </sequence>
  </complexType>

  <complexType name="objectIdentifierType">
    <simpleContent>
      <extension base="eppcom:labelType">
        <attribute name="element"
        type="NMTOKEN" default="name" />
      </extension>
    </simpleContent>
  </complexType>

  <!-- server <check> result -->
  <complexType name="chkDataType">
    <sequence>
      <element name="currency" type="fee:currencyType" />
      <element name="cd" type="fee:objectCDType"
        maxOccurs="unbounded" />
    </sequence>
  </complexType>

  <complexType name="objectCDType">
    <sequence>
      <element name="objID" type="fee:objectIdentifierType" />
      <element name="class" type="token" minOccurs="0" />
      <element name="command" type="fee:commandDataType"
        minOccurs="0" maxOccurs="unbounded" />
      <element name="reason" type="fee:reasonType" minOccurs="0" />
    </sequence>
    <attribute name="avail" type="boolean" default="1" />
  </complexType>

  <!-- general transform (create, renew, update, transfer) command-->
  <complexType name="transformCommandType">
    <sequence>
      <element name="currency" type="fee:currencyType"
        minOccurs="0" />
      <element name="fee" type="fee:feeType"
        maxOccurs="unbounded" />
      <element name="credit" type="fee:creditType"
        minOccurs="0" maxOccurs="unbounded" />
    </sequence>
  </complexType>

  <!-- general transform (create, renew, update) result -->
  <complexType name="transformResultType">
    <sequence>
      <element name="currency" type="fee:currencyType"
        minOccurs="0" />
      <element name="period" type="domain:periodType"
        minOccurs="0" />
      <element name="fee" type="fee:feeType"
        minOccurs="0" maxOccurs="unbounded" />
      <element name="credit" type="fee:creditType"
        minOccurs="0" maxOccurs="unbounded" />
      <element name="balance" type="fee:balanceType"
        minOccurs="0" />
      <element name="creditLimit" type="fee:creditLimitType"
        minOccurs="0" />
    </sequence>
  </complexType>

  <!-- common types -->
  <simpleType name="currencyType">
    <restriction base="string">
      <pattern value="[A-Z]{3}" />
    </restriction>
  </simpleType>

  <complexType name="commandType">
    <sequence>
      <element name="period" type="domain:periodType"
        minOccurs="0" maxOccurs="1" />
    </sequence>
    <attribute name="name" type="fee:commandEnum" use="required"/>
    <attribute name="customName" type="token"/>
    <attribute name="phase" type="token" />
    <attribute name="subphase" type="token" />
  </complexType>

  <complexType name="commandDataType">
    <complexContent>
      <extension base="fee:commandType">
        <sequence>
          <element name="fee" type="fee:feeType"
            minOccurs="0" maxOccurs="unbounded" />
          <element name="credit" type="fee:creditType"
            minOccurs="0" maxOccurs="unbounded" />
          <element name="reason" type="fee:reasonType"
            minOccurs="0" />
        </sequence>
        <attribute name="standard" type="boolean" default="0" />
      </extension>
    </complexContent>
  </complexType>

  <complexType name="reasonType">
    <simpleContent>
      <extension base="token">
        <attribute name="lang" type="language" default="en"/>
      </extension>
    </simpleContent>
  </complexType>

  <simpleType name="commandEnum">
    <restriction base="token">
      <enumeration value="create"/>
      <enumeration value="delete"/>
      <enumeration value="renew"/>
      <enumeration value="update"/>
      <enumeration value="transfer"/>
      <enumeration value="restore"/>
      <enumeration value="custom"/>
    </restriction>
  </simpleType>

  <simpleType name="nonNegativeDecimal">
    <restriction base="decimal">
      <minInclusive value="0" />
    </restriction>
  </simpleType>

  <simpleType name="negativeDecimal">
    <restriction base="decimal">
      <maxInclusive value="0" />
    </restriction>
  </simpleType>

  <complexType name="feeType">
    <simpleContent>
      <extension base="fee:nonNegativeDecimal">
        <attribute name="description"/>
        <attribute name="lang" type="language" default="en"/>
        <attribute name="refundable" type="boolean" />
        <attribute name="grace-period" type="duration" />
        <attribute name="applied">
          <simpleType>
            <restriction base="token">
              <enumeration value="immediate" />
              <enumeration value="delayed" />
            </restriction>
          </simpleType>
        </attribute>
      </extension>
    </simpleContent>
  </complexType>

  <complexType name="creditType">
    <simpleContent>
      <extension base="fee:negativeDecimal">
        <attribute name="description"/>
        <attribute name="lang" type="language" default="en"/>
      </extension>
    </simpleContent>
  </complexType>

  <simpleType name="balanceType">
    <restriction base="decimal" />
  </simpleType>

  <simpleType name="creditLimitType">
    <restriction base="decimal" />
  </simpleType>

</schema>

7. Security Considerations ๐Ÿ”’

okay security time, and this part is SO important bestie ๐Ÿ˜ญ the mapping extensions in this document don't give you any security services beyond what [RFC5730], [RFC5731], and the protocol layers EPP uses already provide. the security considerations in those other specs apply to this one too ๐Ÿซถ

this extension passes financial information over EPP, so confidentiality and integrity protection must be provided by the transport mechanism. every transport that's compliant with [RFC5730] gives you the level of confidentiality and integrity protection that's needed ๐Ÿ’…

the server will only provide info, including financial info, that's relevant to the authenticated client. no peeking at someone else's stuff, periodt ๐Ÿ‘‘


8. IANA Considerations ๐ŸŒˆ

8.1. XML Namespace ๐ŸŽ€

this document uses URNs to describe XML namespaces and XML schemas, following a registry mechanism described in [RFC3688] ๐Ÿงš

okay so here's the registration request for the fee namespace:

  • URI: urn:ietf:params:xml:ns:epp:fee-1.0
  • Registrant Contact: IESG
  • XML: None. Namespace URIs don't represent an XML specification, so there's nothing to put here ๐Ÿ™ˆ

and the registration request for the fee schema:

  • URI: urn:ietf:params:xml:schema:epp:fee-1.0
  • Registrant Contact: IESG
  • XML: See Section 6 of this document. (aka the schema we just went through, iykyk โœจ)

8.2. EPP Extension Registry ๐Ÿ’œ

the EPP extension in this document has been registered by IANA in the "Extensions for the Extensible Provisioning Protocol (EPP)" registry described in [RFC7451]. here are the registration details, obsessed with how organized this is ๐Ÿ“

  • Name of Extension: Registry Fee Extension for the Extensible Provisioning Protocol (EPP)
  • Document status: Standards Track
  • Reference: RFC 8748
  • Registrant Name and Email Address: IESG <iesg@ietf.org>
  • TLDs: Any
  • IPR Disclosure: None
  • Status: Active
  • Notes: None

9. References ๐Ÿ“š

9.1. Normative References ๐Ÿฆ‹

ngl this list is long but every single one is needed, so here we go ๐Ÿ’–

9.2. Informative References

[RFC7451] Hollenbeck, S., "Extension Registry for the Extensible Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, February 2015, https://www.rfc-editor.org/info/rfc7451.

Acknowledgements โœจ

okay bestie, big thank-you energy ๐Ÿซถ the authors wanted to shout out everyone who gave feedback and suggestions. this list is literally the dream team ๐Ÿ‘‘

  • James Gould of Verisign Inc. ๐Ÿ’œ
  • Luis Munoz of ISC ๐ŸŒธ
  • Michael Young ๐Ÿฆ‹
  • Ben Levac ๐Ÿ“
  • Jeff Eckhaus ๐Ÿงš
  • Seth Goldman of Google ๐ŸŒˆ
  • Klaus Malorny and Michael Bauland of Knipp ๐Ÿ’…
  • Jody Kolker, Joe Snitker, and Kevin Allendorf of GoDaddy ๐Ÿ”ฅ
  • Michael Holloway of Com Laude โญ
  • Santosh Kalsangrah of Impetus Infotech ๐ŸŽ€
  • Alex Mayrhofer of Nic.at ๐Ÿฆ‹
  • Thomas Corte of Knipp Medien und Kommunikation GmbH ๐Ÿ˜ญ

Authors' Addresses ๐ŸŽ€

here are the people who wrote this thing, with their contact details. slide into their inboxes responsibly, periodt ๐Ÿ’Œ

Roger Carney ๐Ÿ’–

Roger Carney
GoDaddy Inc.
14455 N. Hayden Rd. #219
Scottsdale, AZ 85260
United States of America

Email: rcarney@godaddy.com
URI:   http://www.godaddy.com

Gavin Brown ๐ŸŒธ

Gavin Brown
CentralNic Group plc
35-39 Moorgate
London
EC2R 6AR
United Kingdom

Phone: +44 20 33 88 0600
Email: gavin.brown@centralnic.com
URI:   http://www.centralnic.com

Jothan Frakes ๐Ÿงš

Jothan Frakes

Email: jothan@jothan.com
URI:   http://jothan.com

and that's a wrap, bestie! ๐ŸŒˆโœจ you made it through the whole spec, you absolute legend ๐Ÿ‘‘๐Ÿ’…

๐Ÿ“ฆ where this page comes from