-
cancelItem
Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the 'cancelImmediately' property to true will start the cancellation immediately if the item is eligible to be canceled immediately.
The reason parameter could be from the list below: * 'No longer needed' * 'Business closing down' * 'Server / Upgrade Costs' * 'Migrating to larger server' * 'Migrating to smaller server' * 'Migrating to a different SoftLayer datacenter' * 'Network performance / latency' * 'Support response / timing' * 'Sales process / upgrades' * 'Moving to competitor'
-
cancelService
Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly.
-
cancelServiceOnAnniversaryDate
Cancel the resource or service for a billing Item
-
getAccount
The account that a billing item belongs to.
-
getActiveAgreement
-
getActiveAgreementFlag
A flag indicating that the billing item is under an active agreement.
-
getActiveAssociatedChildren
A billing item's active associated child billing items. This includes 'floating' items that are not necessarily child items of this billing item.
-
getActiveAssociatedGuestDiskBillingItems
-
getActiveBundledItems
A Billing Item's active bundled billing items.
-
getActiveCancellationItem
A service cancellation request item that corresponds to the billing item.
-
getActiveChildren
A Billing Item's active child billing items.
-
getActiveFlag
-
getActiveSparePoolAssociatedGuestDiskBillingItems
-
getActiveSparePoolBundledItems
A Billing Item's spare pool bundled billing items.
-
getAssociatedBillingItem
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.
-
getAssociatedBillingItemHistory
A history of billing items which a billing item has been associated with.
-
getAssociatedChildren
A Billing Item's associated child billing items. This includes 'floating' items that are not necessarily child billing items of this billing item.
-
getAssociatedParent
A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.
-
getAvailableMatchingVlans
-
getBandwidthAllocation
The bandwidth allocation for a billing item.
-
getBillableChildren
A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.
-
getBundledItems
A Billing Item's bundled billing items.
-
getCanceledChildren
A Billing Item's active child billing items.
-
getCancellationReason
The billing item's cancellation reason.
-
getCancellationRequests
This will return any cancellation requests that are associated with this billing item.
-
getCategory
The item category to which the billing item's item belongs.
-
getChildren
A Billing Item's child billing items'
-
getChildrenWithActiveAgreement
A Billing Item's active child billing items.
-
getDowngradeItems
For product items which have a downgrade path defined, this will return those product items.
-
getFilteredNextInvoiceChildren
A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.
-
getHourlyFlag
A flag that will reflect whether this billing item is billed on an hourly basis or not.
-
getInvoiceItem
Invoice items associated with this billing item
-
getInvoiceItems
All invoice items associated with the billing item
-
getItem
The entry in the SoftLayer product catalog that a billing item is based upon.
-
getLocation
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.
-
getNextInvoiceChildren
A Billing Item's child billing items and associated items'
-
getNextInvoiceTotalOneTimeAmount
A Billing Item's total, including any child billing items if they exist.'
-
getNextInvoiceTotalOneTimeTaxAmount
A Billing Item's total, including any child billing items if they exist.'
-
getNextInvoiceTotalRecurringAmount
A Billing Item's total, including any child billing items and associated billing items if they exist.'
-
getNextInvoiceTotalRecurringTaxAmount
This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.
-
getNonZeroNextInvoiceChildren
A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
getObject
getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are 'parent' billing items and 'child' billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered 'child' billing items.
-
getOrderItem
A billing item's original order item. Simply a reference to the original order from which this billing item was created.
-
getOriginalLocation
The original physical location for this billing item--may differ from current.
-
getPackage
The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.
-
getParent
A billing item's parent item. If a billing item has no parent item then this value is null.
-
getParentVirtualGuestBillingItem
A billing item's parent item. If a billing item has no parent item then this value is null.
-
getPendingCancellationFlag
This flag indicates whether a billing item is scheduled to be canceled or not.
-
getPendingOrderItem
The new order item that will replace this billing item.
-
getProvisionTransaction
Provisioning transaction for this billing item
-
getServiceBillingItemsByCategory
This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [SoftLayer_Security_Certificate_Request](/reference/datatypes/SoftLayer_Security_Certificate_Request) service.
In order to find billing items for cancellation, use [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service to retrieve category codes that are eligible for cancellation.
-
getSoftwareDescription
A friendly description of software component
-
getUpgradeItem
Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.
-
getUpgradeItems
Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.
-
removeAssociationId
Remove the association from a billing item.
-
setAssociationId
Set an associated billing item to an orphan billing item. Associations allow you to tie an 'orphaned' billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set.
-
SoftLayer_Billing_Item
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 [SoftLayer_Billing_Invoice](/reference/datatypes/SoftLayer_Billing_Invoice) 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.
-
SoftLayer_Billing_Item
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 [SoftLayer_Billing_Invoice](/reference/datatypes/SoftLayer_Billing_Invoice) 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.
-
voidCancelService
Void a previously made cancellation for a service