Freeside:3:Documentation:Developer/FS/cust pkg usageprice
From Freeside
Contents
NAME
FS::cust_pkg_usageprice - Object methods for cust_pkg_usageprice records
SYNOPSIS
use FS::cust_pkg_usageprice;
$record = new FS::cust_pkg_usageprice \%hash;
$record = new FS::cust_pkg_usageprice { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
DESCRIPTION
An FS::cust_pkg_usageprice object represents an specific customer package usage pricing add-on. FS::cust_pkg_usageprice inherits from FS::Record. The following fields are currently supported:
- usagepricenum
- primary key
- pkgnum
- pkgnum
- usagepricepart
- usagepricepart
- quantity
- quantity
METHODS
- new HASHREF
- Creates a new record. 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.
- insert
- Adds this record to the database. If there is an error, returns the error, otherwise returns false.
- delete
- Delete this record from the database.
- replace OLD_RECORD
- Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
- check
- Checks all fields to make sure this is a valid record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
- price
- Returns the price for this customer usage pricing add-on (quantity of this record multiplied by price of the associated FS::part_pkg_usageprice record)
- apply
- Applies this customer usage pricing add-on. (Mulitplies quantity of this record by part_pkg_usageprice.amount, and applies to to any services of this package matching part_pkg_usageprice.target)
- If there is an error, returns the error, otherwise returns false.
