SoftLayer Billing Order Item
From SoftLayer Development Network Wiki
Overview
The SoftLayer_Billing_Order_Item datatype provides information regarding a single ordered item. When a server order or any other order is placed, the information about that order is stored as SoftLayer_Billing_Order_items.
This also provides information about software or hardware related to an ordered item,what package the item is in, and all pricing information related to this ordered item.
User Access
Users wishing to access the SoftLayer_Billing_Order_Item type must have the view account summary permission assigned to their account.
| Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties. |
Local Properties
categoryCode
the category code for an item.
- Type: string
- Length: 30 characters
description
friendly description of purchase item.
- Type: string
- Length: 200 characters
itemId
The SoftLayer_Product_Item ID for this order item.
- Type: integer
- Length: 10 digits
itemPriceId
the item price id (SoftLayer_Product_Item_Price->id) of the ordered item.
- Type: decimal
- Length: 8 digits before the decimal point
Relational Properties
billingItem
The SoftLayer_Billing_Item tied to the order item.
billingItem can be queried by object mask.
billingItem must be a unique value.
- Type: SoftLayer_Billing_Item
bundledItems
The other items included with an ordered item.
bundledItems can be queried by object mask.
- Type: SoftLayer_Billing_Order_ItemArray
category
The item category tied to an order item.
category can be queried by object mask.
category must be a unique value.
children
The child order items for an order item. All server order items should have children. These children are considered a part of the server.
children can be queried by object mask.
- Type: SoftLayer_Billing_Order_ItemArray
downgradeItems
This is an order item's downgrade items. Currently only used on additional services.
downgradeItems can be queried by object mask.
hardwareGenericComponent
The component type tied to an order item. All hardware-specific items should have a generic hardware component.
hardwareGenericComponent can be queried by object mask.
hardwareGenericComponent must be a unique value.
item
The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold.
item can be queried by object mask.
item must be a unique value.
- Type: SoftLayer_Product_Item
itemPrice
The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item.
itemPrice can be queried by object mask.
itemPrice must be a unique value.
location
The location of an ordered item. This is usually the same as the server it is being ordered with. Otherwise it describes the location of the additional service being ordered.
location can be queried by object mask.
location must be a unique value.
- Type: SoftLayer_Location
oldBillingItem
This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened.
oldBillingItem can be queried by object mask.
oldBillingItem must be a unique value.
- Type: SoftLayer_Billing_Item
order
The order two which this item belongs. The order contains all the information related to the items included in an order
order can be queried by object mask.
order must be a unique value.
- Type: SoftLayer_Billing_Order
package
The SoftLayer_Product_Package an order item is a part of.
package can be queried by object mask.
package must be a unique value.
parent
The parent order item ID for an item. Items that are associated with a server will have a parent. The parent will be the server item itself.
parent can be queried by object mask.
parent must be a unique value.
- Type: SoftLayer_Billing_Order_Item
redundantPowerSupplyCount
A count of power supplies contained within this SoftLayer_Billing_Order
redundantPowerSupplyCount can be queried by object mask.
redundantPowerSupplyCount must be a unique value.
- Type: unsigned integer
softwareDescription
For ordered items that are software items, a full description of that software can be found with this property.
softwareDescription can be queried by object mask.
softwareDescription must be a unique value.
totalRecurringAmount
The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis.
totalRecurringAmount can be queried by object mask.
totalRecurringAmount must be a unique value.
- Type: float
upgradeItem
The next SoftLayer_Product_Item in the upgrade path for this order item.
upgradeItem can be queried by object mask.
upgradeItem must be a unique value.
- Type: SoftLayer_Product_Item
upgradeItems
All the possible upgrade items available as a replacement for this order item.
upgradeItems can be queried by object mask.
Count Properties
bundledItemCount
A count of the other items included with an ordered item.
bundledItemCount must be a unique value.
- Type: unsigned long
childrenCount
A count of the child order items for an order item. All server order items should have children. These children are considered a part of the server.
childrenCount must be a unique value.
- Type: unsigned long
downgradeItemCount
A count of this is an order item's downgrade items. Currently only used on additional services.
downgradeItemCount must be a unique value.
- Type: unsigned long
upgradeItemCount
A count of all the possible upgrade items available as a replacement for this order item.
upgradeItemCount must be a unique value.
- Type: unsigned long
