Billing
SoftLayer_Billing_Order_Item

Overview

Every individual item that a SoftLayer customer is billed for is recorded in the SoftLayer_Billing_Item data type. Billing items range from server chassis to hard drives to control panels, bandwidth quota upgrades and port upgrade charges. Softlayer invoices are generated from the cost of a customer's billing items. Billing items are copied from the product catalog as they're ordered by customers to create a reference between an account and the billable items they own.

Billing items exist in a tree relationship. Items are associated with each other by parent/child relationships. Component items such as CPU's, RAM, and software each have a parent billing item for the server chassis they're associated with. Billing Items with a null parent item do not have an associated parent item.

Local Properties

categoryCode

The category code for the order item.

Type:

string

description

friendly description of purchase item.

Type:

string

domainName

The domain name of the server as designated by the purchaser at the time of order placement.

Type:

string

hostName

The hostname of the server as designated by the purchaser at the time of order placement.

Type:

string

hourlyRecurringFee

The amount of money charged per hourly for an order item, if applicable, and only if it was ordered this day. hourlyRecurringFee is measured in US Dollars ($USD).

Type:

decimal

id
Type:

integer

itemId

The SoftLayer_Product_Item ID for this order item.

Type:

integer

itemPriceId

the item price id (SoftLayer_Product_Item_Price->id) of the ordered item.

Type:

decimal

laborAfterTaxAmount

An order item's labor fee total after taxes. This does not include any child invoice items.

Type:

decimal

laborFee

The labor fee, if any. This is a one time charge.

Type:

decimal

laborFeeTaxRate

The rate at which labor fees are taxed if you are a taxable customer.

Type:

decimal

laborTaxAmount

An order item's labor tax amount. This does not include any child invoice items.

Type:

decimal

oneTimeAfterTaxAmount

An order item's one-time fee total after taxes. This does not include any child invoice items.

Type:

decimal

oneTimeFee

The amount of money charged as a one-time charge for an order item, if applicable. oneTimeFee is measured in US Dollars ($USD).

Type:

decimal

oneTimeFeeTaxRate

The rate at which one time fees are taxed if you are a taxable customer.

Type:

decimal

oneTimeTaxAmount

An order item's one-time tax amount. This does not include any child invoice items.

Type:

decimal

parentId
Type:

integer

presetId

The id for the preset configuration ordered.

Type:

integer

promoCodeId
Type:

integer

quantity

the quantity of the ordered item in a quote.

Type:

integer

recurringAfterTaxAmount

An order item's recurring fee total after taxes. This does not include any child invoice items.

Type:

decimal

recurringFee

The amount of money charged per month for an order item, if applicable. recurringFee is measured in US Dollars ($USD).

Type:

decimal

recurringTaxAmount

An order item's recurring tax amount. This does not include any child invoice items.

Type:

decimal

setupAfterTaxAmount

An order item's setup fee total after taxes. This does not include any child invoice items.

Type:

decimal

setupFee

The setup fee, if any. This is a one time charge.

Type:

decimal

setupFeeDeferralMonths

The month set up fee deferral.

Type:

integer

setupFeeTaxRate

The rate at which setup fees are taxed if you are a taxable customer.

Type:

decimal

setupTaxAmount

An order item's setup tax amount. This does not include any child invoice items.

Type:

decimal

Relational & Count Properties

Relational Properties can be queried by object mask
billingItem

The SoftLayer_Billing_Item tied to the order item.

bundledItemCount

A count of the other items included with an ordered item.

Type:

unsignedLong

bundledItems

The other items included with an ordered item.

category

The item category tied to an order item.

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.

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.

Type:

unsignedLong

globalIdentifier

A hardware's universally unique identifier.

Type:

string

hardwareGenericComponent

The component type tied to an order item. All hardware-specific items should have a generic hardware component.

item

The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold.

itemCategoryAnswerCount

A count of this is an item's category answers.

Type:

unsignedLong

itemCategoryAnswers

This is an item's category answers.

itemPrice

The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item.

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.

nextOrderChildren
nextOrderChildrenCount

A count of

Type:

unsignedLong

oldBillingItem

This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened.

order

The order to which this item belongs. The order contains all the information related to the items included in an order

orderApprovalDate
Type:

dateTime

package

The SoftLayer_Product_Package an order item is a part of.

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.

preset

The SoftLayer_Product_Package_Preset related to this order item.

redundantPowerSupplyCount

A count of power supplies contained within this SoftLayer_Billing_Order

Type:

unsigned integer

softwareDescription

For ordered items that are software items, a full description of that software can be found with this property.

storageGroupCount

A count of the drive storage groups that are attached to this billing order item.

Type:

unsignedLong

storageGroups

The drive storage groups that are attached to this billing order item.

totalRecurringAmount

The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis.

Type:

float

upgradeItem

The next SoftLayer_Product_Item in the upgrade path for this order item.