document recurring billing

[Business-OnlinePayment.git] / OnlinePayment.pm

diff --git a/OnlinePayment.pm b/OnlinePayment.pm
index 09c9b4b..64c66db 100644 (file)
--- a/OnlinePayment.pm
+++ b/OnlinePayment.pm
@@ -278,7 +278,9 @@ processors support all these transaction types).
 =item * action
 
 What to do with the transaction (currently available are: Normal
-Authorization, Authorization Only, Credit, Post Authorization)
+Authorization, Authorization Only, Credit, Post Authorization,
+Recurring Authorization, Modify Recurring Authorization,
+Cancel Recurring Authorization)
 
 =item * description
 
@@ -460,6 +462,28 @@ checks or electronic funds transfer.
 
 =back
 
+=head3 RECURRING BILLING FIELDS
+
+=over 4
+
+=item * interval 
+
+Interval expresses the amount of time between billings: digits, whitespace
+and units (currently "days" or "months" in either singular or plural form).
+
+=item * start
+
+The date of the first transaction (used for processors which allow delayed
+start).
+
+=item * periods
+
+The number of cycles of interval length for which billing should occur 
+(inclusive of 'trial periods' if the processor supports recurring billing
+at more than one rate)
+
+=back
+
 =head2 submit();
 
 Submit the transaction to the processor for completion