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 '.
74 'bill_recur_on_cancel' => {
75 'name' => 'Bill the last period on cancellation',
78 'bill_suspend_as_cancel' => {
79 'name' => 'Bill immediately upon suspension', #desc?
82 'externalid' => { 'name' => 'Optional External ID',
86 'fieldorder' => [ qw( recur_temporality
87 expire_months adjourn_months
90 sync_bill_date prorate_defer_bill prorate_round_day
91 suspend_bill unsuspend_adjust_bill
93 bill_suspend_as_cancel
102 my $conf = new FS::Conf;
103 my $money_char = $conf->config('money_char') || '$';
104 my $setup = $opt{cust_pkg} ? $self->base_setup( $opt{cust_pkg} )
105 : ($self->option('setup_fee') || 0);
106 my $recur = $opt{cust_pkg} ? $self->base_recur( $opt{cust_pkg} )
107 : ($self->option('recur_fee', 1) || 0);
108 $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);
122 my $count = $self->option( 'additional_count', 'quiet' ) || 0;
123 while ($i < $count) {
124 push @$details, $self->option( 'additional_info' . $i++ );
127 my $charge = $self->base_setup($cust_pkg, $sdate, $details);
131 $param->{'setup_charge'} = $charge;
132 $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
133 delete $param->{'setup_charge'};
136 sprintf( '%.2f', ($cust_pkg->quantity || 1) * ($charge - $discount) );
140 my($self, $cust_pkg, $sdate, $details ) = @_;
142 $self->option('setup_fee') || 0;
147 my($cust_pkg, $sdate, $details, $param ) = @_;
149 #my $last_bill = $cust_pkg->last_bill;
150 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
153 if $self->recur_temporality eq 'preceding' && !$last_bill;
155 my $charge = $self->base_recur($cust_pkg, $sdate);
156 # always treat cutoff_day as a list
157 if ( my @cutoff_day = $self->cutoff_day($cust_pkg) ) {
158 $charge = $self->calc_prorate(@_, @cutoff_day);
160 elsif ( $param->{freq_override} ) {
161 # XXX not sure if this should be mutually exclusive with sync_bill_date.
162 # Given the very specific problem that freq_override is meant to 'solve',
163 # it probably should.
164 $charge *= $param->{freq_override} if $param->{freq_override};
167 $charge += $self->usageprice_recur($cust_pkg, $sdate);
168 $cust_pkg->apply_usageprice(); #$sdate for prorating?
170 my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
172 sprintf( '%.2f', ($cust_pkg->quantity || 1) * ($charge - $discount) );
177 my $cust_pkg = shift;
178 if ( $self->option('sync_bill_date',1) ) {
179 my $next_bill = $cust_pkg->cust_main->next_bill_date;
180 if ( defined($next_bill) ) {
181 return (localtime($next_bill))[3];
188 my($self, $cust_pkg, $sdate) = @_;
189 $self->option('recur_fee', 1) || 0;
192 sub base_recur_permonth {
193 my($self, $cust_pkg) = @_;
195 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
197 sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq );
200 sub usageprice_recur {
201 my($self, $cust_pkg, $sdate) = @_;
204 $recur += $_->price foreach $cust_pkg->cust_pkg_usageprice;
206 sprintf('%.2f', $recur);
211 my $conf = new FS::Conf;
212 if ( $self->recur_temporality eq 'preceding'
213 and $self->option('bill_recur_on_cancel', 1) ) {
214 # run another recurring cycle
215 return $self->calc_recur(@_);
217 elsif ( $conf->exists('bill_usage_on_cancel') # should be a package option?
218 and $self->can('calc_usage') ) {
219 # bill for outstanding usage
220 return $self->calc_usage(@_);
226 my ($self, $cust_pkg, %options) = @_;
229 if ($options{'time'}) {
230 $time = $options{'time'};
235 my $next_bill = $cust_pkg->getfield('bill') || 0;
237 return 0 if ! $self->base_recur($cust_pkg, \$time)
239 || $next_bill < $time;
241 # Use actual charge for this period, not base_recur (for discounts).
242 # Use sdate < $time and edate >= $time because when billing on
243 # cancellation, edate = $time.
246 qsearch('cust_bill_pkg', {
247 pkgnum => $cust_pkg->pkgnum,
248 sdate => {op => '<' , value => $time},
249 edate => {op => '>=', value => $time},
250 recur => {op => '>' , value => 0},
253 # hack to deal with the weird behavior of edate on package cancellation
254 my $edate = $item->edate;
255 if ( $self->recur_temporality eq 'preceding' ) {
256 $edate = $self->add_freq($item->sdate);
258 $credit += ($item->recur - $item->usage) *
259 ($edate - $time) / ($edate - $item->sdate);
261 sprintf('%.2f', $credit);
262 #sprintf("%.2f", $self->base_recur($cust_pkg, \$time) * ( $next_bill - $time ) / $freq_sec );
266 sub is_free_options {
267 qw( setup_fee recur_fee );
270 sub is_prepaid { 0; } #no, we're postpaid
276 ! $self->option('start_1st', 1) && ( ! $self->option('sync_bill_date',1)
277 || ! $self->option('prorate_defer_bill',1)
278 || ! $opt{'num_ncancelled_pkgs'}
282 sub can_discount { 1; }
284 sub can_usageprice { 1; }
286 sub recur_temporality {
288 $self->option('recur_temporality', 1);
291 sub usage_valuehash {
293 map { $_, $self->option($_) }
294 grep { $self->option($_, 'hush') }
295 qw(seconds upbytes downbytes totalbytes);
299 my($self, $cust_pkg, %opt) = @_;
300 warn " resetting usage counters" if defined($opt{debug}) && $opt{debug} > 1;
301 my %values = $self->usage_valuehash;
302 if ($self->option('usage_rollover', 1)) {
303 $cust_pkg->recharge(\%values);
305 $cust_pkg->set_usage(\%values, %opt);