SoftLayer Billing Item (type)

From SoftLayer Development Network Wiki

Jump to: navigation, search

This page refers to the SoftLayer_Billing_Item data type. For information on the SoftLayer_Billing_Item service please see SoftLayer_Billing_Item.

Contents

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.

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 of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance.

  • Type: string
  • Length: 50 characters


createDate

The date the billing item was created. You can see this date on the invoice.


description

A brief description of a billing item.

  • Type: string
  • Length: 200 characters


domainName

The domain name is provided for server billing items.

  • Type: string
  • Length: 100 characters


hostName

The hostname is provided for server billing items

  • Type: string
  • Length: 100 characters


id

The unique identifier for this billing item.

  • Type: integer


laborFee

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

  • Type: decimal
  • Length: 6 digits before the decimal point


laborFeeTaxRate

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

  • Type: decimal
  • Length: 1 digits before the decimal point


lastBillDate

The last time this billing item was charged.


nextBillDate

The date on which your account will be charged for this billing item.


notes

Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of.

  • Type: string
  • Length: 200 characters


oneTimeFee

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

  • Type: decimal
  • Length: 6 digits before the decimal point


oneTimeFeeTaxRate

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

  • Type: decimal
  • Length: 1 digits before the decimal point


orderItemId

the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created.

  • Type: integer
  • Length: 10 digits


recurringFee

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

  • Type: decimal
  • Length: 6 digits before the decimal point


recurringFeeTaxRate

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

  • Type: decimal
  • Length: 1 digits before the decimal point


recurringMonths

The number of months in which the recurring fees will be incurred.

  • Type: integer
  • Length: 3 digits
  • Permission: Type Description


setupFee

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

  • Type: decimal
  • Length: 6 digits before the decimal point


setupFeeTaxRate

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

  • Type: decimal
  • Length: 1 digits before the decimal point


Relational Properties

account

The account that a billing item belongs to.
account can be queried by object mask.
account must be a unique value.


activeBundledItems

A Billing Item's active bundled billing items.
activeBundledItems can be queried by object mask.

  • Type: SoftLayer_Billing_ItemArray


activeChildren

A Billing Item's active child billing items.
activeChildren can be queried by object mask.

  • Type: SoftLayer_Billing_ItemArray


bundleItems

A Billing Item's bundled billing items
bundleItems can be queried by object mask.


bundledItems

A Billing Item's bundled billing items'
bundledItems can be queried by object mask.

  • Type: SoftLayer_Billing_ItemArray


canceledChildren

A Billing Item's active child billing items.
canceledChildren can be queried by object mask.

  • Type: SoftLayer_Billing_ItemArray


category

The item category to which the billing item's item belongs.
category can be queried by object mask.
category must be a unique value.


children

A Billing Item's child billing items'
children can be queried by object mask.

  • Type: SoftLayer_Billing_ItemArray


downgradeItems

For product items which have a downgrade path defined, this will return those product items.
downgradeItems can be queried by object mask.


invoiceItem

Invoice items associated with this billing item
invoiceItem can be queried by object mask.
invoiceItem must be a unique value.


item

The entry in the SoftLayer product catalog that a billing item is based upon.
item can be queried by object mask.
item must be a unique value.


location

The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information.
location can be queried by object mask.
location must be a unique value.


nextInvoiceChildren

A Billing Item's child billing items'
nextInvoiceChildren can be queried by object mask.

  • Type: SoftLayer_Billing_ItemArray


nextInvoiceTotalOneTimeAmount

A Billing Item's total, including any child billing items if they exist.'
nextInvoiceTotalOneTimeAmount can be queried by object mask.
nextInvoiceTotalOneTimeAmount must be a unique value.

  • Type: float


nextInvoiceTotalOneTimeTaxAmount

A Billing Item's total, including any child billing items if they exist.'
nextInvoiceTotalOneTimeTaxAmount can be queried by object mask.
nextInvoiceTotalOneTimeTaxAmount must be a unique value.

  • Type: float


nextInvoiceTotalRecurringAmount

A Billing Item's total, including any child billing items if they exist.'
nextInvoiceTotalRecurringAmount can be queried by object mask.
nextInvoiceTotalRecurringAmount must be a unique value.

  • Type: float


nextInvoiceTotalRecurringTaxAmount

A Billing Item's total, including any child billing items if they exist.'
nextInvoiceTotalRecurringTaxAmount can be queried by object mask.
nextInvoiceTotalRecurringTaxAmount must be a unique value.

  • Type: float


orderItem

A billing item's original order item. Simply a reference to the original order from which this billing item was created.
orderItem can be queried by object mask.
orderItem must be a unique value.


originalLocation

The original physical location for this billing item--may differ from current.
originalLocation can be queried by object mask.
originalLocation must be a unique value.


package

The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.
package can be queried by object mask.
package must be a unique value.


parent

A billing item's parent item. If a billing item has no parent item then this value is null.
parent can be queried by object mask.
parent must be a unique value.


provisionTransaction

Provisioning transaction for this billing item
provisionTransaction can be queried by object mask.
provisionTransaction must be a unique value.


softwareDescription

A friendly description of software component
softwareDescription can be queried by object mask.
softwareDescription must be a unique value.


upgradeItem

Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.
upgradeItem can be queried by object mask.
upgradeItem must be a unique value.


upgradeItems

Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.
upgradeItems can be queried by object mask.


Count Properties

activeBundledItemCount

A count of a Billing Item's active bundled billing items.
activeBundledItemCount must be a unique value.

  • Type: unsigned long


activeChildrenCount

A count of a Billing Item's active child billing items.
activeChildrenCount must be a unique value.

  • Type: unsigned long


bundleItemCount

A count of a Billing Item's bundled billing items
bundleItemCount must be a unique value.

  • Type: unsigned long


bundledItemCount

A count of a Billing Item's bundled billing items'
bundledItemCount must be a unique value.

  • Type: unsigned long


canceledChildrenCount

A count of a Billing Item's active child billing items.
canceledChildrenCount must be a unique value.

  • Type: unsigned long


childrenCount

A count of a Billing Item's child billing items'
childrenCount must be a unique value.

  • Type: unsigned long


downgradeItemCount

A count of for product items which have a downgrade path defined, this will return those product items.
downgradeItemCount must be a unique value.

  • Type: unsigned long


nextInvoiceChildrenCount

A count of a Billing Item's child billing items'
nextInvoiceChildrenCount must be a unique value.

  • Type: unsigned long


upgradeItemCount

A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.
upgradeItemCount must be a unique value.

  • Type: unsigned long

Associated Methods

See Also

Retrieved from "http://sldn.softlayer.com/wiki/index.php/SoftLayer_Billing_Item_%28type%29"
Personal tools