Billing
SoftLayer_Billing_Item_Virtual_DedicatedHost

Overview

Local Properties

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 & Count Properties

Relational Properties can be queried by object mask
account

The account that a billing item belongs to.

activeAgreement
activeAgreementFlag

A flag indicating that the billing item is under an active 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.

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:

unsignedLong

activeAssociatedGuestDiskBillingItemCount

A count of

Type:

unsignedLong

activeAssociatedGuestDiskBillingItems
activeBundledItemCount

A count of a Billing Item's active bundled billing items.

Type:

unsignedLong

activeBundledItems

A Billing Item's active bundled billing items.

activeCancellationItem

A service cancellation request item that corresponds to the billing item.

activeChildren

A Billing Item's active child billing items.

activeChildrenCount

A count of a Billing Item's active child billing items.

Type:

unsignedLong

activeFlag
Type:

boolean

activeSparePoolAssociatedGuestDiskBillingItemCount

A count of

Type:

unsignedLong

activeSparePoolAssociatedGuestDiskBillingItems
activeSparePoolBundledItemCount

A count of a Billing Item's spare pool bundled billing items.

Type:

unsignedLong

activeSparePoolBundledItems

A Billing Item's spare pool bundled billing items.

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.

associatedBillingItemHistory

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

associatedBillingItemHistoryCount

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

Type:

unsignedLong

associatedChildren

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

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:

unsignedLong

associatedParent

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

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:

unsignedLong

availableMatchingVlanCount

A count of

Type:

unsignedLong

availableMatchingVlans
bandwidthAllocation

The bandwidth allocation for a billing item.

billableChildren

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

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:

unsignedLong

bundledItemCount

A count of a Billing Item's bundled billing items'

Type:

unsignedLong

bundledItems

A Billing Item's bundled billing items'

bundleItemCount

A count of a Billing Item's bundled billing items

Type:

unsignedLong

bundleItems

A Billing Item's bundled billing items

canceledChildren

A Billing Item's active child billing items.

canceledChildrenCount

A count of a Billing Item's active child billing items.

Type:

unsignedLong

cancellationReason

The billing item's cancellation reason.

cancellationRequestCount

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

Type:

unsignedLong

cancellationRequests

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

category

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

children

A Billing Item's child billing items'

childrenCount

A count of a Billing Item's child billing items'

Type:

unsignedLong

childrenWithActiveAgreement

A Billing Item's active child billing items.

childrenWithActiveAgreementCount

A count of a Billing Item's active child billing items.

Type:

unsignedLong

downgradeItemCount

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

Type:

unsignedLong

downgradeItems

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

filteredNextInvoiceChildren

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

filteredNextInvoiceChildrenCount

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

Type:

unsignedLong

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

invoiceItemCount

A count of all invoice items associated with the billing item

Type:

unsignedLong

invoiceItems

All invoice items associated with the billing item

item

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

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.

nextInvoiceChildren

A Billing Item's child billing items and associated items'

nextInvoiceChildrenCount

A count of a Billing Item's child billing items and associated items'

Type:

unsignedLong

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.

nonZeroNextInvoiceChildrenCount

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

Type:

unsignedLong

orderItem

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

originalLocation

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

package

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

parent

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

parentVirtualGuestBillingItem

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

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.

provisionTransaction

Provisioning transaction for this billing item

resource

The resource for a virtual dedicated host billing item.

softwareDescription

A friendly description of software component

upgradeItem

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

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:

unsignedLong

upgradeItems

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