SoftLayer_Product_Item_Price


SoftLayer_Product_Item_Price

Description

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


currentPriceFlag

This flag is used by the getUpgradeItemPrices methods available on various resources 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: int


itemId

The unique identifier for a product Item
Type: int


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 SoftLayer_Product_Order::verifyOrder and SoftLayer_Product_Order::placeOrder, 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: int


onSaleFlag

On sale flag.
Type: boolean


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


orderOptions

Order options for the category that this price is associated with.
Type: SoftLayer_Product_Item_Category_Order_Option_Type[]


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

None
Type: int


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: int


termLength

The number of months a term lasts for a term-based price
Type: int


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: int


usageRate

The rate for a usage based item
Type: decimal

Relational


accountRestrictions

The account that the item price is restricted to.
Type: SoftLayer_Product_Item_Price_Account_Restriction[]


bareMetalReservedCapacityFlag

Signifies pricing that is only available on a bare metal reserved capacity order.
Type: boolean


bigDataOsJournalDiskFlag

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


bundleReferences

cross reference for bundles
Type: SoftLayer_Product_Item_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.
Type: SoftLayer_Product_Item_Category[]


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


eligibilityStrategy

Eligibility strategy to assess if a customer can order using this price.
Type: string


item

The product item a price is tied to.
Type: SoftLayer_Product_Item


packageReferences

cross reference for packages
Type: SoftLayer_Product_Package_Item_Prices[]


packages

A price’s packages under which this item is sold.
Type: SoftLayer_Product_Package[]


presetConfigurations

A list of preset configurations this price is used in.'
Type: SoftLayer_Product_Package_Preset_Configuration[]


priceType

The type keyname of this price which can be STANDARD, TIERED, or TERM.
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.
Type: SoftLayer_Location_Group_Pricing


requiredCoreCount

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


reservedCapacityInstanceFlag

Signifies pricing that is only available on a reserved capacity virtual server order.
Type: boolean

Count


accountRestrictionCount

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


attributeCount

A count of
Type: unsignedLong


bundleReferenceCount

A count of cross reference for bundles
Type: unsignedLong


categoryCount

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


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


presetConfigurationCount

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