% 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::discount - Object methods for discount records
use FS::discount;
$record = new FS::discount \%hash;
$record = new FS::discount { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
An FS::discount object represents a discount definition. FS::discount inherits from FS::Record. The following fields are currently supported:
primary key
name
amount
percent
months
disabled
If the discount is based on a percentage, then the % will be applied to the setup and recurring portions.
Creates a new discount. To add the discount 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. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Returns a text description incorporating the amount, percent and months fields.
description_short omits term information
FS::cust_pkg_discount, FS::Record, schema.html from the base documentation.