Interface Item.Service
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- All Known Subinterfaces:
DedicatedHost.Service
- Enclosing class:
- Item
@ApiService("SoftLayer_Billing_Item") public static interface Item.Service extends Service
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|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.
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.
- See Also:
- SoftLayer_Billing_Item
-
Method Summary
Modifier and Type Method Description Item.ServiceAsync
asAsync()
Get an async version of this serviceBoolean
cancelItem(Boolean cancelImmediately, Boolean cancelAssociatedBillingItems, String reason, String customerNote)
Cancel the resource or service for a billing Item.Boolean
cancelService()
Cancel the resource or service (excluding bare metal servers) for a billing Item.Boolean
cancelServiceOnAnniversaryDate()
Cancel the resource or service for a billing ItemAccount
getAccount()
The account that a billing item belongs to.Agreement
getActiveAgreement()
Agreement
getActiveAgreementFlag()
A flag indicating that the billing item is under an active agreement.List<Item>
getActiveAssociatedChildren()
A billing item's active associated child billing items.List<Item>
getActiveAssociatedGuestDiskBillingItems()
List<Item>
getActiveBundledItems()
A Billing Item's active bundled billing items.Item
getActiveCancellationItem()
A service cancellation request item that corresponds to the billing item.List<Item>
getActiveChildren()
A Billing Item's active child billing items.Boolean
getActiveFlag()
List<Item>
getActiveSparePoolAssociatedGuestDiskBillingItems()
List<Item>
getActiveSparePoolBundledItems()
A Billing Item's spare pool bundled billing items.Item
getAssociatedBillingItem()
A billing item's associated parent.List<History>
getAssociatedBillingItemHistory()
A history of billing items which a billing item has been associated with.List<Item>
getAssociatedChildren()
A Billing Item's associated child billing items.List<Item>
getAssociatedParent()
A billing item's associated parent billing item.List<Vlan>
getAvailableMatchingVlans()
Allocation
getBandwidthAllocation()
The bandwidth allocation for a billing item.List<Item>
getBillableChildren()
A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.List<Item>
getBundledItems()
A Billing Item's bundled billing items'List<Bundles>
getBundleItems()
A Billing Item's bundled billing itemsList<Item>
getCanceledChildren()
A Billing Item's active child billing items.Reason
getCancellationReason()
The billing item's cancellation reason.List<Request>
getCancellationRequests()
This will return any cancellation requests that are associated with this billing item.Category
getCategory()
The item category to which the billing item's item belongs.List<Item>
getChildren()
A Billing Item's child billing items'List<Item>
getChildrenWithActiveAgreement()
A Billing Item's active child billing items.List<Item>
getDowngradeItems()
For product items which have a downgrade path defined, this will return those product items.List<Item>
getFilteredNextInvoiceChildren()
A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.Boolean
getHourlyFlag()
A flag that will reflect whether this billing item is billed on an hourly basis or not.Item
getInvoiceItem()
Invoice items associated with this billing itemList<Item>
getInvoiceItems()
All invoice items associated with the billing itemItem
getItem()
The entry in the SoftLayer product catalog that a billing item is based upon.Package
getItemPackage()
The package under which this billing item was sold.Location
getLocation()
The location of the billing item.List<Item>
getNextInvoiceChildren()
A Billing Item's child billing items and associated items'BigDecimal
getNextInvoiceTotalOneTimeAmount()
A Billing Item's total, including any child billing items if they exist.'BigDecimal
getNextInvoiceTotalOneTimeTaxAmount()
A Billing Item's total, including any child billing items if they exist.'BigDecimal
getNextInvoiceTotalRecurringAmount()
A Billing Item's total, including any child billing items and associated billing items if they exist.'BigDecimal
getNextInvoiceTotalRecurringTaxAmount()
This is deprecated and will always be zero.List<Item>
getNonZeroNextInvoiceChildren()
A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.Item
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.Item
getOrderItem()
A billing item's original order item.Location
getOriginalLocation()
The original physical location for this billing item--may differ from current.Item
getParent()
A billing item's parent item.Guest
getParentVirtualGuestBillingItem()
A billing item's parent item.Boolean
getPendingCancellationFlag()
This flag indicates whether a billing item is scheduled to be canceled or not.Item
getPendingOrderItem()
The new order item that will replace this billing item.Transaction
getProvisionTransaction()
Provisioning transaction for this billing itemList<Item>
getServiceBillingItemsByCategory(String categoryCode, Boolean includeZeroRecurringFee)
This service returns billing items of a specified category code.Description
getSoftwareDescription()
A friendly description of software componentItem
getUpgradeItem()
Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.List<Item>
getUpgradeItems()
Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.Boolean
removeAssociationId()
Remove the association from a billing item.Boolean
setAssociationId(Long associatedId)
Set an associated billing item to an orphan billing item.void
setMask(Item.Mask mask)
Boolean
voidCancelService()
Void a previously made cancellation for a serviceItem.Mask
withMask()
Use the existing mask on this service or create it if not presentItem.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return itMethods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
Method Details
-
asAsync
Item.ServiceAsync asAsync()Description copied from interface:Service
Get an async version of this service -
withNewMask
Item.Mask withNewMask()Description copied from interface:Maskable
Overwrite the existing mask on this service with a new one and return it- Specified by:
withNewMask
in interfaceMaskable
-
withMask
Item.Mask withMask()Description copied from interface:Maskable
Use the existing mask on this service or create it if not present -
setMask
-
cancelItem
@ApiMethod(instanceRequired=true) Boolean cancelItem(Boolean cancelImmediately, Boolean cancelAssociatedBillingItems, String reason, String customerNote)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"- See Also:
- SoftLayer_Billing_Item::cancelItem
-
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.- See Also:
- SoftLayer_Billing_Item::cancelService
-
cancelServiceOnAnniversaryDate
Cancel the resource or service for a billing Item -
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.- See Also:
- SoftLayer_Billing_Item::getObject
-
getServiceBillingItemsByCategory
@ApiMethod List<Item> getServiceBillingItemsByCategory(String categoryCode, Boolean includeZeroRecurringFee)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|service cancellation]] service.
In order to find billing items for cancellation, use [[SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories|product categories]] service to retrieve category codes that are eligible for cancellation. -
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.- See Also:
- SoftLayer_Billing_Item::setAssociationId
-
voidCancelService
Void a previously made cancellation for a service -
getAccount
The account that a billing item belongs to.- See Also:
- SoftLayer_Billing_Item::getAccount
-
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
- See Also:
- SoftLayer_Billing_Item::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. -
getBundleItems
A Billing Item's bundled billing items- See Also:
- SoftLayer_Billing_Item::getBundleItems
-
getBundledItems
A Billing Item's bundled billing items'- See Also:
- SoftLayer_Billing_Item::getBundledItems
-
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.- See Also:
- SoftLayer_Billing_Item::getCategory
-
getChildren
A Billing Item's child billing items'- See Also:
- SoftLayer_Billing_Item::getChildren
-
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.- See Also:
- SoftLayer_Billing_Item::getHourlyFlag
-
getInvoiceItem
Invoice items associated with this billing item- See Also:
- SoftLayer_Billing_Item::getInvoiceItem
-
getInvoiceItems
All invoice items associated with the billing item- See Also:
- SoftLayer_Billing_Item::getInvoiceItems
-
getItem
The entry in the SoftLayer product catalog that a billing item is based upon.- See Also:
- SoftLayer_Billing_Item::getItem
-
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.- See Also:
- SoftLayer_Billing_Item::getLocation
-
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. -
getOrderItem
A billing item's original order item. Simply a reference to the original order from which this billing item was created.- See Also:
- SoftLayer_Billing_Item::getOrderItem
-
getOriginalLocation
The original physical location for this billing item--may differ from current. -
getItemPackage
The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.- See Also:
- SoftLayer_Billing_Item::getItemPackage
-
getParent
A billing item's parent item. If a billing item has no parent item then this value is null.- See Also:
- SoftLayer_Billing_Item::getParent
-
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 -
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.- See Also:
- SoftLayer_Billing_Item::getUpgradeItem
-
getUpgradeItems
Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.- See Also:
- SoftLayer_Billing_Item::getUpgradeItems
-