add omit_cust_main_county flag to payment_info API call, RT#75124
authorIvan Kohler <ivan@freeside.biz>
Sat, 1 Apr 2017 17:29:31 +0000 (10:29 -0700)
committerIvan Kohler <ivan@freeside.biz>
Sat, 1 Apr 2017 17:29:31 +0000 (10:29 -0700)
fs_selfservice/FS-SelfService/SelfService.pm

index 700e60b..c95e056 100644 (file)
@@ -267,7 +267,6 @@ FS::SelfService - Freeside self-service API
 
   my $customer_info = customer_info( { 'session_id' => $session_id } );
 
-  #payment_info and process_payment are available in 1.5+ only
   my $payment_info = payment_info( { 'session_id' => $session_id } );
 
   #!!! process_payment example
@@ -586,7 +585,19 @@ success or an error message on errors.
 
 Returns information that may be useful in displaying a payment page.
 
-Takes a hash reference as parameter with a single key: B<session_id>.
+Takes a hash reference as parameter with the following keys:
+
+=over 4
+
+=item session_id
+
+Required session ID
+
+=item omit_cust_main_county
+
+Optional, pass a true value to omit cust_main_county data for performance.
+
+=back
 
 Returns a hash reference with the following keys: