From: jeff <jeff>
Date: Tue, 20 Nov 2007 02:24:56 +0000 (+0000)
Subject: document recurring billing
X-Git-Tag: BUSINESS_ONLINEPAYMENT_3_00_09~4
X-Git-Url: http://git.freeside.biz/gitweb/?a=commitdiff_plain;ds=sidebyside;h=b3c46f43090dd765543e613f164e896a738da62c;hp=ea069a5246c0cd3ecb51f4707d04117966fed69f;p=Business-OnlinePayment.git

document recurring billing
---

diff --git a/Changes b/Changes
index 69151ba..8a87fb6 100644
--- a/Changes
+++ b/Changes
@@ -2,6 +2,7 @@ Revision history for Perl extension Business::OnlinePayment.
 
 3.00_09  unreleased
         - doc: Allowable values of account_type
+        - doc: Recurring billing actions and fields
 
 3.00_08  Wed Jun 13 17:51:14 PDT 2007
         - B:OP:HTTPS: set response_page, response_code, response_headers
diff --git a/OnlinePayment.pm b/OnlinePayment.pm
index 09c9b4b..64c66db 100644
--- 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