SoftLayer Billing Item

From SoftLayer Development Network Wiki

Jump to: navigation, search

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

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.

Endpoints

SOAP WSDL http://api.service.softlayer.com/soap/v3/SoftLayer_Billing_Item?wsdl
XML-RPC http://api.service.softlayer.com/xmlrpc/v3/SoftLayer_Billing_Item

Methods

getAccount

Retrieve the account that a billing item belongs to.

  • returns
SoftLayer_Account
  • parameters
None


getActiveBundledItems

Retrieve a Billing Item's active bundled billing items.

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getActiveChildren

Retrieve a Billing Item's active child billing items.

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getBundleItems

Retrieve a Billing Item's bundled billing items

  • returns
SoftLayer_Product_Item_BundlesArray
  • parameters
None


getBundledItems

Retrieve a Billing Item's bundled billing items'

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getCanceledChildren

Retrieve a Billing Item's active child billing items.

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getCategory

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

  • returns
SoftLayer_Product_Item_Category
  • parameters
None


getChildren

Retrieve a Billing Item's child billing items'

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getDowngradeItems

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

  • returns
SoftLayer_Product_ItemArray
  • parameters
None


getInvoiceItem

Retrieve invoice items associated with this billing item

  • returns
SoftLayer_Billing_Invoice_Item
  • parameters
None


getItem

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

  • returns
SoftLayer_Product_Item
  • parameters
None


getLocation

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.

  • returns
SoftLayer_Location
  • parameters
None


getNextInvoiceChildren

Retrieve a Billing Item's child billing items'

  • returns
SoftLayer_Billing_ItemArray
  • parameters
None


getNextInvoiceTotalOneTimeAmount

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

  • returns
float
  • parameters
None


getNextInvoiceTotalOneTimeTaxAmount

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

  • returns
float
  • parameters
None


getNextInvoiceTotalRecurringAmount

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

  • returns
float
  • parameters
None


getNextInvoiceTotalRecurringTaxAmount

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

  • returns
float
  • parameters
None


getObject

Retrieve a SoftLayer_Billing_Item record.

  • returns
SoftLayer_Billing_Item
  • parameters
None


getOrderItem

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

  • returns
SoftLayer_Billing_Order_Item
  • parameters
None


getOriginalLocation

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

  • returns
SoftLayer_Location
  • parameters
None


getPackage

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

  • returns
SoftLayer_Product_Package
  • parameters
None


getParent

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

  • returns
SoftLayer_Billing_Item
  • parameters
None


getProvisionTransaction

Retrieve provisioning transaction for this billing item

  • returns
SoftLayer_Provisioning_Version1_Transaction
  • parameters
None


getSoftwareDescription

Retrieve a friendly description of software component

  • returns
SoftLayer_Software_Description
  • parameters
None


getUpgradeItem

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

  • returns
SoftLayer_Product_Item
  • parameters
None


getUpgradeItems

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

  • returns
SoftLayer_Product_ItemArray
  • parameters
None
Retrieved from "http://sldn.softlayer.com/wiki/index.php/SoftLayer_Billing_Item"
Personal tools