FS/FS/part_pkg/recur_Common.pm

   1 package FS::part_pkg::recur_Common;
   2
   3 use strict;
   4 use base qw( FS::part_pkg::flat );
   5 use vars qw( %info %recur_method );
   6 use Tie::IxHash;
   7 use Time::Local;
   8
   9 %info = ( 'disabled' => 1 ); #recur_Common not a usable price plan directly
  10
  11 tie %recur_method, 'Tie::IxHash',
  12   'anniversary'  => 'Charge the recurring fee at the frequency specified above',
  13   'prorate'      => 'Charge a prorated fee the first time (selectable billing date)',
  14   'subscription' => 'Charge the full fee for the first partial period (selectable billing date)',
  15 ;
  16
  17 sub base_recur {
  18   my $self = shift;
  19   $self->option('recur_fee', 1) || 0;
  20 }
  21
  22 sub calc_setup {
  23   # moved from all descendant packages which just had $self->option('setup_fee')
  24   my($self, $cust_pkg, $sdate, $details, $param) = @_;
  25   return 0 if $self->prorate_setup($cust_pkg, $sdate);
  26   $self->option('setup_fee');
  27 }
  28
  29 sub cutoff_day {
  30   # prorate/subscription only; we don't support sync_bill_date here
  31   my $self = shift;
  32   my $cust_pkg = shift;
  33   my $recur_method = $self->option('recur_method',1) || 'anniversary';
  34   if ( $recur_method eq 'prorate' or $recur_method eq 'subscription' ) {
  35     return $self->option('cutoff_day',1) || 1;
  36   } else {
  37     return 0;
  38   }
  39 }
  40
  41 sub calc_recur_Common {
  42   my $self = shift;
  43   my($cust_pkg, $sdate, $details, $param ) = @_; #only need $sdate & $param
  44
  45   my $charges = 0;
  46
  47   if ( $param->{'increment_next_bill'} ) {
  48
  49     my $recur_method = $self->option('recur_method', 1) || 'anniversary';
  50     my $cutoff_day = $self->cutoff_day($cust_pkg);
  51
  52     $charges = $self->base_recur;
  53     $charges += $param->{'override_charges'} if $param->{'override_charges'};
  54
  55     if ( $recur_method eq 'prorate' ) {
  56
  57       $charges = $self->calc_prorate(@_, $cutoff_day);
  58       $charges += $param->{'override_charges'} if $param->{'override_charges'};
  59
  60     } elsif ( $recur_method eq 'subscription' ) {
  61
  62       my ($day, $mon, $year) = ( localtime($$sdate) )[ 3..5 ];
  63
  64       if ( $day < $cutoff_day ) {
  65         if ( $mon == 0 ) { $mon=11; $year--; }
  66         else { $mon--; }
  67       }
  68
  69       $$sdate = timelocal(0, 0, 0, $cutoff_day, $mon, $year);
  70
  71     }#$recur_method
  72
  73     $charges -= $self->calc_discount( $cust_pkg, $sdate, $details, $param );
  74
  75   }#increment_next_bill
  76
  77   return $charges;
  78
  79 }
  80
  81 1;