1 package FS::part_pkg::flat;
2 use base qw( FS::part_pkg::prorate_Mixin
3 FS::part_pkg::discount_Mixin
8 use vars qw( %info %usage_recharge_fields @usage_recharge_fieldorder );
10 use List::Util qw( min );
11 use FS::UI::bytecount;
14 tie my %temporalities, 'Tie::IxHash',
15 'upcoming' => "Upcoming (future)",
16 'preceding' => "Preceding (past)",
19 tie my %contract_years, 'Tie::IxHash', (
21 map { $_*12 => $_ } (1..5),
25 'name' => 'Flat rate (anniversary billing)',
26 'shortname' => 'Anniversary',
27 'inherit_fields' => [ 'usage_Mixin', 'global_Mixin' ],
29 #false laziness w/voip_cdr.pm
30 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
32 'select_options' => \%temporalities,
35 #used in cust_pkg.pm so could add to any price plan
36 'expire_months' => { 'name' => 'Auto-add an expiration date this number of months out',
38 'adjourn_months'=> { 'name' => 'Auto-add a suspension date this number of months out',
40 'contract_end_months'=> {
41 'name' => 'Auto-add a contract end date this number of years out',
43 'select_options' => \%contract_years,
45 #used in cust_pkg.pm so could add to any price plan where it made sense
46 'start_1st' => { 'name' => 'Auto-add a start date to the 1st, ignoring the current month.',
49 'sync_bill_date' => { 'name' => 'Prorate first month to synchronize '.
50 'with the customer\'s other packages',
53 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
56 'unsuspend_adjust_bill' =>
57 { 'name' => 'Adjust next bill date forward when '.
62 'externalid' => { 'name' => 'Optional External ID',
66 'fieldorder' => [ qw( recur_temporality
67 expire_months adjourn_months
69 start_1st sync_bill_date
70 suspend_bill unsuspend_adjust_bill
78 my $conf = new FS::Conf;
79 my $money_char = $conf->config('money_char') || '$';
80 my $setup = $self->option('setup_fee') || 0;
81 my $recur = $self->option('recur_fee', 1) || 0;
83 $str = $money_char . $setup . ' one-time' if $setup;
84 $str .= ', ' if ($setup && $recur);
85 $str .= $money_char . $recur . ' recurring ' if $recur;
90 my($self, $cust_pkg, $sdate, $details, $param ) = @_;
93 my $count = $self->option( 'additional_count', 'quiet' ) || 0;
95 push @$details, $self->option( 'additional_info' . $i++ );
98 my $quantity = $cust_pkg->quantity || 1;
100 my $charge = $quantity * $self->unit_setup($cust_pkg, $sdate, $details);
104 $param->{'setup_charge'} = $charge;
105 $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
106 delete $param->{'setup_charge'};
109 sprintf('%.2f', $charge - $discount);
113 my($self, $cust_pkg, $sdate, $details ) = @_;
115 $self->option('setup_fee') || 0;
120 my($cust_pkg, $sdate, $details, $param ) = @_;
122 #my $last_bill = $cust_pkg->last_bill;
123 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
126 if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
128 my $charge = $self->base_recur($cust_pkg, $sdate);
129 if ( $self->option('sync_bill_date',1) ) {
130 my $next_bill = $cust_pkg->cust_main->next_bill_date;
131 if ( defined($next_bill) ) {
132 my $cutoff_day = (localtime($next_bill))[3];
133 $charge = $self->calc_prorate(@_, $cutoff_day);
136 elsif ( $param->{freq_override} ) {
137 # XXX not sure if this should be mutually exclusive with sync_bill_date.
138 # Given the very specific problem that freq_override is meant to 'solve',
139 # it probably should.
140 $charge *= $param->{freq_override} if $param->{freq_override};
143 my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
144 return sprintf('%.2f', $charge - $discount);
148 my($self, $cust_pkg, $sdate) = @_;
149 $self->option('recur_fee', 1) || 0;
152 sub base_recur_permonth {
153 my($self, $cust_pkg) = @_;
155 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
157 sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq );
161 my ($self, $cust_pkg, %options) = @_;
164 if ($options{'time'}) {
165 $time = $options{'time'};
170 my $next_bill = $cust_pkg->getfield('bill') || 0;
172 return 0 if ! $self->base_recur($cust_pkg, \$time)
174 || $next_bill < $time;
177 'h' => 3600, # 60 * 60
178 'd' => 86400, # 60 * 60 * 24
179 'w' => 604800, # 60 * 60 * 24 * 7
180 'm' => 2629744, # 60 * 60 * 24 * 365.2422 / 12
183 $self->freq =~ /^(\d+)([hdwm]?)$/
184 or die 'unparsable frequency: '. $self->freq;
185 my $freq_sec = $1 * $sec{$2||'m'};
186 return 0 unless $freq_sec;
188 sprintf("%.2f", $self->base_recur($cust_pkg, \$time) * ( $next_bill - $time ) / $freq_sec );
192 sub is_free_options {
193 qw( setup_fee recur_fee );
196 sub is_prepaid { 0; } #no, we're postpaid
198 sub can_start_date { ! shift->option('start_1st', 1) }
200 #XXX discounts only on recurring fees for now (no setup/one-time or usage)
203 $self->freq =~ /^\d+$/ && $self->freq > 0;
206 sub usage_valuehash {
208 map { $_, $self->option($_) }
209 grep { $self->option($_, 'hush') }
210 qw(seconds upbytes downbytes totalbytes);
214 my($self, $cust_pkg, %opt) = @_;
215 warn " resetting usage counters" if defined($opt{debug}) && $opt{debug} > 1;
216 my %values = $self->usage_valuehash;
217 if ($self->option('usage_rollover', 1)) {
218 $cust_pkg->recharge(\%values);
220 $cust_pkg->set_usage(\%values, %opt);