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 );
9 use FS::Record qw( qsearch );
11 use List::Util qw( min );
12 use FS::UI::bytecount;
15 tie my %temporalities, 'Tie::IxHash',
16 'upcoming' => "Upcoming (future)",
17 'preceding' => "Preceding (past)",
20 tie my %contract_years, 'Tie::IxHash', (
22 map { $_*12 => $_ } (1..5),
26 'name' => 'Flat rate (anniversary billing)',
27 'shortname' => 'Anniversary',
28 'inherit_fields' => [ 'prorate_Mixin', 'usage_Mixin', 'global_Mixin' ],
30 #false laziness w/voip_cdr.pm
31 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
33 'select_options' => \%temporalities,
36 #used in cust_pkg.pm so could add to any price plan
37 'expire_months' => { 'name' => 'Auto-add an expiration date this number of months out',
39 'adjourn_months'=> { 'name' => 'Auto-add a suspension date this number of months out',
41 'contract_end_months'=> {
42 'name' => 'Auto-add a contract end date this number of years out',
44 'select_options' => \%contract_years,
46 #used in cust_pkg.pm so could add to any price plan where it made sense
47 'start_1st' => { 'name' => 'Auto-add a start date to the 1st, ignoring the current month.',
50 'sync_bill_date' => { 'name' => 'Prorate first month to synchronize '.
51 'with the customer\'s other packages',
54 'prorate_defer_bill' => {
55 'name' => 'When synchronizing, defer the bill until '.
56 'the customer\'s next bill date',
59 'prorate_round_day' => {
60 'name' => 'When synchronizing, round the prorated '.
61 'period to the nearest full day',
64 'add_full_period' => { 'disabled' => 1 }, # doesn't make sense with sync?
66 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
69 'unsuspend_adjust_bill' =>
70 { 'name' => 'Adjust next bill date forward when '.
75 'externalid' => { 'name' => 'Optional External ID',
79 'fieldorder' => [ qw( recur_temporality
80 expire_months adjourn_months
83 sync_bill_date prorate_defer_bill prorate_round_day
84 suspend_bill unsuspend_adjust_bill
92 my $conf = new FS::Conf;
93 my $money_char = $conf->config('money_char') || '$';
94 my $setup = $self->option('setup_fee') || 0;
95 my $recur = $self->option('recur_fee', 1) || 0;
97 $str = $money_char . $setup . ($recur ? ' setup ' : ' one-time') if $setup;
98 $str .= ', ' if ($setup && $recur);
99 $str .= $money_char. $recur. '/'. $self->freq_pretty if $recur;
104 my($self, $cust_pkg, $sdate, $details, $param ) = @_;
106 return 0 if $self->prorate_setup($cust_pkg, $sdate);
109 my $count = $self->option( 'additional_count', 'quiet' ) || 0;
110 while ($i < $count) {
111 push @$details, $self->option( 'additional_info' . $i++ );
114 my $quantity = $cust_pkg->quantity || 1;
116 my $charge = $quantity * $self->unit_setup($cust_pkg, $sdate, $details);
120 $param->{'setup_charge'} = $charge;
121 $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
122 delete $param->{'setup_charge'};
125 sprintf('%.2f', $charge - $discount);
129 my($self, $cust_pkg, $sdate, $details ) = @_;
131 $self->option('setup_fee') || 0;
136 my($cust_pkg, $sdate, $details, $param ) = @_;
138 #my $last_bill = $cust_pkg->last_bill;
139 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
142 if $self->recur_temporality eq 'preceding' && $last_bill == 0;
144 my $charge = $self->base_recur($cust_pkg, $sdate);
145 if ( my $cutoff_day = $self->cutoff_day($cust_pkg) ) {
146 $charge = $self->calc_prorate(@_, $cutoff_day);
148 elsif ( $param->{freq_override} ) {
149 # XXX not sure if this should be mutually exclusive with sync_bill_date.
150 # Given the very specific problem that freq_override is meant to 'solve',
151 # it probably should.
152 $charge *= $param->{freq_override} if $param->{freq_override};
155 my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
156 return sprintf('%.2f', $charge - $discount);
161 my $cust_pkg = shift;
162 if ( $self->option('sync_bill_date',1) ) {
163 my $next_bill = $cust_pkg->cust_main->next_bill_date;
164 if ( defined($next_bill) ) {
165 return (localtime($next_bill))[3];
172 my($self, $cust_pkg, $sdate) = @_;
173 $self->option('recur_fee', 1) || 0;
176 sub base_recur_permonth {
177 my($self, $cust_pkg) = @_;
179 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
181 sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq );
186 my $conf = new FS::Conf;
187 if ( $self->recur_temporality eq 'preceding'
188 and $self->option('bill_recur_on_cancel', 1) ) {
189 # run another recurring cycle
190 return $self->calc_recur(@_);
192 elsif ( $conf->exists('bill_usage_on_cancel') # should be a package option?
193 and $self->can('calc_usage') ) {
194 # bill for outstanding usage
195 return $self->calc_usage(@_);
201 my ($self, $cust_pkg, %options) = @_;
204 if ($options{'time'}) {
205 $time = $options{'time'};
210 my $next_bill = $cust_pkg->getfield('bill') || 0;
212 return 0 if ! $self->base_recur($cust_pkg, \$time)
214 || $next_bill < $time;
216 # Use actual charge for this period, not base_recur (for discounts).
217 # Use sdate < $time and edate >= $time because when billing on
218 # cancellation, edate = $time.
221 qsearch('cust_bill_pkg', {
222 pkgnum => $cust_pkg->pkgnum,
223 sdate => {op => '<' , value => $time},
224 edate => {op => '>=', value => $time},
225 recur => {op => '>' , value => 0},
228 # hack to deal with the weird behavior of edate on package cancellation
229 my $edate = $item->edate;
230 if ( $self->recur_temporality eq 'preceding' ) {
231 $edate = $self->add_freq($item->sdate);
233 $credit += ($item->recur - $item->usage) *
234 ($edate - $time) / ($edate - $item->sdate);
236 sprintf('%.2f', $credit);
237 #sprintf("%.2f", $self->base_recur($cust_pkg, \$time) * ( $next_bill - $time ) / $freq_sec );
241 sub is_free_options {
242 qw( setup_fee recur_fee );
245 sub is_prepaid { 0; } #no, we're postpaid
247 sub can_start_date { ! shift->option('start_1st', 1) }
249 sub can_discount { 1; }
251 sub recur_temporality {
253 $self->option('recur_temporality', 1);
256 sub usage_valuehash {
258 map { $_, $self->option($_) }
259 grep { $self->option($_, 'hush') }
260 qw(seconds upbytes downbytes totalbytes);
264 my($self, $cust_pkg, %opt) = @_;
265 warn " resetting usage counters" if defined($opt{debug}) && $opt{debug} > 1;
266 my %values = $self->usage_valuehash;
267 if ($self->option('usage_rollover', 1)) {
268 $cust_pkg->recharge(\%values);
270 $cust_pkg->set_usage(\%values, %opt);