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( $conf $money_char %info
9 %usage_recharge_fields @usage_recharge_fieldorder
12 use FS::Record qw( qsearch );
13 use FS::cust_credit_source_bill_pkg;
15 use List::Util qw( min );
16 use FS::UI::bytecount;
18 use Time::Local 'timelocal';
20 #ask FS::UID to run this stuff for us later
21 FS::UID->install_callback( sub {
23 $money_char = $conf->config('money_char') || '$';
26 tie my %temporalities, 'Tie::IxHash',
27 'upcoming' => "Upcoming (future)",
28 'preceding' => "Preceding (past)",
31 tie my %contract_years, 'Tie::IxHash', (
33 map { $_*12 => $_ } (1..5),
37 'name' => 'Flat rate (anniversary billing)',
38 'shortname' => 'Anniversary',
39 'inherit_fields' => [ 'prorate_Mixin', 'usage_Mixin', 'global_Mixin' ],
41 #false laziness w/voip_cdr.pm
42 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
44 'select_options' => \%temporalities,
47 #used in cust_pkg.pm so could add to any price plan where it made sense
48 'start_1st' => { 'name' => 'Auto-add a start date to the 1st, ignoring the current month.',
51 'sync_bill_date' => { 'name' => 'Prorate first month to synchronize '.
52 'with the customer\'s other packages',
55 'prorate_defer_bill' => {
56 'name' => 'When synchronizing, defer the bill until '.
57 'the customer\'s next bill date',
60 'prorate_round_day' => {
61 'name' => 'When synchronizing, round the prorated '.
64 'select_options' => \%FS::part_pkg::prorate_Mixin::prorate_round_day_opts,
66 'add_full_period' => { 'disabled' => 1 }, # doesn't make sense with sync?
68 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
71 'unsuspend_adjust_bill' =>
72 { 'name' => 'Adjust next bill date forward when '.
76 'bill_recur_on_cancel' => {
77 'name' => 'Bill the last period on cancellation',
80 'bill_suspend_as_cancel' => {
81 'name' => 'Bill immediately upon suspension', #desc?
84 'externalid' => { 'name' => 'Optional External ID',
88 'fieldorder' => [ qw( recur_temporality
90 sync_bill_date prorate_defer_bill prorate_round_day
91 suspend_bill unsuspend_adjust_bill
93 bill_suspend_as_cancel
103 my $setup = $opt{cust_pkg} ? $self->base_setup( $opt{cust_pkg} )
104 : ($self->option('setup_fee') || 0);
105 my $recur = $opt{cust_pkg} ? $self->base_recur( $opt{cust_pkg} )
106 : ($self->option('recur_fee', 1) || 0);
107 $recur += $self->usageprice_recur( $opt{cust_pkg} ) if $opt{cust_pkg};
110 $str = $money_char . $setup . ($recur ? ' setup' : ' one-time') if $setup;
111 $str .= ', ' if ($setup && $recur);
112 $str .= $money_char. $recur. '/'. $self->freq_pretty if $recur;
117 my($self, $cust_pkg, $sdate, $details, $param ) = @_;
119 return 0 if $self->prorate_setup($cust_pkg, $sdate);
121 if (!$cust_pkg->waive_setup) {
123 my $count = $self->option( 'additional_count', 'quiet' ) || 0;
124 while ($i < $count) {
125 push @$details, $self->option( 'additional_info' . $i++ );
128 my $charge = $self->base_setup($cust_pkg, $sdate, $details);
132 $param->{'setup_charge'} = $charge;
133 $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
134 delete $param->{'setup_charge'};
137 return sprintf( '%.2f', ($cust_pkg->quantity || 1) * ($charge - $discount) );
145 my($self, $cust_pkg, $sdate, $details ) = @_;
146 $self->option('setup_fee', 1) || 0;
151 my($cust_pkg, $sdate, $details, $param ) = @_;
153 #my $last_bill = $cust_pkg->last_bill;
154 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
157 if $self->recur_temporality eq 'preceding' && !$last_bill;
159 my $charge = $self->base_recur($cust_pkg, $sdate);
160 # always treat cutoff_day as a list
161 if ( my @cutoff_day = $self->cutoff_day($cust_pkg) ) {
162 $charge = $self->calc_prorate(@_, @cutoff_day);
164 elsif ( $param->{freq_override} ) {
165 # XXX not sure if this should be mutually exclusive with sync_bill_date.
166 # Given the very specific problem that freq_override is meant to 'solve',
167 # it probably should.
168 $charge *= $param->{freq_override} if $param->{freq_override};
171 $charge += $self->usageprice_recur($cust_pkg, $sdate);
172 $cust_pkg->apply_usageprice(); #$sdate for prorating?
174 my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
176 sprintf( '%.2f', ($cust_pkg->quantity || 1) * ($charge - $discount) );
181 my $cust_pkg = shift;
182 my $cust_main = $cust_pkg->cust_main;
183 # force it to act like a prorate package, is what this means
184 # because we made a distinction once between prorate and flat packages
185 if ( $cust_main->force_prorate_day and $cust_main->prorate_day ) {
186 return ( $cust_main->prorate_day );
188 if ( $self->option('sync_bill_date',1) ) {
189 my $next_bill = $cust_pkg->cust_main->next_bill_date;
191 return (localtime($next_bill))[3];
193 # This is the customer's only active package and hasn't been billed
194 # yet, so set the cutoff day to either today or tomorrow, whichever
195 # would result in a full period after rounding.
196 my $setup = $cust_pkg->setup; # because it's "now"
197 my $rounding_mode = $self->option('prorate_round_day',1);
198 return () if !$setup or !$rounding_mode;
199 my ($sec, $min, $hour, $mday, $mon, $year) = localtime($setup);
201 if ( ( $rounding_mode == 1 and $hour >= 12 )
202 or ( $rounding_mode == 3 and ( $sec > 0 or $min > 0 or $hour > 0 ))
204 # then the prorate period will be rounded down to start from
205 # midnight tomorrow, so the cutoff day should be the current day +
207 $setup = timelocal(59,59,23,$mday,$mon,$year) + 1;
208 $mday = (localtime($setup))[3];
210 # otherwise, it will be rounded up, so leave the cutoff day at today.
218 my($self, $cust_pkg, $sdate) = @_;
219 $self->option('recur_fee', 1) || 0;
222 sub base_recur_permonth {
223 my($self, $cust_pkg) = @_;
225 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
227 sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq );
230 sub usageprice_recur {
231 my($self, $cust_pkg, $sdate) = @_;
234 $recur += $_->price foreach $cust_pkg->cust_pkg_usageprice;
236 sprintf('%.2f', $recur);
241 if ( $self->recur_temporality eq 'preceding'
242 and $self->option('bill_recur_on_cancel', 1) ) {
243 # run another recurring cycle
244 return $self->calc_recur(@_);
245 } elsif ( $conf->exists('bill_usage_on_cancel') # should be a package option?
246 and $self->can('calc_usage') ) {
247 # bill for outstanding usage
248 return $self->calc_usage(@_);
250 return 'NOTHING'; # numerically zero, but has special meaning
254 # no longer used; see credit_remaining in FS::cust_pkg
257 my ($self, $cust_pkg, %options) = @_;
260 if ($options{'time'}) {
261 $time = $options{'time'};
266 my $next_bill = $cust_pkg->getfield('bill') || 0;
268 return 0 if ! $self->base_recur($cust_pkg, \$time)
270 || $next_bill < $time;
272 # Use actual charge for this period, not base_recur (for discounts).
273 # Use sdate < $time and edate >= $time because when billing on
274 # cancellation, edate = $time.
276 foreach my $cust_bill_pkg (
277 qsearch('cust_bill_pkg', {
278 pkgnum => $cust_pkg->pkgnum,
279 edate => {op => '>=', value => $time},
280 recur => {op => '>' , value => 0},
284 # hack to deal with the weird behavior of edate on package cancellation
285 my $edate = $cust_bill_pkg->edate;
286 if ( $self->recur_temporality eq 'preceding' ) {
287 $edate = $self->add_freq($cust_bill_pkg->sdate);
290 # this will also get any package charges that are _entirely_ after the
291 # cancellation date (can happen with advance billing). in that case,
292 # use the entire recurring charge:
293 my $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
295 # but if the cancellation happens during the interval, prorate it:
296 # (XXX obey prorate_round_day here?)
297 if ( $cust_bill_pkg->sdate < $time ) {
298 $amount = $amount * ($edate - $time) / ($edate - $cust_bill_pkg->sdate);
303 push @{ $options{'cust_credit_source_bill_pkg'} },
304 new FS::cust_credit_source_bill_pkg {
305 'billpkgnum' => $cust_bill_pkg->billpkgnum,
306 'amount' => sprintf('%.2f', $amount),
307 'currency' => $cust_bill_pkg->cust_bill->currency,
309 if $options{'cust_credit_source_bill_pkg'};
313 sprintf('%.2f', $credit);
317 sub is_free_options {
318 qw( setup_fee recur_fee );
321 sub is_prepaid { 0; } #no, we're postpaid
326 return 0 if $self->start_on_hold;
328 ! $self->option('start_1st', 1) && ( ! $self->option('sync_bill_date',1)
329 || ! $self->option('prorate_defer_bill',1)
330 || ! $opt{'num_ncancelled_pkgs'}
334 sub can_discount { 1; }
336 sub can_usageprice { 1; }
338 sub recur_temporality {
340 $self->option('recur_temporality', 1);
343 sub usage_valuehash {
345 map { $_, $self->option($_) }
346 grep { $self->option($_, 'hush') }
347 qw(seconds upbytes downbytes totalbytes);
351 my($self, $cust_pkg, %opt) = @_;
352 warn " resetting usage counters" if defined($opt{debug}) && $opt{debug} > 1;
353 my %values = $self->usage_valuehash;
354 if ($self->option('usage_rollover', 1)) {
355 $cust_pkg->recharge(\%values);
357 $cust_pkg->set_usage(\%values, %opt);