Product
SoftLayer_Product_Item_Price

Overview

The SoftLayer_Product_Item_Price data type contains general information relating to a single SoftLayer product item price. You can find out what packages each price is in as well as which category under which this price is sold. All prices are returned in floating point values measured in US Dollars ($USD).

Local Properties

currentPriceFlag

This flag is used by the getUpgradeItems method to indicate if a product price is used for the current billing item.

Type:

boolean

hourlyRecurringFee

The hourly price for this item, should this item be part of an hourly pricing package.

Type:

decimal

id

The unique identifier of a Product Item Price.

Type:

integer

itemId

The unique identifier for a product Item

Type:

integer

laborFee

The labor fee for a product item price.

Type:

decimal

locationGroupId

The id of the SoftLayer_Location_Group_Pricing that this price is part of. If set to null, the price is considered a standard price, which can be used with any location when ordering.

During order verification and placement, if a standard price is used, that price may be replaced with a location based price, which does not have this property set to null. The location based price must be part of a SoftLayer_Location_Group_Pricing that has the location being ordered in order for this to happen.

Type:

integer

oneTimeFee

The one time fee for a product item price.

Type:

decimal

oneTimeFeeTax

A price's total tax amount of the one time fees (oneTimeFee, laborFee, and setupFee). This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder()

Type:

decimal

onSaleFlag

On sale flag.

Type:

boolean

orderOptions

Order options for the category that this price is associated with.

proratedRecurringFee

A recurring fee is a fee that happens every billing period. This fee is represented as a floating point decimal in US dollars ($USD).

Type:

decimal

proratedRecurringFeeTax

A price's tax amount of the recurring fee. This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder()

Type:

decimal

quantity
Type:

integer

recurringFee

A recurring fee is a fee that happens every billing period. This fee is represented as a floating point decimal in US dollars ($USD).

Type:

decimal

recurringFeeTax

A price's tax amount of the recurring fee. This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder()

Type:

decimal

setupFee

The setup fee associated with a product item price.

Type:

decimal

sort

Used for ordering items on sales orders.

Type:

integer

tierMinimumThreshold

The minimum threshold for which this tiered usage price begins to apply. The unit for the price is defined by the item to which this belongs, see SoftLayer_Product_Item::$units.

Type:

integer

usageRate

The rate for a usage based item

Type:

decimal

Relational & Count Properties

Relational Properties can be queried by object mask
accountRestrictionCount

A count of the account that the item price is restricted to.

Type:

unsignedLong

accountRestrictions

The account that the item price is restricted to.

attributeCount

A count of

Type:

unsignedLong

bigDataOsJournalDiskFlag

Whether the price is for Big Data OS/Journal disks only. (Deprecated)

Type:

boolean

bundleReferenceCount

A count of cross reference for bundles

Type:

unsignedLong

bundleReferences

cross reference for bundles

capacityRestrictionMaximum

The maximum capacity value for which this price is suitable.

Type:

string

capacityRestrictionMinimum

The minimum capacity value for which this price is suitable.

Type:

string

capacityRestrictionType

The type of capacity restriction by which this price must abide.

Type:

string

categories

All categories which this item is a member.

categoryCount

A count of all categories which this item is a member.

Type:

unsignedLong

dedicatedHostInstanceFlag

Signifies pricing that is only available on a dedicated host virtual server order.

Type:

boolean

definedSoftwareLicenseFlag

Whether this price defines a software license for its product item.

Type:

boolean

inventory

An item price's inventory status per datacenter.

inventoryCount

A count of an item price's inventory status per datacenter.

Type:

unsignedLong

item

The product item a price is tied to.

orderPremiumCount

A count of

Type:

unsignedLong

packageCount

A count of a price's packages under which this item is sold.

Type:

unsignedLong

packageReferenceCount

A count of cross reference for packages

Type:

unsignedLong

packageReferences

cross reference for packages

packages

A price's packages under which this item is sold.

presetConfigurationCount

A count of a list of preset configurations this price is used in.'

Type:

unsignedLong

presetConfigurations

A list of preset configurations this price is used in.'

priceType

The type keyname of this price which can be STANDARD or TIERED.

Type:

string

pricingLocationGroup

The pricing location group that this price is applicable for. Prices that have a pricing location group will only be available for ordering with the locations specified on the location group.

requiredCoreCount

The number of server cores required to order this item. This is deprecated. Use getCapacityRestrictionMinimum and getCapacityRestrictionMaximum

Type:

integer