1. interface
  2. WHMCS
  3. Cart
  4. Item
  5. ItemInterface

ItemInterface

interface ItemInterface

Methods summary

Return Type Method Name Description
string getUuid() Runtime unique id for cart item
ItemInterface setId(string|null $id) Set type prefixed product identifier
string|null getId() Get prefixed product identifier
ItemInterface setName(string $name) Set description name
string getName() Get description name
ItemInterface setBillingCycle($billingCycle) Set billing cycle, such as free, onetime, monthly, quarterly, etc
string getBillingCycle() Get billing cycle
ItemInterface setBillingPeriod(string $billingPeriod) Start date for items that renew
string|null getBillingPeriod() Get start date for items that renew
ItemInterface setQuantity(int $qty) Set quantity for scaling quantity items
int|null getQuantity() Get quantity for scaling quantity items
ItemInterface setAmount(Price $amount) Set initial cost amount
Price getAmount() Get Initial cost amount
ItemInterface setRecurringAmount(Price $recurring = null) Set recurring cost amount
Price|null getRecurringAmount() Get recurring cost amount
ItemInterface setTaxed(bool $taxed) Set taxable status of item
bool isTaxed() Is item taxable
ItemInterface setInitialPeriod(string $period, string $cycle) Set initial period in days for prorated item
bool hasInitialPeriod() If an initial period is defined (prorata)
bool isRecurring() If the item is a of a recurring cycle
string getType() Item type such as Product, Addon, Domain or generic Item

Details

string getUuid ()

Runtime unique id for cart item

Return Value

string

ItemInterface setId (string|null $id)

Set type prefixed product identifier

Parameters

string|null $id

Return Value

ItemInterface

string|null getId ()

Get prefixed product identifier

Return Value

string|null

ItemInterface setName (string $name)

Set description name

Parameters

string $name

Return Value

ItemInterface

string getName ()

Get description name

Return Value

string

ItemInterface setBillingCycle ($billingCycle)

Set billing cycle, such as free, onetime, monthly, quarterly, etc

Parameters

$billingCycle

Return Value

ItemInterface

string getBillingCycle ()

Get billing cycle

Return Value

string

ItemInterface setBillingPeriod (string $billingPeriod)

Start date for items that renew

Parameters

string $billingPeriod

Return Value

ItemInterface

string|null getBillingPeriod ()

Get start date for items that renew

Return Value

string|null

ItemInterface setQuantity (int $qty)

Set quantity for scaling quantity items

Parameters

int $qty

Return Value

ItemInterface

int|null getQuantity ()

Get quantity for scaling quantity items

Return Value

int|null

ItemInterface setAmount (Price $amount)

Set initial cost amount

Parameters

Price $amount

Return Value

ItemInterface

Price getAmount ()

Get Initial cost amount

Return Value

Price

ItemInterface setRecurringAmount (Price $recurring = null)

Set recurring cost amount

Parameters

Price $recurring

Return Value

ItemInterface

Price|null getRecurringAmount ()

Get recurring cost amount

Return Value

Price|null

ItemInterface setTaxed (bool $taxed)

Set taxable status of item

Parameters

bool $taxed

Return Value

ItemInterface

bool isTaxed ()

Is item taxable

Return Value

bool

ItemInterface setInitialPeriod (string $period, string $cycle)

Set initial period in days for prorated item

Parameters

string $period
string $cycle

Return Value

ItemInterface

bool hasInitialPeriod ()

If an initial period is defined (prorata)

Return Value

bool

bool isRecurring ()

If the item is a of a recurring cycle

Return Value

bool

string getType ()

Item type such as Product, Addon, Domain or generic Item

Return Value

string