% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>
FS::cust_pkg_discount - Object methods for cust_pkg_discount records
use FS::cust_pkg_discount;
$record = new FS::cust_pkg_discount \%hash;
$record = new FS::cust_pkg_discount { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
An FS::cust_pkg_discount object represents the application of a discount to a customer package. FS::cust_pkg_discount inherits from FS::Record. The following fields are currently supported:
primary key
Customer package (see FS::cust_pkg)
Discount (see FS::discount)
months_used
end_date
order taker, see FS::access_user
Creates a new discount application. To add the record to the database, see "insert".
Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
Delete this record from the database.
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
Checks all fields to make sure this is a valid discount applciation. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Returns the customer package (see FS::cust_pkg).
Returns the discount (see FS::discount).
Increments months_used by the given parameter
Decrement months_used by the given parameter
(Note: as in, extending the length of the discount. Typically only used to stack/extend a discount when the customer package has one active already.)
FS::discount, FS::cust_pkg, FS::Record, schema.html from the base documentation.