Interface
public function getUuid(): stringRuntime unique id for cart item
Returns string
public function setId(?string $id): selfSet type prefixed product identifier
Parameters
| Type | Name | Description |
|---|---|---|
string|null | $id |
Returns self
public function getId(): ?stringGet prefixed product identifier
Returns string\|null
public function setName(string $name): selfSet description name
Parameters
| Type | Name | Description |
|---|---|---|
string | $name |
Returns self
public function getName(): stringGet description name
Returns string
public function setBillingCycle($billingCycle): selfSet billing cycle, such as free, onetime, monthly, quarterly, etc
Returns self
public function getBillingCycle(): stringGet billing cycle
Returns string
public function setBillingPeriod(string $billingPeriod): selfStart date for items that renew
Parameters
| Type | Name | Description |
|---|---|---|
string | $billingPeriod |
Returns self
public function getBillingPeriod(): intGet start date for items that renew
Returns int
public function setQuantity(int $qty): selfSet quantity for scaling quantity items
Parameters
| Type | Name | Description |
|---|---|---|
int | $qty |
Returns self
public function getQuantity(): intGet quantity for scaling quantity items
Returns int
public function setAmount(Price $amount): selfSet initial cost amount
Parameters
| Type | Name | Description |
|---|---|---|
Price | $amount |
Returns self
public function getAmount(): PriceGet Initial cost amount
Returns Price
public function setRecurringAmount(Price $recurring = null): selfSet recurring cost amount
Parameters
| Type | Name | Description |
|---|---|---|
Price|null | $recurring |
Returns self
public function getRecurringAmount(): ?PriceGet recurring cost amount
Returns Price\|null
public function setTaxed(bool $taxed): selfSet taxable status of item
Parameters
| Type | Name | Description |
|---|---|---|
bool | $taxed |
Returns self
public function isTaxed(): boolIs item taxable
Returns bool
public function setInitialPeriod(string $period, string $cycle): selfSet initial period in days for prorated item
Parameters
| Type | Name | Description |
|---|---|---|
string | $period | |
string | $cycle |
Returns self
public function hasInitialPeriod(): boolIf an initial period is defined (prorata)
Returns bool
public function isRecurring(): boolIf the item is a of a recurring cycle
Returns bool
public function getType(): stringItem type such as Product, Addon, Domain or generic Item
Returns string
public function getSetupAmount(): PriceThe setup amount
Returns Price
public function setSetupAmount(?Price $amount)Set the setup amount
Parameters
| Type | Name | Description |
|---|---|---|
Price|null | $amount |
public function getRecurringBasePrice(): PriceThe recurring base price without Tax or Setup fee
Returns Price
public function setRecurringBasePrice(?Price $amount)Set the base prince
Parameters
| Type | Name | Description |
|---|---|---|
Price|null | $amount |
public function getItemName(): stringItem's name without concatenated group's name
Returns string
public function setItemName(string $name)public function getItemGroupName(): stringItem's group name (without its name)
Returns string
public function setItemGroupName(string $groupName)public function getItemGroupId(): intpublic function setItemGroupId(int $groupId)public function getAmountExcludeTaxSetup(): PriceInitial cost without Tax and Setup fee
Returns Price
public function setAmountExcludeTaxSetup(?Price $price)public function isFree(): boolIf the cart item has free billing cycle
Returns bool