Billing
SoftLayer_Billing_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.

Methods

Cancel a service or resource.

Cancel a service or resource immediately. This does not include bare metal servers.

Cancel a service or resource on the next bill date

Retrieve the account that a billing item belongs to.

Retrieve a flag indicating that the billing item is under an active agreement.

Retrieve a billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item.

Retrieve a Billing Item's active bundled billing items.

Retrieve a service cancellation request item that corresponds to the billing item.

Retrieve a Billing Item's active child billing items.

Retrieve a Billing Item's spare pool bundled billing items.

Retrieve a billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item.

Retrieve a history of billing items which a billing item has been associated with.

Retrieve a Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item.

Retrieve a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.

Retrieve the bandwidth allocation for a billing item.

Retrieve a billing item's recurring child items that have once been billed and are scheduled to be billed in the future.

Retrieve a Billing Item's bundled billing items'

Retrieve a Billing Item's bundled billing items

Retrieve a Billing Item's active child billing items.

Retrieve the billing item's cancellation reason.

Retrieve this will return any cancellation requests that are associated with this billing item.

Retrieve the item category to which the billing item's item belongs.

Retrieve a Billing Item's child billing items'

Retrieve a Billing Item's active child billing items.

Retrieve for product items which have a downgrade path defined, this will return those product items.

Retrieve a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.

Retrieve a flag that will reflect whether this billing item is billed on an hourly basis or not.

Retrieve invoice items associated with this billing item

Retrieve all invoice items associated with the billing item

Retrieve the entry in the SoftLayer product catalog that a billing item is based upon.

Retrieve 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.

Retrieve a Billing Item's child billing items and associated items'

Retrieve a Billing Item's total, including any child billing items if they exist.'

Retrieve a Billing Item's total, including any child billing items if they exist.'

Retrieve a Billing Item's total, including any child billing items and associated billing items if they exist.'

Retrieve this is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.

Retrieve a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.

Retrieve a SoftLayer_Billing_Item record.

Retrieve a billing item's original order item. Simply a reference to the original order from which this billing item was created.

Retrieve the original physical location for this billing item--may differ from current.

Retrieve the package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.

Retrieve a billing item's parent item. If a billing item has no parent item then this value is null.

Retrieve a billing item's parent item. If a billing item has no parent item then this value is null.

Retrieve this flag indicates whether a billing item is scheduled to be canceled or not.

Retrieve the new order item that will replace this billing item.

Retrieve provisioning transaction for this billing item

Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.

Retrieve a friendly description of software component

Retrieve billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.

Retrieve billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.

Remove an association from an orphan billing item.

Set the associated billing item for an orphan billing item.

Void a service cancellation that was previously made.