This repository has been archived by the owner on Mar 28, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
/
draft-ietf-regext-epp-fees.xml.in
1069 lines (867 loc) · 49.6 KB
/
draft-ietf-regext-epp-fees.xml.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="us-ascii"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!-- when the namespace version bumps, update this and it will update
everywhere -->
<!ENTITY VERSION "0.12">
<!ENTITY I-D.narten-iana-considerations-rfc2434bis SYSTEM
"http://xml2rfc.ietf.org/public/rfc/bibxml3/reference.I-D.narten-iana-considerations-rfc2434bis.xml">
<!ENTITY RFC2119 SYSTEM
"http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml">
<!ENTITY RFC3688 SYSTEM
"http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.3688.xml">
<!ENTITY RFC3915 SYSTEM
"http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.3915.xml">
<!ENTITY RFC5730 SYSTEM
"http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.5730.xml">
<!ENTITY RFC5731 SYSTEM
"http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.5731.xml">
<!ENTITY RFC6982 SYSTEM
"http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.6982.xml">
<!ENTITY RFC7451 SYSTEM
"http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.7451.xml">
]>
<?xml-stylesheet type="text/xsl" href="rfc2629.xslt" ?>
<?rfc strict="yes" ?>
<?rfc toc="yes"?>
<?rfc tocdepth="4"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes" ?>
<?rfc compact="yes" ?>
<?rfc subcompact="no" ?>
<?rfc comments="yes" ?>
<?rfc inline="yes" ?>
<rfc category="std" docName="draft-ietf-regext-epp-fees-00" ipr="trust200902">
<front>
<title abbrev="Registry Fee Extension for EPP">Registry Fee Extension for
the Extensible Provisioning Protocol (EPP)</title>
<author fullname="Gavin Brown" initials="G" surname="Brown">
<organization>CentralNic Group plc</organization>
<address>
<postal>
<street>35-39 Moorgate</street>
<city>London</city>
<region>England</region>
<code>EC2R 6AR</code>
<country>GB</country>
</postal>
<phone>+44 20 33 88 0600</phone>
<email>gavin.brown@centralnic.com</email>
<uri>https://www.centralnic.com</uri>
</address>
</author>
<author fullname="Jothan Frakes" initials="J" surname="Frakes">
<address>
<email>jothan@jothan.com</email>
<uri>http://jothan.com</uri>
</address>
</author>
<date month="May" year="2016" />
<area>Applications</area>
<workgroup>Internet Engineering Task Force</workgroup>
<keyword>EPP, XML</keyword>
<abstract><t>This document describes an Extensible Provisioning Protocol
(EPP) extension mapping for registry fees.</t></abstract>
</front>
<middle>
<section title="Introduction">
<t>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 <xref
target="RFC3915">RGP</xref> 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.</t>
<t>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.</t>
<t>This document describes an extension mapping for version 1.0 of the
<xref target="RFC5730">Extensible Provisioning Protocol (EPP)</xref>. This
EPP mapping provides a mechanism by which EPP clients may query the fees
and credits associated with various billable transactions, and also
obtain their current account balance.</t>
<section title="Conventions Used in This Document">
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in
<xref target="RFC2119">RFC 2119</xref>.</t>
<t>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.</t>
<t>"fee" is used as an abbreviation for
"urn:ietf:params:xml:ns:fee-&VERSION;". 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.</t>
<t>(Note to RFC Editor: remove the following paragraph before publication
as an RFC.)</t>
<t>The XML namespace prefix above contains a version number,
specifically "&VERSION;". This version number will increment with
successive versions of this document, and will reach 1.0 if and when
this document is published as an RFC. This permits clients to
distinguish which version of the extension a server has implemented.</t>
</section>
</section>
<section title="Migrating to Newer Versions of This Extension">
<t>(Note to RFC Editor: remove this section before publication as an
RFC.)</t>
<t>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.</t>
<t>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.</t>
<t>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.</t>
<t>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.</t>
</section>
<section title="Extension Elements">
<section title="Client Commands">
<t>The <fee:command> element is used in the EPP <check> command to
determine the fee which is applicable to the given command.</t>
<t>The element values permitted by the server is a matter of repository
policy, but MUST include as a minimum the following values:
<list style="symbols">
<t>"create" indicating a <create> command;</t>
<t>"renew" indicating a <renew> command;</t>
<t>"transfer" indicating a <transfer> command;</t>
</list>
If the server supports the <xref target="RFC3915">Registry Grace Period
Mapping</xref>, then the server MUST also support the "restore" value.</t>
<t>The <fee:command> element MAY have an OPTIONAL "phase" attribute
specifying a launch phase as described in
<xref target="draft-ietf-eppext-launchphase" />. It may also contain an
OPTIONAL "subphase" attribute identifying the custom or sub-phase as
described in <xref target="draft-ietf-eppext-launchphase" />.</t>
</section>
<section title="Currency Codes" anchor="currency-codes">
<t>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 <xref target="ISO4217"/>.</t>
<t>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.</t>
<t>The use of <fee:currency> elements in commands is OPTIONAL:
if a <fee:currency> element is not present in a command, the
server MUST determine the currency based on the client's account settings
which MUST be agreed by the client and server via an out-of-band
channel. However, the <fee:currency> element MUST be present in
responses.</t>
<t>Servers SHOULD NOT perform a currency conversion if a client uses an
incorrect currency code. Servers SHOULD return a 2004 error instead.</t>
</section>
<section title="Validity Periods" anchor="validity-periods">
<t>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 <xref
target="RFC5731"/>.</t>
<t>The <fee:period> element is OPTIONAL in <check> commands:
if omitted, the server MUST determine the fee(s) using a validity period
of 1 year. The <fee:period> element MUST be present in <check>
responses.</t>
</section>
<section title="Fees and Credits" anchor="fees-and-credits">
<t>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.</t>
<t>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.</t>
<t>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.</t>
<t>The following attributes are defined for the <fee:fee> element.
These are described in detail below:</t>
<t><list style="hanging">
<t hangText="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.</t>
<t hangText="refundable:">an OPTIONAL boolean attribute indicating
whether the fee is refundable if the object is deleted.</t>
<t hangText="grace-period:">an OPTIONAL attribute which provides the
time period during which the fee is refundable.</t>
<t hangText="applied:">an OPTIONAL attribute indicating when the
fee will be deducted from the client's account.</t>
</list></t>
<t>The <fee:credit> element can take a "description" attribute
as described above. No other attributes are defined for this
element.</t>
<section title="Refunds">
<t><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 <xref target="draft-ietf-eppext-launchphase" />) or when
an object is deleted during the relevant Grace Period (see below).</t>
<t>If the "refundable" attribute is omitted, then clients SHOULD NOT make
any assumption about the refundability of the fee.</t>
</section>
<section title="Grace Periods">
<t><xref target="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.</t>
<t>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, it MUST specify the grace period for all relevant
transactions.</t>
<t>If the "grace-period" attribute is omitted, then clients
SHOULD NOT make any assumption about the grace period of the fee.</t>
</section>
<section title="Correlation between Refundability and Grace Periods">
<t>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.</t>
</section>
<section title="Applicability">
<t>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.</t>
<t>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" (which is the
default) or "delayed".</t>
</section>
</section>
<section title="Account Balance" anchor="account-balance">
<t>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.</t>
<t>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" commands (ie <create>, <renew>,
<update>, <delete>, <transfer op="request">).</t>
<t>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).</t>
<t>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.</t>
</section>
<section title="Credit Limit" anchor="credit-limit">
<t>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.</t>
<t>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 (ie <create>, <renew>,
<update>, <delete>, <transfer op="request">).</t>
</section>
<section title="Classification of Objects" anchor="classification">
<t>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 appears in <check> responses is
used to indicate the classification of an object.</t>
<t>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.</t>
<t>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.</t>
</section>
</section>
<section title="Server Handling of Fee Information">
<t>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.</t>
<t>If a server receives a command from a client which does not include
the extension elements required by the server for that command, then
it MUST respond with a 2003 "Required parameter missing" error.</t>
<t>If the currency or total fee provided by the client do not agree
with 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.</t>
</section>
<section title="Retrieving Future Fee Information">
<t>Sometimes, the time interval between when a client queries the
fee for a command, and when that command takes place, is long enough that
there is a non-negligible probability that the fee might change in
the intervening time.</t>
<t>To ensure that clients can obtain the most accurate fee information
in such circumstances, clients can include a <fee:cmdDate> element
in fee <check> commands, to indicate the anticipated date and time
of a billable transaction.</t>
<t>If a server receives a command containing a <fee:cmdDate> element,
and the server is unable to provide accurate fee information for the given
date and time, then it MUST respond with a 2306 "Parameter value policy
error" error. Otherwise, the server MUST return fee information that will
prevail at the date and time provided.</t>
<t>This extension provides no mechanism to enforce the application of these
fees when the command is subsequently submitted; servers MUST reject commands
which include incorrect fee information, as described above.</t>
<t>If a server knows that the fee information it is returning to a client
is going to change in the future, it MAY include <fee:notAfter>
elements in <check> responses. This element contains a date and time
after which the provided fee information will no longer apply. Clients which
receive a response from a server which contain <fee:notAfter> elements
may then re-query for the fee information (using the <fee:cmdDate>
element) described above if the value of the <fee:notAfter> element
is before the anticipated time when the command will be submitted.</t>
</section>
<section title="EPP Command Mapping">
<t>A detailed description of the EPP syntax and semantics can be found in
<xref target="RFC5730" />.</t>
<section title="EPP Query Commands">
<t>This extension does not add any elements to the EPP <poll> or
<info> commands or responses.</t>
<section title="EPP <check> Command">
<t>This extension defines additional elements for the EPP
<check> command.</t>
<t>The command MAY contain an <extension> element which
MAY contain a <fee:check> element. The <fee:check> element
contains the following child elements:</t>
<t><list style="symbols">
<t>A <fee:command> element;</t>
<t>An OPTIONAL <fee:currency> element;</t>
<t>An OPTIONAL <fee:period> element.</t>
<t>An OPTIONAL <fee:class> element.</t>
<t>An OPTIONAL <fee:cmdDate> element.</t>
</list></t>
<t>Example <check> command:</t>
<figure><artwork>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
href="examples/check-command.txt" /></artwork></figure>
<t>When the server receives a <check> command that includes the
extension elements described above, its response MUST (subject to the
exception described below) contain an <extension> element,
which MUST contain a child <fee:chkData> element. The
<fee:chkData> element MUST contain a <fee:cd> element for
each object referenced in the <check> element in the command.</t>
<t>The <fee:cd> element 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 or class is invalid according to
server policy.</t>
<t>The <fee:cd> contains the following child elements:</t>
<t><list style="symbols">
<t>A <fee:object> element, which contains a copy of the child
element of the <check> element of the command, to which the fee
information relates.</t>
<t>A <fee:command> element, which contains the same command
that appeared in the corresponding <fee:command> element in the
command. This element MAY have the OPTIONAL "phase" and "subphase" elements,
which MUST match the same attributes in the corresponding
<fee:command> element in the command.</t>
<t>A <fee:currency> element, which contains the same currency code
that appeared in the <fee:currency> element of the command.
If no <fee:currency> element appeared in the command, then
the client's default billing currency should be used.</t>
<t>An OPTIONAL <fee:period> element, which contains the same unit
that appeared in the <fee:currency> 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 command (and the command is not
"restore") then this element MUST have a value of 1 year.</t>
<t>Zero or more <fee:fee> elements.</t>
<t>Zero or more <fee:credit> elements.</t>
<t>An OPTIONAL <fee:class> element.</t>
<t>An OPTIONAL <fee:reason> element.</t>
<t>An OPTIONAL <fee:cmdDate> element, which contains the same
date and time that appeared in the <fee:check> element of
the command.</t>
</list></t>
<t>If no <fee:fee> elements are present in a <fee:cd>
element, this indicates that no fee will be assessed by the
server for this command.</t>
<t>If the "avail" attribute of the <fee:cd> element is false, then
the <fee:cd> element MUST NOT contain any <fee:fee> or
<fee:credit> child elements. If the "avail" attribute is true,
then the <fee:cd> element MUST NOT contain a <fee:reason>
element.</t>
<t>Example <check> response:</t>
<figure><artwork>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
href="examples/check-response.txt" /></artwork></figure>
<section title="Server Handling of <fee:class> Elements">
<t>When a server supports classes as described in Section 3.7<!-- hard coded cross-reference! -->,
and the <fee:class> element is present in the command, the server MUST
validate the value of this element, and return an error for unknown values.
If the given value is incorrect for the specified object, the
"avail" attribute of the corresponding <fee:cd> element MUST be
false.</t>
<t>The <fee:cd> section MUST contain the appropriate
<fee:class> element when the servers support classes, as described
in Section 3.7,<!-- hard coded cross-reference! --> and the "avail"
attribute of the <fee:cd> element is true.</t>
</section>
</section>
<section title="EPP Transfer Query Command">
<t>This extension does not add any elements to the EPP
<transfer> query command, but does include elements in the
response, when the extension has been selected during a <login>
command.</t>
<t>When the <transfer> query command has been processed
successfully, the client selected the extension when it logged in, and
the client is authorised by the server to view information about the
transfer, the server MAY include in the <extension> section of
the EPP response a <fee:trnData> element, which contains the
following child elements:</t>
<t><list style="symbols">
<t>A <fee:currency> element.</t>
<t>A <fee:period> element.</t>
<t>Zero or more <fee:fee> elements containing the fees
that will be charged to the gaining client.</t>
<t>Zero or more <fee:credit> elements containing the credits
that will be refunded to the losing client.</t>
</list></t>
<t>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.</t>
<t>If no <fee:trnData> element is included in the
response, then no fee will be assessed by the server for the
transfer.</t>
<t>Example <transfer> query response:</t>
<figure><artwork>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
href="examples/transfer-query-response.txt" /></artwork></figure>
</section>
</section>
<section title="EPP Transform Commands">
<section title="EPP <create> Command">
<t>This extension adds elements to both the EPP <create> command
and response, when the extension has been selected during a
<login> command.</t>
<t>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:</t>
<t><list style="symbols">
<t>An OPTIONAL <fee:currency> element;</t>
<t>One or more <fee:fee> elements.</t>
</list></t>
<t>When the <create> command has been processed successfully,
and the client selected the extension when it logged in, 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:</t>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="xml"
href="transform-response-elements.xml" />
<t>If no fee or credit has been assessed by the server for this transaction,
a <fee:creData> element MUST NOT be included in the response.</t>
<t>Example <create> command:</t>
<figure><artwork>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
href="examples/create-command.txt" /></artwork></figure>
<t>Example <create> response:</t>
<figure><artwork>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
href="examples/create-response.txt" /></artwork></figure>
</section>
<section title="EPP <delete> Command">
<t>This extension does not add any elements to the EPP <delete>
command, but does include elements in the response, when the extension
has been selected during the <login> command.</t>
<t>When the <delete> command has been processed successfully,
and the client selected the extension when it logged in, the server
MAY include in the <extension> section of the EPP response a
<fee:delData> element, which contains the following child
elements:</t>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="xml"
href="transform-response-elements.xml" />
<t>If no credit has been assessed by the server for this transaction,
a <fee:delData> element MUST NOT be included in the response.</t>
<t>Example <delete> response:</t>
<figure><artwork>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
href="examples/delete-response.txt" /></artwork></figure>
</section>
<section title="EPP <renew> Command">
<t>This extension adds elements to both the EPP <renew> command
and response, when the extension has been selected during a
<login> command.</t>
<t>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:</t>
<t><list style="symbols">
<t>An OPTIONAL <fee:currency> element;</t>
<t>One or more <fee:fee> elements.</t>
</list></t>
<t>When the <renew> command has been processed successfully,
and the client selected the extension when it logged in, the server
MAY include in the <extension> section of the EPP response a
<fee:renData> element, which contains the following child
elements:</t>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="xml"
href="transform-response-elements.xml" />
<t>If no fee or credit has been assessed by the server for this transaction,
a <fee:renData> element MUST NOT be included in the response.</t>
<t>Example <renew> command:</t>
<figure><artwork>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
href="examples/renew-command.txt" /></artwork></figure>
<t>Example <renew> response:</t>
<figure><artwork>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
href="examples/renew-response.txt" /></artwork></figure>
</section>
<section title="EPP <transfer> Command">
<t>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 has
been selected during the <login> command.</t>
<t>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:</t>
<t><list style="symbols">
<t>An OPTIONAL <fee:currency> element;</t>
<t>One or more <fee:fee> elements.</t>
</list></t>
<t>When the <transfer> command has been processed successfully,
and the client selected the extension when it logged in, the server
MAY include in the <extension> section of the EPP response a
<fee:trnData> element, which contains the following child
elements:</t>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="xml"
href="transform-response-elements.xml" />
<t>If no fee or credit has been assessed by the server for this transaction,
a <fee:trnData> element MUST NOT be included in the response.</t>
<t>Example <transfer> command:</t>
<figure><artwork>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
href="examples/transfer-command.txt" /></artwork></figure>
<t>Example <transfer> response:</t>
<figure><artwork>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
href="examples/transfer-response.txt" /></artwork></figure>
</section>
<section title="EPP <update> Command">
<t>This extension adds elements to both the EPP <update> command
and response, when the extension has been selected during a
<login> has been selected during the <login> command.</t>
<t>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:</t>
<t><list style="symbols">
<t>An OPTIONAL <fee:currency> element;</t>
<t>One or more <fee:fee> elements.</t>
</list></t>
<t>When the <update> command has been processed successfully,
and the client selected the extension when it logged in, the server
MAY include in the <extension> section of the EPP response a
<fee:upData> element, which contains the following child
elements:</t>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="xml"
href="transform-response-elements.xml" />
<t>If no fee or credit has been assessed by the server for this transaction,
a <fee:upData> element MUST NOT be included in the response.</t>
<t>Example <update> command:</t>
<figure><artwork>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
href="examples/update-command.txt" /></artwork></figure>
<t>Example <update> response:</t>
<figure><artwork>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
href="examples/update-response.txt" /></artwork></figure>
</section>
</section>
<section title="Formal Syntax">
<t>An EPP object mapping is specified in XML Schema notation. The formal
syntax presented here is a complete schema representation of the object
mapping suitable for automated validation of EPP XML instances.</t>
<t>Copyright (c) 2014 IETF Trust and the persons identified as authors
of the code. All rights reserved.</t>
<t>Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:</t>
<t><list style="symbols">
<t>Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.</t>
<t>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.</t>
<t>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.</t>
</list></t>
<t>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.</t>
<figure><artwork>
BEGIN
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="fee.xsd"
parse="text"/>
END</artwork></figure>
</section>
</section>
<section anchor="Security" title="Security Considerations">
<t>The mapping extensions described in this document do not provide any
security services beyond those described by <xref target="RFC5730">EPP</xref>,
the <xref target="RFC5731">EPP domain name mapping</xref>, and protocol
layers used by EPP. The security considerations described in these other
specifications apply to this specification as well.</t></section>
<section anchor="IANA" title="IANA Considerations">
<section title="XML Namespace">
<t>This document uses URNs to describe XML namespaces and XML schemas
conforming to a registry mechanism described in <xref target="RFC3688" />.
The following URI assignment is requested of IANA:</t>
<t>URI: urn:ietf:params:xml:ns:fee-&VERSION;</t>
<t>Registrant Contact: See the "Author's Address" section of this
document.</t>
<t>XML: See the "Formal Syntax" section of this document.</t>
</section>
<section title="EPP Extension Registry">
<t>The EPP extension described in this document should be registered
by the IANA in the EPP Extension Registry described in <xref
target="RFC7451"/>. The details of the registration are as follows:</t>
<t>Name of Extension: EPP Fee Extension</t>
<t>Document status: Standards Track</t>
<t>Reference: (insert reference to RFC version of this document)</t>
<t>Registrant Name and Email Address: See the "Author's Address" section
of this document.</t>
<t>TLDs: any</t>
<t>IPR Disclosure: none</t>
<t>Status: active</t>
<t>Notes: none</t>
</section>
</section>
<section anchor="impl" title="Implementation Status">
<t>Note to RFC Editor: Please remove this section and the reference to
<xref target="RFC6982"/> before publication.</t>
<t>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 <xref target="RFC6982"/>.
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.</t>
<t>According to <xref target="RFC6982"/>, "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".</t>
<section title="RegistryEngine EPP Service">
<t>Organization: CentralNic</t>
<t>Name: RegistryEngine EPP Service</t>
<t>Description: Generic high-volume EPP service for gTLDs, ccTLDs and SLDs</t>
<t>Level of maturity: Deployed in CentralNic's production environment as well
as two other gTLD registry systems, and two ccTLD registry systems.</t>
<t>Coverage: All aspects of the protocol are implemented.</t>
<t>Licensing: Proprietary In-House software</t>
<t>Contact: epp@centralnic.com</t>
<t>URL: https://www.centralnic.com</t>
</section>
</section>
<section title="Acknowledgements">
<t>The authors wish to thank the following persons for their feedback and
suggestions:</t>
<t><list style="symbols">
<t>James Gould and Scott Hollenbeck of Verisign</t>
<t>Luis Muñoz of Uniregistry</t>
<t>Michael Young of Architelos</t>
<t>Ben Levac and Jeff Eckhaus of Demand Media</t>
<t>Seth Goldman and Brian Mountford of Google</t>
<t>Klaus Malorny and Michael Bauland of Knipp</t>
<t>Jody Kolker and Roger Carney of Go Daddy</t>
<t>Michael Holloway of Com Laude</t>
<t>Santosh Kalsangrah of Impetus Infotech</t>
<t>Alex Mayrhofer of Nic.at</t>
<t>Pat Moroney of Name.com</t>
<t>Bernhard Reutner-Fischer</t>
</list></t>
</section>
<section title="Change History">
<section title="Changes from 00 to 01">
<t><list style="numbers">
<t>Restore the <check> command extension; either <check>
or <info> can be used.</t>
<t>added extension elements for <create>, <renew>,
<transfer> and <update> so that the server can reject the
command if the fee is incorrect.</t>
</list></t>
</section>
<section title="Changes from 01 to 02">
<t><list style="numbers">
<t>Use Internet-Draft version number rather than XML namespace version
number in this section.</t>
<t>Support for multiple <fee:fee> and <fee:credit>
elements.</t>
<t>Added the "description" attribute to <fee:fee> and
<fee:credit> elements.</t>
<t>Added the <fee:balance> element.</t>
<t>Added the <fee:creditLimit> element.</t>
<t>Updated reference to
<xref target="draft-ietf-eppext-launchphase"/>.</t>
<t>Use <fee:command> instead of <fee:action>.</t>
<t>Use a single child element of <fee:chkData> instead of multiple
elements for each domain. This also requires using a different name
(<fee:name>) for the domain name.</t>
<t>Added the "refundable" attribute to <fee:fee> elements.</t>
<t>Added the "grace-period" attribute to <fee:fee> elements.</t>
</list></t>
</section>
<section title="Changes from 02 to 03">
<t><list style="numbers">
<t>Added the "applied" attribute to to <fee:fee> elements.</t>
<t>Simplified the wording in relation to when a server can return an
error for extended <info> commands.</t>
<t>Added the <fee:period> element to transfer query responses.</t>
<t>Removed wording about how servers behave when receiving incorrect
fee information from transform commands, and put it into a single
section at the top of the document.</t>
<t>Allow servers to omit <fee:fee> elements from <fee:cd>
elements if the command specified by the client is forbidden.</t>
</list></t>
</section>
<section title="Changes from 03 to 04">
<t><list style="numbers">
<t>Changed Intended Status to Standards Track.</t>
<t>As per suggestion from Michael Bauland, the <fee:period>
element is no longer included in <check> and <info>
responses for "restore" commands. It's still mandatory for all other
commands.</t>
<t>Added summary of the attributes for the <fee:fee> element.</t>
<t>Clarified that the "refundable" and "grace-period" attributes of
the <fee:fee> elements are dependant on each other and cannot
appear on their own.</t>
<t>Removed the option of returning a 1001 response when the fee is
incorrect.</t>
<t>Forbidden the inclusion of extension elements in transform responses
if no fee/credit has been assessed.</t>
<t>Made the <fee:currency> element optional in transform
commands.</t>
<t>Amended XML Namespace section of IANA Considerations, added
EPP Extension Registry section.</t>
</list></t>
</section>
<section title="Changes from 04 to 05">
<t><list style="numbers">
<t>Removed the extended <info> command. The <check> command
is the only command that can be used now.</t>
<t>Introduced a mandatory-to-implement "standard" class for non-premium
domains.</t>
<t>The decision was made to keep availability info in <check> responses
as registrars have indicated that it is very useful as it avoids unnecessary
round trips to the server.</t>
<t>Allow <fee:credit> elements to be present in <check>
responses.</t>
<t>Allow the number of <fee:fee> which can appear in transform responses
to be zero.</t>
<t>Removed the <fee:balance> and <fee:creditLimit> elements from
transfer query responses. The reason is that these elements are defined
as containing the values after the transform command has taken place - which
means that it is not appropriate to include them in a query response.</t>
<t>Added Implementation Status section.</t>
</list></t>
</section>
<section title="Changes from 05 to 06">
<t><list style="numbers">
<t>The specification is now object-agnostic, but works with <xref target="RFC5731">
RFC5731</xref> domains by default.</t>
<t>Renamed the <fee:domain> element to <fee:object>. Added the
"objURI" attribute.</t>
<t>Removed the default value for the "refundable" attribute of <fee:fee>
elements, and added text about how clients should handle such cases. Added similar
text to the documentation of the "grace-period" attribute.</t>
<t>Removed references to the defunct <info> command syntax.</t>
<t>"MUST" requirements regarding documentation have been changed to "must".</t>
<t>Created separate "Correlation between Refundability and Grace Periods" section
describing how the "refundable" and "grace-period" attributes work together.</t>
</list></t>
</section>