SoftLayer_Billing_Item_Hardware_Colocation


SoftLayer_Billing_Item_Hardware_Colocation

Description

The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware.

Local


allowCancellationFlag

Flag to check if a billing item can be cancelled. 1 = yes. 0 = no.
Type: integer


associatedBillingItemId

This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling SoftLayer_Billing_Item::setAssociationId. This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set.
Type: string


cancellationDate

A billing item's cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle.
Type: dateTime


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


createDate

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


currentHourlyCharge

This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed.
Type: string


cycleStartDate

The last time this billing item was charged.
Type: dateTime


description

A brief description of a billing item.
Type: string


domainName

The domain name is provided for server billing items.
Type: string


hostName

The hostname is provided for server billing items
Type: string


hourlyRecurringFee

The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD).
Type: decimal


hoursUsed

This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped.
Type: string


id

The unique identifier for this billing item.
Type: integer


laborFee

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


laborFeeTaxRate

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


lastBillDate

The last time this billing item was charged.
Type: dateTime


modifyDate

The date that a billing item was last modified.
Type: dateTime


nextBillDate

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


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


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


oneTimeFeeTaxRate

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


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


parentId

The unique identifier of the parent of this billing item.
Type: integer


recurringFee

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


recurringFeeTaxRate

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


recurringMonths

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


resourceTableId

The resource (unique identifier) for a server billing item.
Type: integer


serviceProviderId

This is the service provider for this billing item.
Type: integer


setupFee

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


setupFeeTaxRate

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

Relational


account

The account that a billing item belongs to.
Type: SoftLayer_Account


activeAgreementFlag

A flag indicating that the billing item is under an active agreement.
Type: SoftLayer_Account_Agreement


activeAssociatedChildren

A billing item's active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item.
Type: SoftLayer_Billing_Item[]


activeBundledItems

A Billing Item's active bundled billing items.
Type: SoftLayer_Billing_Item[]


activeCancellationItem

A service cancellation request item that corresponds to the billing item.
Type: SoftLayer_Billing_Item_Cancellation_Request_Item


activeChildren

A Billing Item's active child billing items.
Type: SoftLayer_Billing_Item[]


activeFlag

Type: boolean


activeSparePoolBundledItems

A Billing Item's spare pool bundled billing items.
Type: SoftLayer_Billing_Item[]


associatedBillingItem

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.
Type: SoftLayer_Billing_Item


associatedBillingItemHistory

A history of billing items which a billing item has been associated with.
Type: SoftLayer_Billing_Item_Association_History[]


associatedChildren

A Billing Item's associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item.
Type: SoftLayer_Billing_Item[]


associatedParent

A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.
Type: SoftLayer_Billing_Item[]


bandwidthAllocation

The bandwidth allocation for a billing item.
Type: SoftLayer_Network_Bandwidth_Version1_Allocation


billableChildren

A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.
Type: SoftLayer_Billing_Item[]


billingCycleBandwidthUsage

The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
Type: SoftLayer_Network_Bandwidth_Usage[]


billingCyclePrivateBandwidthUsage

The raw private bandwidth usage data for the current billing cycle.
Type: SoftLayer_Network_Bandwidth_Usage[]


billingCyclePrivateUsageIn

The total private inbound bandwidth for this hardware for the current billing cycle.
Type: decimal


billingCyclePrivateUsageOut

The total private outbound bandwidth for this hardware for the current billing cycle.
Type: decimal


billingCyclePrivateUsageTotal

The total private bandwidth for this hardware for the current billing cycle.
Type: unsigned integer


billingCyclePublicBandwidthUsage

The raw public bandwidth usage data for the current billing cycle.
Type: SoftLayer_Network_Bandwidth_Usage[]


billingCyclePublicUsageIn

The total public inbound bandwidth for this hardware for the current billing cycle.
Type: decimal


billingCyclePublicUsageOut

The total public outbound bandwidth for this hardware for the current billing cycle.
Type: decimal


billingCyclePublicUsageTotal

The total public bandwidth for this hardware for the current billing cycle.
Type: unsigned integer


bundleItems

A Billing Item's bundled billing items
Type: SoftLayer_Product_Item_Bundles[]


bundledItems

A Billing Item's bundled billing items’
Type: SoftLayer_Billing_Item[]


canceledChildren

A Billing Item's active child billing items.
Type: SoftLayer_Billing_Item[]


cancellationReason

The billing item's cancellation reason.
Type: SoftLayer_Billing_Item_Cancellation_Reason


cancellationRequests

This will return any cancellation requests that are associated with this billing item.
Type: SoftLayer_Billing_Item_Cancellation_Request[]


category

The item category to which the billing item's item belongs.
Type: SoftLayer_Product_Item_Category


children

A Billing Item's child billing items’
Type: SoftLayer_Billing_Item[]


childrenWithActiveAgreement

A Billing Item's active child billing items.
Type: SoftLayer_Billing_Item[]


downgradeItems

