1 package FS::SelfService;
4 use vars qw( $VERSION @ISA @EXPORT_OK $DEBUG
5 $skip_uid_check $dir $socket %autoload $tag );
11 use Storable 2.09 qw(nstore_fd fd_retrieve);
15 @ISA = qw( Exporter );
19 $dir = "/usr/local/freeside";
20 $socket = "$dir/selfservice_socket";
21 $socket .= '.'.$tag if defined $tag && length($tag);
23 #maybe should ask ClientAPI for this list
25 'passwd' => 'passwd/passwd',
26 'chfn' => 'passwd/passwd',
27 'chsh' => 'passwd/passwd',
28 'login_info' => 'MyAccount/login_info',
29 'login_banner_image' => 'MyAccount/login_banner_image',
30 'login' => 'MyAccount/login',
31 'logout' => 'MyAccount/logout',
32 'switch_acct' => 'MyAccount/switch_acct',
33 'switch_cust' => 'MyAccount/switch_cust',
34 'customer_info' => 'MyAccount/customer_info',
35 'customer_info_short' => 'MyAccount/customer_info_short',
37 'contact_passwd' => 'MyAccount/contact/contact_passwd',
38 'list_contacts' => 'MyAccount/contact/list_contacts',
39 'edit_contact' => 'MyAccount/contact/edit_contact',
40 'delete_contact' => 'MyAccount/contact/delete_contact',
41 'new_contact' => 'MyAccount/contact/new_contact',
43 'billing_history' => 'MyAccount/billing_history',
44 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
45 'invoice' => 'MyAccount/invoice',
46 'invoice_pdf' => 'MyAccount/invoice_pdf',
47 'legacy_invoice' => 'MyAccount/legacy_invoice',
48 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
49 'invoice_logo' => 'MyAccount/invoice_logo',
50 'list_invoices' => 'MyAccount/list_invoices', #?
51 'cancel' => 'MyAccount/cancel', #add to ss cgi!
52 'payment_info' => 'MyAccount/payment_info',
53 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
54 'process_payment' => 'MyAccount/process_payment',
55 'store_payment' => 'MyAccount/store_payment',
56 'process_stored_payment' => 'MyAccount/process_stored_payment',
57 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
58 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
59 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
60 'process_prepay' => 'MyAccount/process_prepay',
61 'realtime_collect' => 'MyAccount/realtime_collect',
62 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
63 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
64 'list_svc_usage' => 'MyAccount/list_svc_usage',
65 'svc_status_html' => 'MyAccount/svc_status_html',
66 'svc_status_hash' => 'MyAccount/svc_status_hash',
67 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
68 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
69 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
70 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
71 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
72 'acct_forward_info' => 'MyAccount/acct_forward_info',
73 'process_acct_forward' => 'MyAccount/process_acct_forward',
74 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
75 'add_dsl_device' => 'MyAccount/add_dsl_device',
76 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
77 'port_graph' => 'MyAccount/port_graph',
78 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
79 'list_support_usage' => 'MyAccount/list_support_usage',
80 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
81 'change_pkg' => 'MyAccount/change_pkg',
82 'order_recharge' => 'MyAccount/order_recharge',
83 'renew_info' => 'MyAccount/renew_info',
84 'order_renew' => 'MyAccount/order_renew',
85 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
86 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
87 'charge' => 'MyAccount/charge', #?
88 'part_svc_info' => 'MyAccount/part_svc_info',
89 'provision_acct' => 'MyAccount/provision_acct',
90 'provision_phone' => 'MyAccount/provision_phone',
91 'provision_pbx' => 'MyAccount/provision_pbx',
92 'provision_external' => 'MyAccount/provision_external',
93 'provision_forward' => 'MyAccount/provision_forward',
94 'unprovision_svc' => 'MyAccount/unprovision_svc',
95 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
96 'reset_passwd' => 'MyAccount/reset_passwd',
97 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
98 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
99 'list_tickets' => 'MyAccount/list_tickets',
100 'create_ticket' => 'MyAccount/create_ticket',
101 'get_ticket' => 'MyAccount/get_ticket',
102 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
103 'did_report' => 'MyAccount/did_report',
104 'signup_info' => 'Signup/signup_info',
105 'skin_info' => 'MyAccount/skin_info',
106 'access_info' => 'MyAccount/access_info',
107 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
108 'new_customer' => 'Signup/new_customer',
109 'new_customer_minimal' => 'Signup/new_customer_minimal',
110 'capture_payment' => 'Signup/capture_payment',
111 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
112 'new_agent' => 'Agent/new_agent',
113 'agent_login' => 'Agent/agent_login',
114 'agent_logout' => 'Agent/agent_logout',
115 'agent_info' => 'Agent/agent_info',
116 'agent_list_customers' => 'Agent/agent_list_customers',
117 'check_username' => 'Agent/check_username',
118 'suspend_username' => 'Agent/suspend_username',
119 'unsuspend_username' => 'Agent/unsuspend_username',
120 'mason_comp' => 'MasonComponent/mason_comp',
121 'call_time' => 'PrepaidPhone/call_time',
122 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
123 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
125 'start_thirdparty' => 'MyAccount/start_thirdparty',
126 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
128 'list_quotations' => 'MyAccount/quotation/list_quotations',
129 'quotation_new' => 'MyAccount/quotation/quotation_new',
130 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
131 'quotation_info' => 'MyAccount/quotation/quotation_info',
132 'quotation_print' => 'MyAccount/quotation/quotation_print',
133 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
134 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
135 'quotation_order' => 'MyAccount/quotation/quotation_order',
140 qw( regionselector regionselector_hashref location_form
141 expselect popselector domainselector didselector
145 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
146 $ENV{'SHELL'} = '/bin/sh';
147 $ENV{'IFS'} = " \t\n";
150 $ENV{'BASH_ENV'} = '';
152 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
153 #if you grant appropriate permissions to whatever user
154 my $freeside_uid = scalar(getpwnam('freeside'));
155 die "not running as the freeside user\n"
156 if $> != $freeside_uid && ! $skip_uid_check;
158 -e $dir or die "FATAL: $dir doesn't exist!";
159 -d $dir or die "FATAL: $dir isn't a directory!";
160 -r $dir or die "FATAL: Can't read $dir as freeside user!";
161 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
163 foreach my $autoload ( keys %autoload ) {
166 "sub $autoload { ". '
171 #warn scalar(@_). ": ". join(" / ", @_);
175 $param->{_packet} = \''. $autoload{$autoload}. '\';
177 simple_packet($param);
187 warn "sending ". $packet->{_packet}. " to server"
189 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
190 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
191 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
194 #shoudl trap: Magic number checking on storable file failed at blib/lib/Storable.pm (autosplit into blib/lib/auto/Storable/fd_retrieve.al) line 337, at /usr/local/share/perl/5.6.1/FS/SelfService.pm line 71
196 #block until there is a message on socket
197 # my $w = new IO::Select;
199 # my @wait = $w->can_read;
201 warn "reading message from server"
204 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
205 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
207 warn "returning message to client"
215 FS::SelfService - Freeside self-service API
219 # password and shell account changes
220 use FS::SelfService qw(passwd chfn chsh);
222 # "my account" functionality
223 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
225 #new-style login with an email address and password
226 # can also be used for svc_acct login, set $emailaddress to username@domain
227 my $rv = login ( { 'email' => $emailaddress,
228 'password' => $password,
231 if ( $rv->{'error'} ) {
232 #handle login error...
235 $session_id = $rv->{'session_id'};
238 #classic svc_acct-based login with separate username and password
239 my $rv = login( { 'username' => $username,
241 'password' => $password,
244 if ( $rv->{'error'} ) {
245 #handle login error...
248 $session_id = $rv->{'session_id'};
251 #svc_phone login with phone number and PIN
252 my $rv = login( { 'username' => $phone_number,
253 'domain' => 'svc_phone',
257 if ( $rv->{'error'} ) {
258 #handle login error...
261 $session_id = $rv->{'session_id'};
264 my $customer_info = customer_info( { 'session_id' => $session_id } );
266 #payment_info and process_payment are available in 1.5+ only
267 my $payment_info = payment_info( { 'session_id' => $session_id } );
269 #!!! process_payment example
271 #!!! list_pkgs example
273 #ordering a package with an svc_acct service
274 my $rv = order_pkg( { 'session_id' => $session_id,
275 'pkgpart' => $pkgpart,
276 'svcpart' => $svcpart,
277 'username' => $username,
278 'domsvc' => $domsvc, #svcnum of svc_domain
279 '_password' => $password,
283 #!!! ordering a package with an svc_domain service example
285 #!!! ordering a package with an svc_phone service example
287 #!!! ordering a package with an svc_external service example
289 #!!! ordering a package with an svc_pbx service
291 #ordering a package with no service
292 my $rv = order_pkg( { 'session_id' => $session_id,
293 'pkgpart' => $pkgpart,
298 #quoting a package, then ordering after confirmation
300 my $rv = quotation_new({ 'session_id' => $session_id });
301 my $qnum = $rv->{quotationnum};
302 # add packages to the quotation
303 $rv = quotation_add_pkg({ 'session_id' => $session_id,
304 'quotationnum' => $qnum,
305 'pkgpart' => $pkgpart,
306 'quantity' => $quantity, # defaults to 1
308 # repeat until all packages are added
309 # view the pricing information
310 $rv = quotation_info({ 'session_id' => $session_id,
311 'quotationnum' => $qnum,
313 print "Total setup charges: ".$rv->{total_setup}."\n".
314 "Total recurring charges: ".$rv->{total_recur}."\n";
315 # quotation_info also provides a detailed breakdown of charges, in
318 # ask customer for confirmation, then:
319 $rv = quotation_order({ 'session_id' => $session_id,
320 'quotationnum' => $qnum,
323 #!!! cancel_pkg example
325 # signup functionality
326 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
328 my $signup_info = signup_info;
330 $rv = new_customer( {
333 'company' => $company,
334 'address1' => $address1,
335 'address2' => $address2,
339 'country' => $country,
340 'daytime' => $daytime,
344 'payinfo' => $payinfo,
346 'paystart_month' => $paystart_month
347 'paystart_year' => $paystart_year,
348 'payissue' => $payissue,
350 'paydate' => $paydate,
351 'payname' => $payname,
352 'invoicing_list' => $invoicing_list,
353 'referral_custnum' => $referral_custnum,
354 'agentnum' => $agentnum,
355 'pkgpart' => $pkgpart,
357 'username' => $username,
358 '_password' => $password,
362 'phonenum' => $phonenum,
367 my $error = $rv->{'error'};
368 if ( $error eq '_decline' ) {
378 Use this API to implement your own client "self-service" module.
380 If you just want to customize the look of the existing "self-service" module,
383 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
389 Changes the password for an existing user in svc_acct. Takes a hash
390 reference with the following keys:
396 Username of the account (required)
400 Domain of the account (required)
404 Old password (required)
408 New password (required)
426 =head1 "MY ACCOUNT" FUNCTIONS
432 Creates a user session. Takes a hash reference as parameter with the
439 Email address (username@domain), instead of username and domain. Required for
440 contact-based self-service login, can also be used for svc_acct-based login.
456 Returns a hash reference with the following keys:
462 Empty on success, or an error message on errors.
466 Session identifier for successful logins
470 =item customer_info HASHREF
472 Returns general customer information.
474 Takes a hash reference as parameter with a single key: B<session_id>
476 Returns a hash reference with the following keys:
490 Array reference of hash references of open inoices. Each hash reference has
491 the following keys: invnum, date, owed
495 An HTML fragment containing shipping and billing addresses.
497 =item The following fields are also returned
499 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo payname month year invoicing_list postal_invoicing
503 =item edit_info HASHREF
505 Takes a hash reference as parameter with any of the following keys:
507 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo paycvv payname month year invoicing_list postal_invoicing
509 If a field exists, the customer record is updated with the new value of that
510 field. If a field does not exist, that field is not changed on the customer
513 Returns a hash reference with a single key, B<error>, empty on success, or an
514 error message on errors
516 =item invoice HASHREF
518 Returns an invoice. Takes a hash reference as parameter with two keys:
519 session_id and invnum
521 Returns a hash reference with the following keys:
527 Empty on success, or an error message on errors
539 =item list_invoices HASHREF
541 Returns a list of all customer invoices. Takes a hash reference with a single
544 Returns a hash reference with the following keys:
550 Empty on success, or an error message on errors
554 Reference to array of hash references with the following keys:
564 Invoice date, in UNIX epoch time
572 Cancels this customer.
574 Takes a hash reference as parameter with a single key: B<session_id>
576 Returns a hash reference with a single key, B<error>, which is empty on
577 success or an error message on errors.
579 =item payment_info HASHREF
581 Returns information that may be useful in displaying a payment page.
583 Takes a hash reference as parameter with a single key: B<session_id>.
585 Returns a hash reference with the following keys:
591 Empty on success, or an error message on errors
599 Exact name on credit card (CARD/DCRD)
623 Customer's current default payment type.
627 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
631 For CARD/DCRD payment types, the card number
635 For CARD/DCRD payment types, expiration month
639 For CARD/DCRD payment types, expiration year
641 =item cust_main_county
643 County/state/country data - array reference of hash references, each of which has the fields of a cust_main_county record (see L<FS::cust_main_county>). Note these are not FS::cust_main_county objects, but hash references of columns and values.
647 Array reference of all states in the current default country.
651 Hash reference of card types; keys are card types, values are the exact strings
652 passed to the process_payment function
656 #this doesn't actually work yet
660 #Unique transaction identifier (prevents multiple charges), passed to the
661 #process_payment function
665 =item process_payment HASHREF
667 Processes a payment and possible change of address or payment type. Takes a
668 hash reference as parameter with the following keys:
682 If true, address and card information entered will be saved for subsequent
687 If true, future credit card payments will be done automatically (sets payby to
688 CARD). If false, future credit card payments will be done on-demand (sets
689 payby to DCRD). This option only has meaning if B<save> is set true.
717 Two-letter country code
725 Card expiration month
733 #this doesn't actually work yet
737 #Unique transaction identifier, returned from the payment_info function.
738 #Prevents multiple charges.
742 Returns a hash reference with a single key, B<error>, empty on success, or an
743 error message on errors.
745 =item process_payment_order_pkg
747 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
748 payment processes sucessfully, the package is ordered. Takes a hash reference
749 as parameter with the keys of both methods.
751 Returns a hash reference with a single key, B<error>, empty on success, or an
752 error message on errors.
754 =item process_payment_change_pkg
756 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
757 payment processes sucessfully, the package is ordered. Takes a hash reference
758 as parameter with the keys of both methods.
760 Returns a hash reference with a single key, B<error>, empty on success, or an
761 error message on errors.
764 =item process_payment_order_renew
766 Combines the B<process_payment> and B<order_renew> functions in one step. If
767 the payment processes sucessfully, the renewal is processed. Takes a hash
768 reference as parameter with the keys of both methods.
770 Returns a hash reference with a single key, B<error>, empty on success, or an
771 error message on errors.
775 Returns package information for this customer. For more detail on services,
778 Takes a hash reference as parameter with a single key: B<session_id>
780 Returns a hash reference containing customer package information. The hash reference contains the following keys:
790 Empty on success, or an error message on errors.
792 =item cust_pkg HASHREF
794 Array reference of hash references, each of which has the fields of a cust_pkg
795 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
796 the internal FS:: objects, but hash references of columns and values.
800 =item part_pkg fields
802 All fields of part_pkg for this specific cust_pkg (be careful with this
803 information - it may reveal more about your available packages than you would
804 like users to know in aggregate)
808 #XXX pare part_pkg fields down to a more secure subset
812 An array of hash references indicating information on unprovisioned services
813 available for provisioning for this specific cust_pkg. Each has the following
818 =item part_svc fields
820 All fields of part_svc (be careful with this information - it may reveal more
821 about your available packages than you would like users to know in aggregate)
825 #XXX pare part_svc fields down to a more secure subset
831 An array of hash references indicating information on the customer services
832 already provisioned for this specific cust_pkg. Each has the following keys:
838 Array reference with three elements: The first element is the name of this service. The second element is a meaningful user-specific identifier for the service (i.e. username, domain or mail alias). The last element is the table name of this service.
844 Primary key for this service
848 Service definition (see L<FS::part_svc>)
852 Customer package (see L<FS::cust_pkg>)
856 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
864 Returns service information for this customer.
866 Takes a hash reference as parameter with a single key: B<session_id>
868 Returns a hash reference containing customer package information. The hash reference contains the following keys:
878 An array of hash references indicating information on all of this customer's
879 services. Each has the following keys:
885 Primary key for this service
893 Meaningful user-specific identifier for the service (i.e. username, domain, or
898 Account (svc_acct) services also have the following keys:
916 Upload bytes remaining
920 Download bytes remaining
924 Total bytes remaining
926 =item recharge_amount
930 =item recharge_seconds
932 Number of seconds gained by recharge
934 =item recharge_upbytes
936 Number of upload bytes gained by recharge
938 =item recharge_downbytes
940 Number of download bytes gained by recharge
942 =item recharge_totalbytes
944 Number of total bytes gained by recharge
952 Orders a package for this customer.
954 Takes a hash reference as parameter with the following keys:
964 Package to order (see L<FS::part_pkg>).
968 Quantity for this package order (default 1).
972 Optional locationnum for this package order, for existing locations.
974 Or, for new locations, pass the following fields: address1*, address2, city*,
975 county, state*, zip*, country. (* = required in this case)
987 Service to order (see L<FS::part_svc>).
989 Normally optional; required only to provision a non-svc_acct service, or if the
990 package definition does not contain one svc_acct service definition with
991 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
992 also be specified to indicate that no initial service should be provisioned.
996 Fields used when provisioning an svc_acct service:
1010 Optional security phrase
1014 Optional Access number number
1018 Fields used when provisioning an svc_domain service:
1028 Fields used when provisioning an svc_phone service:
1046 Fields used when provisioning an svc_external service:
1052 External numeric ID.
1056 External text title.
1060 Fields used when provisioning an svc_pbx service:
1074 Returns a hash reference with a single key, B<error>, empty on success, or an
1075 error message on errors. The special error '_decline' is returned for
1076 declined transactions.
1080 Changes a package for this customer.
1082 Takes a hash reference as parameter with the following keys:
1092 Existing customer package.
1096 New package to order (see L<FS::part_pkg>).
1100 Quantity for this package order (default 1).
1104 Returns a hash reference with the following keys:
1110 Empty on success, or an error message on errors.
1114 On success, the new pkgnum
1121 Provides useful info for early renewals.
1123 Takes a hash reference as parameter with the following keys:
1133 Returns a hash reference. On errors, it contains a single key, B<error>, with
1134 the error message. Otherwise, contains a single key, B<dates>, pointing to
1135 an array refernce of hash references. Each hash reference contains the
1142 (Future) Bill date. Indicates a future date for which billing could be run.
1143 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1146 =item bill_date_pretty
1148 (Future) Bill date as a human-readable string. (Convenience for display;
1149 subject to change, so best not to parse for the date.)
1153 Base amount which will be charged if renewed early as of this date.
1157 Renewal date; i.e. even-futher future date at which the customer will be paid
1158 through if the early renewal is completed with the given B<bill-date>.
1159 Specified as a integer UNIX timestamp.
1161 =item renew_date_pretty
1163 Renewal date as a human-readable string. (Convenience for display;
1164 subject to change, so best not to parse for the date.)
1168 Package that will be renewed.
1172 Expiration date of the package that will be renewed.
1174 =item expire_date_pretty
1176 Expiration date of the package that will be renewed, as a human-readable
1177 string. (Convenience for display; subject to change, so best not to parse for
1184 Renews this customer early; i.e. runs billing for this customer in advance.
1186 Takes a hash reference as parameter with the following keys:
1196 Integer date as returned by the B<renew_info> function, indicating the advance
1197 date for which to run billing.
1201 Returns a hash reference with a single key, B<error>, empty on success, or an
1202 error message on errors.
1206 Cancels a package for this customer.
1208 Takes a hash reference as parameter with the following keys:
1218 pkgpart of package to cancel
1222 Returns a hash reference with a single key, B<error>, empty on success, or an
1223 error message on errors.
1225 =item provision_acct
1227 Provisions an account (svc_acct).
1229 Takes a hash reference as parameter with the following keys:
1239 pkgnum of package into which this service is provisioned
1243 svcpart or service definition to provision
1253 =item provision_phone
1255 Provisions a phone number (svc_phone).
1257 Takes a hash reference as parameter with the following keys:
1267 pkgnum of package into which this service is provisioned
1271 svcpart or service definition to provision
1291 E911 Address (optional)
1297 Provisions a customer PBX (svc_pbx).
1299 Takes a hash reference as parameter with the following keys:
1309 pkgnum of package into which this service is provisioned
1313 svcpart or service definition to provision
1319 =item max_extensions
1321 =item max_simultaneous
1327 =item provision_external
1329 Provisions an external service (svc_external).
1331 Takes a hash reference as parameter with the following keys:
1341 pkgnum of package into which this service is provisioned
1345 svcpart or service definition to provision
1355 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1359 =item contact_passwd
1361 Changes the password for the currently-logged in contact.
1363 Takes a hash reference as parameter with the following keys:
1373 Returns a hash reference with a single parameter, B<error>, which contains an
1374 error message, or empty on success.
1380 Updates information for the currently-logged in contact, or (optionally) the
1383 Takes a hash reference as parameter with the following keys:
1391 If already logged in as a contact, this is optional.
1401 Returns a hash reference with a single parameter, B<error>, which contains an
1402 error message, or empty on success.
1406 Creates a new contact.
1408 Takes a hash reference as parameter with the following keys:
1422 Optional contact classnum (TODO: or name)
1426 =item selfservice_access
1428 Y to enable self-service access
1434 Returns a hash reference with a single parameter, B<error>, which contains an
1435 error message, or empty on success.
1437 =item delete_contact
1439 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1442 Takes a hash reference as parameter with the following keys:
1452 Returns a hash reference with a single parameter, B<error>, which contains an
1453 error message, or empty on success.
1455 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1457 All of these functions require the user to be logged in, and the 'session_id'
1458 key to be included in the argument hashref.`
1462 =item list_quotations HASHREF
1464 Returns a hashref listing this customer's active self-service quotations.
1471 an arrayref containing an element for each quotation.
1479 the date it was started
1483 the number of packages
1487 the sum of setup fees
1491 the sum of recurring charges
1495 =item quotation_new HASHREF
1497 Creates an empty quotation and returns a hashref containing 'quotationnum',
1498 the primary key of the new quotation.
1500 =item quotation_delete HASHREF
1502 Disables (does not really delete) a quotation. Takes the following arguments:
1508 =item quotationnum - the quotation to delete
1512 Returns 'error' => a string, which will be empty on success.
1514 =item quotation_info HASHREF
1516 Returns total and detailed pricing information on a quotation.
1518 Takes the following arguments:
1524 =item quotationnum - the quotation to return
1528 Returns a hashref containing:
1530 - total_setup, the total of setup fees (and their taxes)
1531 - total_recur, the total of all recurring charges (and their taxes)
1532 - sections, an arrayref containing an element for each quotation section.
1533 - description, a line of text describing the group of charges
1534 - subtotal, the total of charges in this group (if appropriate)
1535 - detail_items, an arrayref of line items
1536 - pkgnum, the reference number of the package
1537 - description, the package name (or tax name)
1539 - amount, the amount charged
1540 If the detail item represents a subtotal, it will instead contain:
1541 - total_item: description of the subtotal
1542 - total_amount: the subtotal amount
1545 =item quotation_print HASHREF
1547 Renders the quotation as HTML or PDF. Takes the following arguments:
1553 =item quotationnum - the quotation to return
1555 =item format - 'html' or 'pdf'
1559 Returns a hashref containing 'document', the contents of the file.
1561 =item quotation_add_pkg HASHREF
1563 Adds a package to a quotation. Takes the following arguments:
1569 =item pkgpart - the package to add
1571 =item quotationnum - the quotation to add it to
1573 =item quantity - the package quantity (defaults to 1)
1575 =item address1, address2, city, state, zip, country - address fields to set
1576 the service location
1580 Returns 'error' => a string, which will be empty on success.
1582 =item quotation_remove_pkg HASHREF
1584 Removes a package from a quotation. Takes the following arguments:
1590 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1592 =item quotationnum - the quotation to remove it from
1596 Returns 'error' => a string, which will be empty on success.
1600 =item quotation_order HASHREF
1602 Converts the packages in a quotation into real packages. Takes the following
1605 Takes the following arguments:
1611 =item quotationnum - the quotation to order
1617 =head1 SIGNUP FUNCTIONS
1621 =item signup_info HASHREF
1623 Takes a hash reference as parameter with the following keys:
1627 =item session_id - Optional agent/reseller interface session
1631 Returns a hash reference containing information that may be useful in
1632 displaying a signup page. The hash reference contains the following keys:
1636 =item cust_main_county
1638 County/state/country data - array reference of hash references, each of which has the fields of a cust_main_county record (see L<FS::cust_main_county>). Note these are not FS::cust_main_county objects, but hash references of columns and values.
1642 Available packages - array reference of hash references, each of which has the fields of a part_pkg record (see L<FS::part_pkg>). Each hash reference also has an additional 'payby' field containing an array reference of acceptable payment types specific to this package (see below and L<FS::part_pkg/payby>). Note these are not FS::part_pkg objects, but hash references of columns and values. Requires the 'signup_server-default_agentnum' configuration value to be set, or
1643 an agentnum specified explicitly via reseller interface session_id in the
1648 Array reference of hash references, each of which has the fields of an agent record (see L<FS::agent>). Note these are not FS::agent objects, but hash references of columns and values.
1650 =item agentnum2part_pkg
1652 Hash reference; keys are agentnums, values are array references of available packages for that agent, in the same format as the part_pkg arrayref above.
1656 Access numbers - array reference of hash references, each of which has the fields of an svc_acct_pop record (see L<FS::svc_acct_pop>). Note these are not FS::svc_acct_pop objects, but hash references of columns and values.
1658 =item security_phrase
1660 True if the "security_phrase" feature is enabled
1664 Array reference of acceptable payment types for signup
1670 credit card - automatic
1674 credit card - on-demand - version 1.5+ only
1678 electronic check - automatic
1682 electronic check - on-demand - version 1.5+ only
1690 billing, not recommended for signups
1694 free, definitely not recommended for signups
1698 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1704 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1708 Hash reference of message catalog values, to support error message customization. Currently available keys are: passwords_dont_match, invalid_card, unknown_card_type, and not_a (as in "Not a Discover card"). Values are configured in the web interface under "View/Edit message catalog".
1714 =item countrydefault
1720 =item new_customer_minimal HASHREF
1722 Creates a new customer.
1724 Current differences from new_customer: An address is not required. promo_code
1725 and reg_code are not supported. If invoicing_list and _password is passed, a
1726 contact will be created with self-service access (no pkgpart or username is
1727 necessary). No initial billing is run (this may change in a future version).
1729 Takes a hash reference as parameter with the following keys:
1735 first name (required)
1739 last name (required)
1743 (not typically collected; mostly used for ACH transactions)
1775 Daytime phone number
1779 Evening phone number
1787 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1791 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1795 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1799 Expiration date for CARD/DCRD
1803 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1805 =item invoicing_list
1807 comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses),
1809 =item referral_custnum
1811 referring customer number
1819 pkgpart of initial package
1835 Access number (index, not the literal number)
1839 Country code (to be provisioned as a service)
1843 Phone number (to be provisioned as a service)
1851 Returns a hash reference with the following keys:
1857 Empty on success, or an error message on errors. The special error '_decline' is returned for declined transactions; other error messages should be suitable for display to the user (and are customizable in under Configuration | View/Edit message catalog)
1861 =item new_customer HASHREF
1863 Creates a new customer. Takes a hash reference as parameter with the
1870 first name (required)
1874 last name (required)
1878 (not typically collected; mostly used for ACH transactions)
1884 =item address1 (required)
1892 =item city (required)
1900 =item state (required)
1904 =item zip (required)
1910 Daytime phone number
1914 Evening phone number
1922 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1926 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1930 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1934 Expiration date for CARD/DCRD
1938 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1940 =item invoicing_list
1942 comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses),
1944 =item referral_custnum
1946 referring customer number
1954 pkgpart of initial package
1970 Access number (index, not the literal number)
1974 Country code (to be provisioned as a service)
1978 Phone number (to be provisioned as a service)
1986 Returns a hash reference with the following keys:
1992 Empty on success, or an error message on errors. The special error '_decline' is returned for declined transactions; other error messages should be suitable for display to the user (and are customizable in under Configuration | View/Edit message catalog)
1996 =item regionselector HASHREF | LIST
1998 Takes as input a hashref or list of key/value pairs with the following keys:
2002 =item selected_county
2004 Currently selected county
2006 =item selected_state
2008 Currently selected state
2010 =item selected_country
2012 Currently selected country
2016 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2020 Specify a javascript subroutine to call on changes
2026 =item default_country
2032 An arrayref of hash references specifying regions. Normally you can just pass the value of the I<cust_main_county> field returned by B<signup_info>.
2036 Returns a list consisting of three HTML fragments for county selection,
2037 state selection and country selection, respectively.
2041 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2042 sub regionselector {
2049 $param->{'selected_country'} ||= $param->{'default_country'};
2050 $param->{'selected_state'} ||= $param->{'default_state'};
2052 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2056 my %cust_main_county;
2058 # unless ( @cust_main_county ) { #cache
2059 #@cust_main_county = qsearch('cust_main_county', {} );
2060 #foreach my $c ( @cust_main_county ) {
2061 foreach my $c ( @{ $param->{'locales'} } ) {
2062 #$countyflag=1 if $c->county;
2063 $countyflag=1 if $c->{county};
2064 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2065 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2066 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2069 $countyflag=1 if $param->{selected_county};
2071 my $script_html = <<END;
2073 function opt(what,value,text) {
2074 var optionName = new Option(text, value, false, false);
2075 var length = what.length;
2076 what.options[length] = optionName;
2078 function ${prefix}country_changed(what) {
2079 country = what.options[what.selectedIndex].text;
2080 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2081 what.form.${prefix}state.options[i] = null;
2083 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2085 foreach my $country ( sort keys %cust_main_county ) {
2086 $script_html .= "\nif ( country == \"$country\" ) {\n";
2087 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2088 my $text = $state || '(n/a)';
2089 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2091 $script_html .= "}\n";
2094 $script_html .= <<END;
2096 function ${prefix}state_changed(what) {
2099 if ( $countyflag ) {
2100 $script_html .= <<END;
2101 state = what.options[what.selectedIndex].text;
2102 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2103 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2104 what.form.${prefix}county.options[i] = null;
2107 foreach my $country ( sort keys %cust_main_county ) {
2108 $script_html .= "\nif ( country == \"$country\" ) {\n";
2109 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2110 $script_html .= "\nif ( state == \"$state\" ) {\n";
2111 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2112 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2113 my $text = $county || '(n/a)';
2115 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2117 $script_html .= "}\n";
2119 $script_html .= "}\n";
2123 $script_html .= <<END;
2128 my $county_html = $script_html;
2129 if ( $countyflag ) {
2130 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2131 foreach my $county (
2132 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2134 my $text = $county || '(n/a)';
2135 $county_html .= qq!<OPTION VALUE="$county"!.
2136 ($county eq $param->{'selected_county'} ?
2143 $county_html .= '</SELECT>';
2146 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2149 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2150 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2151 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2152 my $text = $state || '(n/a)';
2153 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2154 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2156 $state_html .= '</SELECT>';
2158 my $country_html = '';
2159 if ( scalar( keys %cust_main_county ) > 1 ) {
2161 $country_html = qq(<SELECT NAME="${prefix}country" ).
2162 qq(onChange="${prefix}country_changed(this); ).
2163 $param->{'onchange'}.
2166 my $countrydefault = $param->{default_country} || 'US';
2167 foreach my $country (
2168 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2169 keys %cust_main_county
2171 my $selected = $country eq $param->{'selected_country'}
2174 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2176 $country_html .= '</SELECT>';
2179 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2180 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2184 ($county_html, $state_html, $country_html);
2188 sub regionselector_hashref {
2189 my ($county_html, $state_html, $country_html) = regionselector(@_);
2191 'county_html' => $county_html,
2192 'state_html' => $state_html,
2193 'country_html' => $country_html,
2197 =item location_form HASHREF | LIST
2199 Takes as input a hashref or list of key/value pairs with the following keys:
2205 Current customer session_id
2209 Omit red asterisks from required fields.
2211 =item address1_label
2213 Label for first address line.
2217 Returns an HTML fragment for a location form (address, city, state, zip,
2230 my $session_id = delete $param->{'session_id'};
2232 my $rv = mason_comp( 'session_id' => $session_id,
2233 'comp' => '/elements/location.html',
2234 'args' => [ %$param ],
2238 $rv->{'error'} || $rv->{'output'};
2243 #=item expselect HASHREF | LIST
2245 #Takes as input a hashref or list of key/value pairs with the following keys:
2249 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2251 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2255 =item expselect PREFIX [ DATE ]
2257 Takes as input a unique prefix string and the current expiration date, in
2258 yyyy-mm-dd or m-d-yyyy format
2260 Returns an HTML fragments for expiration date selection.
2266 #if ( ref($_[0]) ) {
2270 #my $prefix = $param->{'prefix'};
2271 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2272 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2274 my $date = scalar(@_) ? shift : '';
2276 my( $m, $y ) = ( 0, 0 );
2277 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2278 ( $m, $y ) = ( $2, $1 );
2279 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2280 ( $m, $y ) = ( $1, $3 );
2282 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2284 $return .= qq!<OPTION VALUE="$_"!;
2285 $return .= " SELECTED" if $_ == $m;
2288 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2290 my $thisYear = $t[5] + 1900;
2291 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2292 $return .= qq!<OPTION VALUE="$_"!;
2293 $return .= " SELECTED" if $_ == $y;
2296 $return .= "</SELECT>";
2301 =item popselector HASHREF | LIST
2303 Takes as input a hashref or list of key/value pairs with the following keys:
2309 Access number number
2313 An arrayref of hash references specifying access numbers. Normally you can just pass the value of the I<svc_acct_pop> field returned by B<signup_info>.
2317 Returns an HTML fragment for access number selection.
2321 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2329 my $popnum = $param->{'popnum'};
2330 my $pops = $param->{'pops'};
2332 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2333 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2334 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2335 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2336 if scalar(@$pops) == 1;
2339 my %popnum2pop = ();
2341 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2342 $popnum2pop{$_->{popnum}} = $_;
2347 function opt(what,href,text) {
2348 var optionName = new Option(text, href, false, false)
2349 var length = what.length;
2350 what.options[length] = optionName;
2354 my $init_popstate = $param->{'init_popstate'};
2355 if ( $init_popstate ) {
2356 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2357 $init_popstate. '">';
2360 function acstate_changed(what) {
2361 state = what.options[what.selectedIndex].text;
2362 what.form.popac.options.length = 0
2363 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2367 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2368 foreach my $state ( sort { $a cmp $b } @states ) {
2369 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2371 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2372 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2373 if ($ac eq $param->{'popac'}) {
2374 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2377 $text .= "}\n" unless $init_popstate;
2379 $text .= "popac_changed(what.form.popac)}\n";
2382 function popac_changed(what) {
2383 ac = what.options[what.selectedIndex].text;
2384 what.form.popnum.options.length = 0;
2385 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2389 foreach my $state ( @states ) {
2390 foreach my $popac ( keys %{ $pop{$state} } ) {
2391 $text .= "\nif ( ac == \"$popac\" ) {\n";
2393 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2394 my $o_popnum = $pop->{popnum};
2395 my $poptext = $pop->{city}. ', '. $pop->{state}.
2396 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2398 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2399 if ($popnum == $o_popnum) {
2400 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2408 $text .= "}\n</SCRIPT>\n";
2410 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2413 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2414 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2415 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2416 ">$_" foreach sort { $a cmp $b } @states;
2417 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2420 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2421 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2423 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2426 #comment this block to disable initial list polulation
2427 my @initial_select = ();
2428 if ( scalar( @$pops ) > 100 ) {
2429 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2431 @initial_select = @$pops;
2433 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2434 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2435 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2436 $pop->{city}. ', '. $pop->{state}.
2437 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2440 $text .= qq!</SELECT></TD></TR></TABLE>!;
2446 =item domainselector HASHREF | LIST
2448 Takes as input a hashref or list of key/value pairs with the following keys:
2458 Service number of the selected item.
2462 Returns an HTML fragment for domain selection.
2466 sub domainselector {
2473 my $domsvc= $param->{'domsvc'};
2475 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2476 my $domains = $rv->{'domains'};
2477 $domsvc = $rv->{'domsvc'} unless $domsvc;
2479 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2480 unless scalar(keys %$domains);
2482 if (scalar(keys %$domains) == 1) {
2484 foreach(keys %$domains) {
2487 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2488 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2491 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2493 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2495 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2496 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2497 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2498 $domains->{$domain};
2501 $text .= qq!</SELECT></TD></TR>!;
2507 =item didselector HASHREF | LIST
2509 Takes as input a hashref or list of key/value pairs with the following keys:
2515 Field name for the returned HTML fragment.
2519 Service definition (see L<FS::part_svc>)
2523 Returns an HTML fragment for DID selection.
2535 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2536 'args'=>[ %$param ],
2540 $rv->{'error'} || $rv->{'output'};
2546 =head1 RESELLER FUNCTIONS
2548 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2549 with their active session, and the B<customer_info> and B<order_pkg> functions
2550 with their active session and an additional I<custnum> parameter.
2552 For the most part, development of the reseller web interface has been
2553 superceded by agent-virtualized access to the backend.
2565 =item agent_list_customers
2567 List agent's customers.
2575 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>