For product items which have a downgrade path defined, this will return those product items.
Type: SoftLayer_Product_Item[]


filteredNextInvoiceChildren

A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.
Type: SoftLayer_Billing_Item[]


hourlyFlag

A flag that will reflect whether this billing item is billed on an hourly basis or not.
Type: boolean


invoiceItem

Invoice items associated with this billing item
Type: SoftLayer_Billing_Invoice_Item


invoiceItems

All invoice items associated with the billing item
Type: SoftLayer_Billing_Invoice_Item[]


item

The entry in the SoftLayer product catalog that a billing item is based upon.
Type: SoftLayer_Product_Item


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.
Type: SoftLayer_Location


lockboxNetworkStorage

A lockbox account associated with a server.
Type: SoftLayer_Billing_Item_Network_Storage


nextInvoiceChildren

A Billing Item's child billing items and associated items’
Type: SoftLayer_Billing_Item[]


nextInvoiceTotalOneTimeAmount

A Billing Item's total, including any child billing items if they exist.’
Type: float


nextInvoiceTotalOneTimeTaxAmount

A Billing Item's total, including any child billing items if they exist.’
Type: float


nextInvoiceTotalRecurringAmount

A Billing Item's total, including any child billing items and associated billing items if they exist.’
Type: float


nextInvoiceTotalRecurringTaxAmount

This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.
Type: float


nonZeroNextInvoiceChildren

A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.
Type: SoftLayer_Billing_Item[]


orderItem

A billing item's original order item. Simply a reference to the original order from which this billing item was created.
Type: SoftLayer_Billing_Order_Item


originalLocation

The original physical location for this billing item–may differ from current.
Type: SoftLayer_Location


package

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


parent

A billing item's parent item. If a billing item has no parent item then this value is null.
Type: SoftLayer_Billing_Item


parentVirtualGuestBillingItem

A billing item's parent item. If a billing item has no parent item then this value is null.
Type: SoftLayer_Billing_Item_Virtual_Guest


pendingCancellationFlag

This flag indicates whether a billing item is scheduled to be canceled or not.
Type: boolean


pendingOrderItem

The new order item that will replace this billing item.
Type: SoftLayer_Billing_Order_Item


provisionTransaction

Provisioning transaction for this billing item
Type: SoftLayer_Provisioning_Version1_Transaction


resource

The resource for a server billing item.
Type: SoftLayer_Hardware_Server


softwareDescription

A friendly description of software component
Type: SoftLayer_Software_Description


upgradeItem

Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.
Type: SoftLayer_Product_Item


upgradeItems

Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.
Type: SoftLayer_Product_Item[]

Count


activeAssociatedChildrenCount

A count of a billing item's active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item.
Type: unsigned long


activeAssociatedGuestDiskBillingItemCount

A count of
Type: unsigned long


activeBundledItemCount

A count of a Billing Item's active bundled billing items.
Type: unsigned long


activeChildrenCount

A count of a Billing Item's active child billing items.
Type: unsigned long


activeSparePoolBundledItemCount

A count of a Billing Item's spare pool bundled billing items.
Type: unsigned long


associatedBillingItemHistoryCount

A count of a history of billing items which a billing item has been associated with.
Type: unsigned long


associatedChildrenCount

A count of a Billing Item's associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item.
Type: unsigned long


associatedParentCount

A count of a billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.
Type: unsigned long


availableMatchingVlanCount

A count of
Type: unsigned long


billableChildrenCount

A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future.
Type: unsigned long


billingCycleBandwidthUsageCount

A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
Type: unsigned long


billingCyclePrivateBandwidthUsageCount

A count of the raw private bandwidth usage data for the current billing cycle.
Type: unsigned long


billingCyclePublicBandwidthUsageCount

A count of the raw public bandwidth usage data for the current billing cycle.
Type: unsigned long


bundleItemCount

A count of a Billing Item's bundled billing items
Type: unsigned long


bundledItemCount

A count of a Billing Item's bundled billing items’
Type: unsigned long


canceledChildrenCount

A count of a Billing Item's active child billing items.
Type: unsigned long


cancellationRequestCount

A count of this will return any cancellation requests that are associated with this billing item.
Type: unsigned long


childrenCount

A count of a Billing Item's child billing items’
Type: unsigned long


childrenWithActiveAgreementCount

A count of a Billing Item's active child billing items.
Type: unsigned long


downgradeItemCount

A count of for product items which have a downgrade path defined, this will return those product items.
Type: unsigned long


filteredNextInvoiceChildrenCount

A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.
Type: unsigned long


invoiceItemCount

A count of all invoice items associated with the billing item
Type: unsigned long


monitoringBillingItemCount

A count of
Type: unsigned long


nextInvoiceChildrenCount

A count of a Billing Item's child billing items and associated items’
Type: unsigned long


nonZeroNextInvoiceChildrenCount

A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.
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.
Type: unsigned long



© SoftLayer 2015
Built with Hugo