Items with tag billing

    article

    go

    java

    perl

    php

    python

    reference

    • approveModifiedOrder
      When an order has been modified, the customer will need to approve the changes. This method will allow the customer to approve the changes.
    • 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'
    • 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.
    • 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
    • cancelServiceOnAnniversaryDate
      Cancel the resource or service for a billing Item
    • claim
      This method is used to transfer an anonymous quote to the active user and associated account. An anonymous quote is one that was created by a user without being authenticated. If a quote was created anonymously and then the customer attempts to access that anonymous quote via the API (which requires authentication), the customer will be unable to retrieve the quote due to the security restrictions in place. By providing the ability for a customer to claim a quote, s/he will be able to pull the anonymous quote onto his/her account and successfully view the quote. To claim a quote, both the quote id and the quote key (the 32-character random string) must be provided.
    • claim
      This method is used to transfer an anonymous quote to the active user and associated account. An anonymous quote is one that was created by a user without being authenticated. If a quote was created anonymously and then the customer attempts to access that anonymous quote via the API (which requires authentication), the customer will be unable to retrieve the quote due to the security restrictions in place. By providing the ability for a customer to claim a quote, s/he will be able to pull the anonymous quote onto his/her account and successfully view the quote. To claim a quote, both the quote id and the quote key (the 32-character random string) must be provided.
    • createCart
      When creating a new cart, the order data is sent through SoftLayer_Product_Order::verifyOrder to make sure that the cart contains valid data. If an issue is found with the order, an exception will be thrown and you will receive the same response as if SoftLayer_Product_Order::verifyOrder were called directly. Once the order verification is complete, the cart will be created. The response is the new cart id.
    • createObject
      This method creates a service cancellation request. You need to have 'Cancel Services' privilege to create a cancellation request. You have to provide at least one SoftLayer_Billing_Item_Cancellation_Request_Item in the 'items' property. Make sure billing item's category code belongs to the cancelable product codes. You can retrieve the cancelable product category by the [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service.
    • deleteCart
      If a cart is no longer needed, it can be deleted using this service. Once a cart has been deleted, it cannot be retrieved again.
    • deleteQuote
      Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order.
    • deleteQuote
      Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order.
    • emailInvoices
      Create a transaction to email PDF and/or Excel invoice links to the requesting user's email address. You must have a PDF reader installed in order to view these files.
    • getAccount
      The SoftLayer customer account associated with this billing information.
    • getAccount
      The account that an invoice belongs to.
    • getAccount
      The account that a billing item belongs to.
    • getAccount
      The SoftLayer account that a service cancellation request belongs to.
    • getAccount
      The account that a billing item belongs to.
    • getAccount
      The [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) to which an order belongs.
    • getAccount
      A quote's corresponding account.
    • getAccount
      A quote's corresponding account.
    • getAchInformation
    • getActiveAgreement
    • getActiveAgreement
    • getActiveAgreementFlag
      A flag indicating that the billing item is under an active agreement.
    • 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.
    • 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
    • getActiveAssociatedGuestDiskBillingItems
    • getActiveBundledItems
      A Billing Item's active bundled billing items.
    • getActiveBundledItems
      A Billing Item's active bundled billing items.
    • getActiveCancellationItem
      A service cancellation request item that corresponds to the billing item.
    • getActiveCancellationItem
      A service cancellation request item that corresponds to the billing item.
    • getActiveChildren
      A Billing Item's active child billing items.
    • getActiveChildren
      A Billing Item's active child billing items.
    • getActiveFlag
    • getActiveFlag
    • getActiveSparePoolAssociatedGuestDiskBillingItems
    • getActiveSparePoolAssociatedGuestDiskBillingItems
    • getActiveSparePoolBundledItems
      A Billing Item's spare pool bundled billing items.
    • getActiveSparePoolBundledItems
      A Billing Item's spare pool bundled billing items.
    • getAllCancellationReasonCategories
      getAllCancellationReasonCategories() retrieves a list of all cancellation reason categories
    • getAllCancellationReasons
      getAllCancellationReasons() retrieves a list of all cancellation reasons that a server/service may be assigned to.
    • getAllCancellationRequests
      This method returns all service cancellation requests. Make sure to include the 'resultLimit' in the SOAP request header for quicker response. If there is no result limit header is passed, it will return the latest 25 results by default.
    • getAllCurrencyExchangeRates
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
      This will get all billing orders for your account.
    • getAmount
      This is the amount of this invoice.
    • 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.
    • 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.
    • getAssociatedBillingItemHistory
      A history of billing items which a billing item has been associated with.
    • getAssociatedChildren
      An Invoice Item's associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.
    • getAssociatedChildren
      A Billing Item's associated child billing items. This includes 'floating' items that are not necessarily child billing items of this billing item.
    • getAssociatedChildren
      A Billing Item's associated child billing items. This includes 'floating' items that are not necessarily child billing items of this billing item.
    • getAssociatedChildren
      A Billing Item's associated child billing items. This includes 'floating' items that are not necessarily child billing items of this billing item.
    • getAssociatedInvoiceItem
      An Invoice Item's associated invoice item. If this is populated, it means this is an orphaned invoice item, but logically belongs to the associated invoice 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.
    • 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
    • getAvailableMatchingVlans
    • getBandwidthAllocation
      The bandwidth allocation for a billing item.
    • 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.
    • getBillableChildren
      A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.
    • getBillingCancellationReasonCategory
      An billing cancellation reason category.
    • getBillingCancellationReasons
      The corresponding billing cancellation reasons having the specific billing cancellation reason category.
    • getBillingItem
      An Invoice Item's billing item, from which this item was generated.
    • getBillingItem
      The SoftLayer_Billing_Item tied to the order item.
    • getBillingItems
      The corresponding billing items having the specific cancellation reason.
    • getBrand
    • getBrandAtInvoiceCreation
    • getBundledItems
      A Billing Item's bundled billing items.
    • getBundledItems
      A Billing Item's bundled billing items.
    • getBundledItems
      The other items included with an ordered item.
    • getCanceledChildren
      A Billing Item's active child billing items.
    • getCanceledChildren
      A Billing Item's active child billing items.
    • getCancellationCutoffDate
      Services can be canceled 2 or 3 days prior to your next bill date. This service returns the time by which a cancellation request submission is permitted in the current billing cycle. If the current time falls into the cut off date, this will return next earliest cancellation cut off date. Available category codes are: service, server
    • getCancellationReason
      The billing item's cancellation reason.
    • getCancellationReason
      The billing item's cancellation reason.
    • getCancellationRequests
      This will return any cancellation requests that are associated with this billing item.
    • getCancellationRequests
      This will return any cancellation requests that are associated with this billing item.
    • getCart
      A cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices. Not all orders will have a cart associated with them. See [SoftLayer_Billing_Order_Cart](/reference/datatypes/SoftLayer_Billing_Order_Cart) for more information.
    • getCartByCartKey
      Retrieve a valid cart record of a SoftLayer order.
    • getCategory
      This invoice item's 'item category'.
    • getCategory
      The item category to which the billing item's item belongs.
    • getCategory
      The item category to which the billing item's item belongs.
    • getCategory
      The item category tied to an order item.
    • getChargebackType
      Chargeback type for invoice.
    • getChildren
      An Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children.
    • getChildren
      A Billing Item's child billing items'
    • getChildren
      A Billing Item's child billing items'
    • getChildren
      The child order items for an order item. All server order items should have children. These children are considered a part of the server.
    • getChildrenWithActiveAgreement
      A Billing Item's active child billing items.
    • getChildrenWithActiveAgreement
      A Billing Item's active child billing items.
    • getCoreRestrictedItems
      The [SoftLayer_Billing_Order_Item](/reference/datatypes/SoftLayer_Billing_Order_Item) that are core restricted
    • getCountriesWithListOfEligibleCurrencies
      Get map between countries and what currencies can be supported for customers in that country.
    • getCreditCardTransactions
      All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.
    • getCurrencies
    • getCurrency
      Currency to be used by this customer account.
    • getCurrentBillingCycle
      Information related to an account's current and previous billing cycles.
    • getCurrentExchangeRate
      The current exchange rate
    • getDetailedPdfGeneratedFlag
      A flag that will reflect whether the detailed version of the pdf has been generated.
    • getDiscountingInvoiceItemId
      The invoice item ID from which the discount is derived.
    • getDoNotContactFlag
      Indicates whether the owner of the quote chosen to no longer be contacted.
    • getDoNotContactFlag
      Indicates whether the owner of the quote chosen to no longer be contacted.
    • getDowngradeItems
      For product items which have a downgrade path defined, this will return those product items.
    • getDowngradeItems
      For product items which have a downgrade path defined, this will return those product items.
    • getDPart
      This is the DPart for invoice item.
    • getExcel
      Retrieve a Microsoft Excel spreadsheet of a SoftLayer invoice. You must have a Microsoft Excel reader installed in order to view these invoice files.
    • getExcel
      Return an account's next invoice in a Microsoft excel format.
    • getExchangeRate
    • getExchangeRate
    • getFilteredAssociatedChildren
      An Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.
    • getFilteredNextInvoiceChildren
      A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.
    • getFilteredNextInvoiceChildren
      A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.
    • getFundingCurrency
    • getGlobalIdentifier
      A hardware's universally unique identifier.
    • getHardwareGenericComponent
      The component type tied to an order item. All hardware-specific items should have a generic hardware component.
    • getHourlyFlag
      Indicating whether this invoice item is billed on an hourly basis.
    • getHourlyFlag
      A flag that will reflect whether this billing item is billed on an hourly basis or not.
    • getHourlyFlag
      A flag that will reflect whether this billing item is billed on an hourly basis or not.
    • getInitialInvoice
    • getInvoice
      The invoice to which this item belongs.
    • getInvoiceItem
      Invoice items associated with this billing item
    • getInvoiceItem
      Invoice items associated with this billing item
    • getInvoiceItems
      All invoice items associated with the billing item
    • getInvoiceItems
      All invoice items associated with the billing item
    • getInvoiceTopLevelItems
      A list of top-level invoice items that are on the currently pending invoice.
    • getInvoiceTotalAmount
      The total amount of this invoice.
    • getInvoiceTotalOneTimeAmount
      The total one-time charges for this invoice. This is the sum of one-time charges + setup fees + labor fees. This does not include taxes.
    • getInvoiceTotalOneTimeTaxAmount
      A sum of all the taxes related to one time charges for this invoice.
    • getInvoiceTotalPreTaxAmount
      The total amount of this invoice. This does not include taxes.
    • getInvoiceTotalRecurringAmount
      The total Recurring amount of this invoice. This amount does not include taxes or one time charges.
    • getInvoiceTotalRecurringTaxAmount
      The total amount of the recurring taxes on this invoice.
    • getItem
      The entry in the SoftLayer product catalog that a billing item is based upon.
    • getItem
      The entry in the SoftLayer product catalog that a billing item is based upon.
    • getItem
      The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold.
    • getItemCategoryAnswers
      This is an item's category answers.
    • getItemPrice
      The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item.
    • getItems
      The items that belong to this invoice.
    • getItems
      A collection of service cancellation items.
    • getItems
      The SoftLayer_Billing_Order_items included in an order.
    • getLastBillDate
      The date on which an account was last billed.
    • getLocalCurrency
    • getLocalCurrencyExchangeRate
      Exchange rate used for billing this invoice.
    • getLocation
      An invoice item's location, if one exists.'
    • 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.
    • 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.
    • getLocation
      The location of an ordered item. This is usually the same as the server it is being ordered with. Otherwise it describes the location of the additional service being ordered.
    • getNextBillDate
      The date on which an account will be billed next.
    • getNextInvoiceChildren
      A Billing Item's child billing items and associated items'
    • 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.'
    • 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.'
    • 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.'
    • 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.
    • 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.
    • getNextOrderChildren
    • getNonZeroAssociatedChildren
      An Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.
    • getNonZeroNextInvoiceChildren
      A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.
    • getNonZeroNextInvoiceChildren
      A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.
    • getObject
      Retrieve a SoftLayer_Billing_Currency record.
    • getObject
      Retrieve a SoftLayer_Billing_Currency_Country record.
    • getObject
      Retrieve a SoftLayer_Billing_Currency_ExchangeRate record.
    • getObject
      getObject retrieves the SoftLayer_Billing_Info object whose data corresponds to the account to which your portal user is tied.
    • getObject
      getObject retrieves the SoftLayer_Billing_Invoice object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Invoice service. You can only retrieve invoices that are assigned to your portal user's account.
    • getObject
      getObject retrieves the SoftLayer_Billing_Invoice_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Invoice_Item service. You can only retrieve the items tied to the account that your portal user is assigned to.
    • getObject
      Retrieve a SoftLayer_Billing_Invoice_Tax_Status record.
    • getObject
      Retrieve a SoftLayer_Billing_Invoice_Tax_Type record.
    • 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.
    • getObject
      Retrieve a SoftLayer_Billing_Item_Cancellation_Reason record.
    • getObject
      Retrieve a SoftLayer_Billing_Item_Cancellation_Reason_Category record.
    • getObject
      getObject retrieves the SoftLayer_Billing_Item_Cancellation_Request object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item_Cancellation_Request service. You can only retrieve cancellation request records that are assigned to your SoftLayer account.
    • getObject
      Retrieve a SoftLayer_Billing_Item_Chronicle record.
    • getObject
      Retrieve a SoftLayer_Billing_Item_Virtual_DedicatedHost record.
    • getObject
      getObject retrieves the SoftLayer_Billing_Order object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Order service. You can only retrieve orders that are assigned to your portal user's account.
    • getObject
      Retrieve a SoftLayer_Billing_Order_Cart record.
    • 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.
    • getObject
      getObject retrieves the SoftLayer_Billing_Order_Quote object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Order_Quote service. You can only retrieve quotes that are assigned to your portal user's account.
    • getOldBillingItem
      This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened.
    • getOrder
      This order contains the records for which products were selected for this quote.
    • getOrder
      The order to which this item belongs. The order contains all the information related to the items included in an order
    • getOrder
      This order contains the records for which products were selected for this quote.
    • getOrderApprovalDate
    • getOrderApprovalDate
    • getOrderItem
      A billing item's original order item. Simply a reference to the original order from which this billing item was created.
    • getOrderItem
      A billing item's original order item. Simply a reference to the original order from which this billing item was created.
    • getOrderNonServerMonthlyAmount
      An order's non-server items total monthly fee.
    • getOrderServerMonthlyAmount
      An order's server items total monthly fee.
    • getOrdersFromQuote
      These are all the orders that were created from this quote.
    • getOrdersFromQuote
      These are all the orders that were created from this quote.
    • getOrderStatuses
      Get a list of [SoftLayer_Container_Billing_Order_Status](/reference/datatypes/SoftLayer_Container_Billing_Order_Status) objects.
    • getOrderTopLevelItems
      An order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI.
    • getOrderTotalAmount
      This amount represents the order's initial charge including set up fee and taxes.
    • getOrderTotalOneTime
      An order's total one time amount summing all the set up fees, the labor fees and the one time fees. Taxes will be applied for non-tax-exempt. This amount represents the initial fees that will be charged.
    • getOrderTotalOneTimeAmount
      An order's total one time amount. This amount represents the initial fees before tax.
    • getOrderTotalOneTimeTaxAmount
      An order's total one time tax amount. This amount represents the tax that will be applied to the total charge, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.
    • getOrderTotalRecurring
      An order's total recurring amount. Taxes will be applied for non-tax-exempt. This amount represents the fees that will be charged on a recurring (usually monthly) basis.
    • getOrderTotalRecurringAmount
      An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis.
    • getOrderTotalRecurringTaxAmount
      The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.
    • getOrderTotalSetupAmount
      An order's total setup fee.
    • getOrderType
      The type of an order. This lets you know where this order was generated from.
    • getOriginalLocation
      The original physical location for this billing item--may differ from current.
    • 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.
    • getPackage
      The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.
    • getPackage
      The SoftLayer_Product_Package an order item is a part of.
    • getParent
      Every item tied to a server should have a parent invoice item which is the server line item. This is how we associate items to a server.
    • getParent
      A billing item's parent item. If a billing item has no parent item then this value is null.
    • getParent
      A billing item's parent item. If a billing item has no parent item then this value is null.
    • getParent
      The parent order item ID for an item. Items that are associated with a server will have a parent. The parent will be the server item itself.
    • getParentVirtualGuestBillingItem
      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.
    • getPayment
      This is the total payment made on this invoice.
    • getPayments
      The payments for the invoice.
    • getPaypalTransactions
      All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.
    • getPdf
      Retrieve a PDF record of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these invoice files.
    • getPdf
      Return an account's next invoice in PDF format.
    • getPdf
      Retrieve a PDF record of a SoftLayer quote. If the order is not a quote, an error will be thrown.
    • getPdf
      Retrieve a PDF copy of the cart.
    • getPdf
      Retrieve a PDF record of a SoftLayer quoted order. SoftLayer keeps PDF records of all quoted orders for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these quoted order files.
    • getPdfDetailed
      Retrieve a PDF record of a SoftLayer detailed invoice summary. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these files.
    • getPdfDetailed
      Return an account's next invoice detailed portion in PDF format.
    • getPdfDetailedFilename
      Get the name of the detailed version of the PDF.
    • getPdfFilename
    • getPdfFilename
      Retrieve the default filename of an order PDF.
    • getPdfFileSize
      Retrieve the size of a PDF record of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API.
    • getPendingCancellationFlag
      This flag indicates whether a billing item is scheduled to be canceled or not.
    • 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.
    • getPendingOrderItem
      The new order item that will replace this billing item.
    • getPreliminaryExcel
      Retrieve a Microsoft Excel record of a SoftLayer invoice. SoftLayer generates Microsoft Excel records of all closed invoices for customer retrieval from the portal and API. You must have a Microsoft Excel reader installed in order to view these invoice files.
    • getPreliminaryPdf
      Retrieve a PDF record of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these invoice files.
    • getPreliminaryPdfDetailed
      Retrieve a PDF record of the detailed version of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API.
    • getPresaleEvent
    • getPreset
      The SoftLayer_Product_Package_Preset related to this order item.
    • getPrice
    • getPrice
    • getProduct
      The entry in the product catalog that a invoice item is based upon.
    • getProduct
      The entry in the product catalog that the underlying billing item is based on.
    • getPromoCode
    • getProvisionTransaction
      Provisioning transaction for this billing item
    • getProvisionTransaction
      Provisioning transaction for this billing item
    • getQuote
      The quote of an order. This quote holds information about its expiration date, creation date, name and status. This information is tied to an order having the status 'QUOTE'
    • getQuoteByQuoteKey
      This method will return a [SoftLayer_Billing_Order_Quote](/reference/datatypes/SoftLayer_Billing_Order_Quote) that is identified by the quote key specified. If you do not have access to the quote or it does not exist, an exception will be thrown indicating so.
    • getQuoteByQuoteKey
      This method will return a [SoftLayer_Billing_Order_Quote](/reference/datatypes/SoftLayer_Billing_Order_Quote) that is identified by the quote key specified. If you do not have access to the quote or it does not exist, an exception will be thrown indicating so.
    • getRecalculatedOrderContainer
      Generate an [SoftLayer_Container_Product_Order](/reference/datatypes/SoftLayer_Container_Product_Order) from a billing order. This will take into account promotions, reseller status, estimated taxes and all other standard order verification processes.
    • getRecalculatedOrderContainer
      This method allows the customer to retrieve a saved cart and put it in a format that's suitable to be sent to SoftLayer_Billing_Order_Cart::createCart to create a new cart or to SoftLayer_Billing_Order_Cart::updateCart to update an existing cart.
    • getRecalculatedOrderContainer
      Generate an [SoftLayer_Container_Product_Order](/reference/datatypes/SoftLayer_Container_Product_Order) from the previously-created quote. This will take into account promotions, reseller status, estimated taxes and all other standard order verification processes.
    • getReceipt
      Generate a [SoftLayer_Container_Product_Order_Receipt](/reference/datatypes/SoftLayer_Container_Product_Order_Receipt) object with all the order information.
    • getRedundantPowerSupplyCount
      A count of power supplies contained within this SoftLayer_Billing_Order
    • getReferralPartner
      The Referral Partner who referred this order. (Only necessary for new customer orders)
    • getResource
      The resource for a virtual dedicated host billing item.
    • getSellerRegistration
      This is the seller's tax registration.
    • 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.
    • 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
    • getSoftwareDescription
      A friendly description of software component
    • getSoftwareDescription
      For ordered items that are software items, a full description of that software can be found with this property.
    • getStatus
      The status of a service cancellation request.
    • getStorageGroups
      The drive storage groups that are attached to this billing order item.
    • getTaxInfo
      This is the tax information that applies to tax auditing. This is the official tax record for this invoice.
    • getTaxInfoHistory
      This is the set of tax information for any tax calculation for this invoice. Note that not all of these are necessarily official, so use the taxInfo key to get the final information.
    • getTaxMessage
      This is a message explaining the tax treatment for this invoice.
    • getTaxType
      This is the strategy used to calculate tax on this invoice.
    • getTicket
      The ticket that is associated with the service cancellation request.
    • getTopLevelProductGroupName
      A string representing the name of parent level product group of an invoice item.
    • getTotalOneTimeAmount
      An invoice Item's total, including any child invoice items if they exist.
    • getTotalOneTimeTaxAmount
      An invoice Item's total, including any child invoice items if they exist.
    • getTotalRecurringAmount
      An invoice Item's total, including any child invoice items if they exist.
    • getTotalRecurringAmount
      The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis.
    • getTotalRecurringTaxAmount
      A Billing Item's total, including any child billing items if they exist.'
    • getTranslatedReason
    • getUpgradeItem
      Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.
    • getUpgradeItem
      Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.
    • getUpgradeItem
      The next SoftLayer_Product_Item in the upgrade path for this order 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.
    • getUpgradeItems
      Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.
    • getUpgradeRequestFlag
      This flag indicates an order is an upgrade.
    • getUsageChargeFlag
      Indicating whether this invoice item is for the usage charge.
    • getUser
      The user that initiated a service cancellation request.
    • getUserRecord
      The SoftLayer_User_Customer object tied to an order.
    • getXlsFilename
    • getZeroFeeItemCounts
    • isPendingEditApproval
      When an order has been modified, it will contain a status indicating so. This method checks that status and also verifies that the active user's account is the same as the account on the order.
    • placeOrder
      Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval.
    • placeOrder
      Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval.
    • placeQuote
      Use this method for placing server quotes and additional services quotes. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server quotes. In addition to verifying the quote, placeQuote() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process.
    • placeQuote
      Use this method for placing server quotes and additional services quotes. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server quotes. In addition to verifying the quote, placeQuote() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process.
    • removeAssociationId
      Remove the association from a billing item.
    • removeAssociationId
      Remove the association from a billing item.
    • removeCancellationItem
      This method removes a cancellation item from a cancellation request that is in 'Pending' or 'Approved' status.
    • saveQuote
      Account master users and sub-users in the SoftLayer customer portal can save the quote of an order to avoid its deletion after 5 days or its expiration after 2 days.
    • saveQuote
      Account master users and sub-users in the SoftLayer customer portal can save the quote of an order to avoid its deletion after 5 days or its expiration after 2 days.
    • 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.
    • 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_Chargeback_Type
    • SoftLayer_Billing_Currency
    • SoftLayer_Billing_Currency
    • SoftLayer_Billing_Currency_Country
      The SoftLayer_Billing_Currency_Country data type maps what currencies are valid for specific countries. US Dollars are valid from any country, but other currencies are only available to customers in certain countries.
    • SoftLayer_Billing_Currency_Country
      The SoftLayer_Billing_Currency_Country service provides information about what currencies a customer in a specific country is eligible to use.
    • SoftLayer_Billing_Currency_ExchangeRate
    • SoftLayer_Billing_Currency_ExchangeRate
    • SoftLayer_Billing_Info
      Every SoftLayer customer account has billing specific information which is kept in the SoftLayer_Billing_Info data type. This information is used by the SoftLayer accounting group when sending invoices and making billing inquiries.
    • SoftLayer_Billing_Info
      SoftLayer billing info contains company billing information such as the last date a payment was made and the last time any billing information was update. Use the data returned by these methods with other API services to get more detailed information about your billing information. Due to the sensitivity of your billing information we don't allow changing this data through the API. Please open a sales ticket in our customer portal if you need to change this information.
    • SoftLayer_Billing_Info_Ach
    • SoftLayer_Billing_Info_Cycle
      The SoftLayer_Billing_Info_Cycle data type models basic information concerning a SoftLayer account's previous and current billing cycles. The information in this class is only populated for SoftLayer customers who are billed monthly.
    • SoftLayer_Billing_Invoice
      The SoftLayer_Billing_Invoice data type contains general information relating to an individual invoice applied to a SoftLayer customer account. Personal information in this type such as names, addresses, and phone numbers are taken from the account's contact information at the time the invoice is generated.
    • SoftLayer_Billing_Invoice
      The SoftLayer_Billing_Invoice service controls the invoices that are created whenever a SoftLayer customer's account balance changes. Invoices exist in the following states: *'''OPEN''': Invoices which have not been paid yet. Invoices are created in the OPEN state. *'''CLOSED''': Invoices that SoftLayer has received payment for. *'''CLOSED_FAILED''': Invoices which were closed but were not paid for. Customers who are terminated for non-payment typically have invoices in this state. Once an invoice is paid it moves from OPEN to CLOSED state. Invoices are created under varying types, which are defined in the type property of the [SoftLayer_Invoice](/reference/datatypes/SoftLayer_Invoice). Invoices are created under one of the following type categories: *'''NEW''': An invoice for new service. A SoftLayer customer's first invoice is of the NEW type. *'''RECURRING''': Invoices that are generated on a SoftLayer customer's anniversary billing date for monthly services. *'''ONE-TIME-CHARGE''': Invoices that are generated when one-time charges are applied to an account for fees incurred from products or services procured outside of the standard purchasing processes. *'''CREDIT''': Invoices that are generated whenever SoftLayer applies a credit against an account's balance. *'''REFUND''': Account credits that are applied against a customer's account balance along with the receivables on their account. REFUND type invoices are generated whenever a customer receives a service credit on their account balance and has their invoice items changed due to the credit. *'''MANUAL_PAYMENT_CREDIT''': Invoice credits that are generated whenever a customer makes a manual payment. Invoices are created with contact information duplicated from the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account). We do this in order to maintain a history of an account's contact information as invoices are generated. Likewise each invoice record keeps track of an account's balance as the invoice is opened and closed. Query the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service to get a list of invoices for your account.
    • SoftLayer_Billing_Invoice_Item
      Each billing invoice item makes up a record within an invoice. This provides you with a detailed record of everything related to an invoice item. When you are billed, our system takes active billing items and creates an invoice. These invoice items are a copy of your active billing items, and make up the contents of your invoice.
    • SoftLayer_Billing_Invoice_Item
      Every invoice item is defined in the SoftLayer_Billing_Invoice_Item service. Softlayer billing invoice items have details about the items that reside within an invoice. These items detail, for instance, the recurring and one time charges for each item billed.
    • SoftLayer_Billing_Invoice_Item_Hardware
      The SoftLayer_Billing_Invoice_Item_Hardware data type contains a 'resource'. This resource is a link to the hardware tied to a SoftLayer_Billing_item whose category code is 'server'.
    • SoftLayer_Billing_Invoice_Item_Tax_Info
      Information about the tax rates that apply to a particular invoice item.
    • SoftLayer_Billing_Invoice_Next
      Service for an account's next invoice. The 'next invoice' is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges. Note, this should be considered preliminary as you may add, remove, or change billing items on your account.
    • SoftLayer_Billing_Invoice_Next
      Service for an account's next invoice. The 'next invoice' is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges. Note, this should be considered preliminary as you may add, remove, or change billing items on your account.
    • SoftLayer_Billing_Invoice_Receivable_Payment
      The SoftLayer_Billing_Invoice_Receivable_Payment data type contains general information relating to payments made against invoices.
    • SoftLayer_Billing_Invoice_Tax_Info
      Invoice tax information contains top-level information about the taxes recorded for a particular invoice.
    • SoftLayer_Billing_Invoice_Tax_Status
      The invoice tax status data type models a single status or state that an invoice can reflect in regard to an integration with a third-party tax calculation service.
    • SoftLayer_Billing_Invoice_Tax_Status
      Invoice tax status allows the SoftLayer system to track the status of an invoice if the related tax is being calculated by a third-party service. This allows us to know when tax has been calculated and applied successfully and when it has not.
    • SoftLayer_Billing_Invoice_Tax_Type
      The invoice tax type data type models a single strategy for handling tax calculations.
    • SoftLayer_Billing_Invoice_Tax_Type
      Invoice tax types allows the SoftLayer system to categorize the different strategies we use to calculate the tax for any invoice. There are three basic strategies in our system: don't calculate tax at all, use a basic, location-based set of rules, or offload the tax calculation to a third party that will take all related factors into account.
    • 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.
    • SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request
      The SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request data type contains general information relating to a single SoftLayer billing item for a data transfer request.
    • SoftLayer_Billing_Item_Association_History
      The SoftLayer_Billing_Item_Association_History type keeps a record of which server billing items an 'orphan' item has been associated with. Orphan billing items are billable items for secondary portable services (such as secondary subnets and StorageLayer accounts) that are not associated with a server and appear at the bottom of a SoftLayer invoice. The [SoftLayer_Billing_Item::setAssociationId](/reference/datatypes/$1/#$2) method allows you to associate these kinds of items with servers, making them appear as a child item of the server on your invoice. A SoftLayer_Billing_Item_Association_History record is created every time one of these associations are set.
    • SoftLayer_Billing_Item_Cancellation_Reason
      The SoftLayer_Billing_Item_Cancellation_Reason data type contains cancellation reasons.
    • SoftLayer_Billing_Item_Cancellation_Reason
    • SoftLayer_Billing_Item_Cancellation_Reason_Category
      The SoftLayer_Billing_Item_Cancellation_Reason_Category data type contains cancellation reason categories.
    • SoftLayer_Billing_Item_Cancellation_Reason_Category
    • SoftLayer_Billing_Item_Cancellation_Request
      SoftLayer_Billing_Item_Cancellation_Request data type is used to cancel service billing items.
    • SoftLayer_Billing_Item_Cancellation_Request
      SoftLayer customers can use this API to submit a cancellation request. A single service cancellation can contain multiple cancellation items which contain a billing item.
    • SoftLayer_Billing_Item_Cancellation_Request_Item
      SoftLayer_Billing_Item_Cancellation_Request_Item data type contains a billing item for cancellation. This data type is used to harness billing items to the associated service.
    • SoftLayer_Billing_Item_Cancellation_Request_Status
      SoftLayer_Billing_Item_Cancellation_Request_Status data type represents the status of a service cancellation request.
    • SoftLayer_Billing_Item_Chronicle
    • SoftLayer_Billing_Item_Chronicle
    • SoftLayer_Billing_Item_Ctc_Account
      The SoftLayer_Billing_Item_Ctc_Account data type contains general information relating to a single SoftLayer billing item for a CTC client account creation
    • SoftLayer_Billing_Item_Gateway_Appliance_Cluster
      The SoftLayer_Billing_Item_Big_Data_Cluster data type contains general information relating to a single SoftLayer billing item for a big data cluster.
    • SoftLayer_Billing_Item_Gateway_License
      The SoftLayer_Billing_Item_Gateway_License data type contains general information relating to a single SoftLayer billing item for a bare_metal_gateway_license
    • SoftLayer_Billing_Item_Hardware
      The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware.
    • SoftLayer_Billing_Item_Hardware_Colocation
      The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware.
    • SoftLayer_Billing_Item_Hardware_Component
      The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components.
    • SoftLayer_Billing_Item_Hardware_Security_Module
      The SoftLayer_Billing_Item_Hardware_Security_Module data type contains general information relating to a single SoftLayer billing item for a hardware security module.
    • SoftLayer_Billing_Item_Hardware_Server
      The SoftLayer_Billing_Item_Hardware_Server data type contains billing information about a bare metal server and its relationship to a particular customer account.
    • SoftLayer_Billing_Item_Network_Application_Delivery_Controller
      The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to a NetScaler VPX
    • SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress
      A SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a single [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) instance.
    • SoftLayer_Billing_Item_Network_Bandwidth
      The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware.
    • SoftLayer_Billing_Item_Network_Firewall
      The SoftLayer_Billing_Item_Network_Firewall data type contains general information relating to a single SoftLayer billing item whose item category code is 'firewall'
    • SoftLayer_Billing_Item_Network_Firewall_Module_Context
      The SoftLayer_Billing_Item_Network_Firewall_Module_Context data type describes the billing items related to VLAN Firewalls.
    • SoftLayer_Billing_Item_Network_Interconnect
      A SoftLayer_Billing_Item_Network_Interconnect represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a network interconnect instance.
    • SoftLayer_Billing_Item_Network_Interconnect_Routing
      A SoftLayer_Billing_Item_Network_Interconnect_Routing represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a network interconnect global routing.
    • SoftLayer_Billing_Item_Network_LoadBalancer
      A SoftLayer_Billing_Item_Network_LoadBalancer represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a single [SoftLayer_Network_LoadBalancer](/reference/datatypes/SoftLayer_Network_LoadBalancer) instance.
    • SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress
      A SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a single [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/datatypes/SoftLayer_Network_LoadBalancer_VirtualIpAddress) instance.
    • SoftLayer_Billing_Item_Network_Message_Delivery
      The SoftLayer_Billing_Item_Network_Message_Delivery data describes the related billing item.
    • SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi
      The SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi data type contains general information relating to a single SoftLayer billing item whose item category code is 'performance_storage_iscsi'
    • SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs
      The SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs data type contains general information relating to a single SoftLayer billing item whose item category code is 'performance_storage_nfs'
    • SoftLayer_Billing_Item_Network_Storage
      The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts.
    • SoftLayer_Billing_Item_Network_Storage_Hub
      The SoftLayer_Billing_Item_Network_Storage_Hub models all billing items related to hub-based StorageLayer offerings, such as CloudLayer storage.
    • SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth
      The SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth data type models the billing items created when a CloudLayer storage account generates a bandwidth overage charge.
    • SoftLayer_Billing_Item_Network_Subnet
      The SoftLayer_Billing_Item_Network_Subnet data type contains general information relating to a single SoftLayer billing item whose item category code is one of the following: * pri_ip_address * static_sec_ip_addresses (static secondary) * sov_sec_ip_addresses (secondary on vlan, also known as 'portable ips') * sov_sec_ip_addresses_pub (sov_sec_ip_addresses public only) * sov_sec_ip_addresses_priv (sov_sec_ip_addresses private only) * sec_ip_addresses (old style, secondary ip addresses) These item categories denote that the billing item has subnet information attached.
    • SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global
      The SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global data type contains general information relating to a single SoftLayer billing item whose item category code is one of the following: * global_ipv4 * global_ipv6 These item categories denote that the billing item has subnet information attached.
    • SoftLayer_Billing_Item_Network_Tunnel
      The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts.
    • SoftLayer_Billing_Item_Network_Vlan
      The SoftLayer_Billing_Item_Network_Vlan data type contains general information relating to a single SoftLayer billing item whose item category code is one of the following: * network_vlan These item categories denote that the billing item has network vlan information attached.
    • SoftLayer_Billing_Item_NewCustomerSetup
    • SoftLayer_Billing_Item_Private_Cloud
      The SoftLayer_Billing_Item_Private_Cloud data type contains general information relating to a single billing item for a private cloud.
    • SoftLayer_Billing_Item_Software_Component
      The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components.
    • SoftLayer_Billing_Item_Software_Component_Analytics_Urchin
      The SoftLayer_Billing_Item_Software_Component_Analytics_Urchin data type contains general information relating to a single SoftLayer billing item for Urchin software components.
    • SoftLayer_Billing_Item_Software_Component_ControlPanel
      The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains general information relating to a single SoftLayer billing item for control panel software components.
    • SoftLayer_Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing
      The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains general information relating to a single SoftLayer billing item for control panel software components.
    • SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon
      The SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon data type contains general information relating to a single SoftLayer billing item for operating system add-on software components.
    • SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials
      The SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials data type contains general information relating to a single SoftLayer billing item for Citrix Essentials software components.
    • SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem
      The SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem data type contains general information relating to a single SoftLayer billing item for operating system software components on virtual machines.
    • SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft
      The SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft data type contains general information relating to a single SoftLayer billing item for a Microsoft operating system software components on virtual machines.
    • SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat
      The SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft data type contains general information relating to a single SoftLayer billing item for a Microsoft operating system software components on virtual machines.
    • SoftLayer_Billing_Item_Software_License
      The SoftLayer_Billing_Item_Software_License data type contains general information relating to a single SoftLayer billing item for a software license.
    • SoftLayer_Billing_Item_Support
      The SoftLayer_Billing_Item_Support data type contains general information relating to a premium support offering
    • SoftLayer_Billing_Item_User_Customer_External_Binding
      The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to an external authentication binding
    • SoftLayer_Billing_Item_Virtual_Dedicated_Rack
      A SoftLayer_Billing_Item_Virtual_Dedicated_Rack data type models the billing information for a single bandwidth pooling. Bandwidth pooling members share their public bandwidth allocations, and incur overage charges instead of the overages on individual rack members. Virtual rack billing items are the parent items for all of it's rack membership billing items.
    • SoftLayer_Billing_Item_Virtual_DedicatedHost
    • SoftLayer_Billing_Item_Virtual_DedicatedHost
    • SoftLayer_Billing_Item_Virtual_Disk_Image
      The SoftLayer_Billing_Item_Virtual_Disk_Image data type contains general information relating to a single SoftLayer billing item for disk images.
    • SoftLayer_Billing_Item_Virtual_Guest
      The SoftLayer_Billing_Item_Virtual_Guest data type contains general information relating to a single SoftLayer billing item for guests.
    • SoftLayer_Billing_Item_Virtual_Host_Usage
      The SoftLayer_Billing_Item_Virtual_Host_Usage data type contains general information relating to a single SoftLayer billing item for virtual machine peak usage
    • SoftLayer_Billing_Item_Virtual_ReservedCapacity
    • SoftLayer_Billing_Item_Workspace
      The SoftLayer_Billing_Item_Workspace data type contains general information relating to a single SoftLayer billing item whose item category code is 'workspace'
    • SoftLayer_Billing_Order
      The SoftLayer_Billing_Order data type contains general information relating to an individual order applied to a SoftLayer customer account or to a new customer. Personal information in this type such as names, addresses, and phone numbers are taken from the account's contact information at the time the order is generated for existing SoftLayer customer.
    • SoftLayer_Billing_Order
      The SoftLayer_Billing_Order service controls the orders that are created whenever a SoftLayer customer's places a purchase. Orders exist in several states. The ones of concern are: *'''QUOTE_PENDING''': Orders which have not been paid yet. Orders pending approval from a Softlayer customer. Once an order is paid it moves from QUOTE_PENDING to PENDING_APPROVAL state. Orders are created with contact information duplicated from the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) or by manual entry. We do this in order to maintain a history of an account's contact information as orders are generated. Query the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service to get a list of orders for your account.
    • SoftLayer_Billing_Order_Cart
      The [SoftLayer_Billing_Order_Cart](/reference/datatypes/SoftLayer_Billing_Order_Cart) service allows customers to save their order in a state that can be continually modified. The difference between a cart and a quote is that a quote has locked-in prices while a cart does not. This allows customers to save their order configuration for up to 30 days. After 30 days, the cart is deleted and cannot be retrieved again.
    • SoftLayer_Billing_Order_Cart
      The [SoftLayer_Billing_Order_Cart](/reference/datatypes/SoftLayer_Billing_Order_Cart) service allows customers to save their order in a state that can be continually modified. The difference between a cart and a quote is that a quote has locked-in prices while a cart does not. This allows customers to save their order configuration for up to 30 days. After 30 days, the cart is deleted and cannot be retrieved again.
    • SoftLayer_Billing_Order_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_Order_Item
      The SoftLayer_Billing_Order_Item datatype provides information regarding a single ordered item. When a server order or any other order is placed, the information about that order is stored as SoftLayer_Billing_Order_items. This also provides information about software or hardware related to an ordered item,what package the item is in, and all pricing information related to this ordered item.
    • SoftLayer_Billing_Order_Item_Category_Answer
      The SoftLayer_Billing_Order_Item_Category_Answer data type represents a single answer to an item category question.
    • SoftLayer_Billing_Order_Quote
      The SoftLayer_Billing_Oder_Quote data type contains general information relating to an individual order applied to a SoftLayer customer account or to a new customer. Personal information in this type such as names, addresses, and phone numbers are taken from the account's contact information at the time the quote is generated for existing SoftLayer customer.
    • SoftLayer_Billing_Order_Quote
      The SoftLayer_Billing_Order_Quote service controls the quoted orders that are created whenever a SoftLayer customer's places a purchase. Quotes exist in several states. The ones of concern are: *'''PENDING''': Quotes which have not been paid yet. Quotes pending approval from a Softlayer customer. Once an order is placed from a quote it moves from PENDING to EXPIRED state 2 days after its creation and it is removed from the system after 5 days unless otherwise the SoftLayer customer saved the quote. Quotes could are created with contact information duplicated from the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) or by manual entry. We do this in order to maintain a history of an account's contact information as quotes are generated. Query the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service to get a list of quotes for your account.
    • SoftLayer_Billing_Order_Type
      The SoftLayer_Billing_Oder_Type data type contains general information relating to all the different types of orders that exist. This data pertains only to where an order was generated from, from any of the SoftLayer websites with ordering interfaces or directly through the SoftLayer API.
    • SoftLayer_Billing_Payment_Card_ChangeRequest
      The SoftLayer_Billing_Payment_Card_ChangeRequest data type contains general information relating to attempted credit card information changes. This supports enablement of 3D Secure via Cardinal Cruise implementation that allows for credit card authentication and is currently limited to specified merchants.
    • SoftLayer_Billing_Payment_Card_ManualPayment
      The SoftLayer_Billing_Payment_Card_ManualPayment data type contains general information related to requesting a manual payment. This supports enablement of 3D Secure via Cardinal Cruise implementation that allows for credit card authentication and is currently limited to specified merchants.
    • SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup
      This datatype payer authentication setup
    • SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup_Information
      This is the datatype that needs to be populated and sent to SoftLayer_Account::initiatePayerAuthentication.
    • SoftLayer_Billing_Payment_Card_Transaction
      The SoftLayer_Billing_Payment_Card_Transaction data type contains general information relating to attempted credit card transactions.
    • SoftLayer_Billing_Payment_PayPal_Transaction
      The SoftLayer_Billing_Payment_PayPal_Transaction data type contains general information relating to attempted PayPal transactions.
    • SoftLayer_Billing_Payment_Processor
    • SoftLayer_Billing_Payment_Processor_Method
    • SoftLayer_Billing_Payment_Processor_Type
    • SoftLayer_Billing_Payment_Transaction
      Implementation for payment transactions.
    • SoftLayer_Billing_Payment_Type
    • updateCart
      Like SoftLayer_Billing_Order_Cart::createCart, the order data will be sent through SoftLayer_Product_Order::verifyOrder to make sure that the updated cart information is valid. Once it has been verified, the new order data will be saved. This will return the cart id.
    • validateBillingItemForCancellation
      This method examined if a billing item is eligible for cancellation. It checks if the billing item you provided is already in your existing cancellation request.
    • verifyOrder
      Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval.
    • verifyOrder
      Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval.
    • void
      This method voids a service cancellation request in 'Pending' or 'Approved' status.
    • voidCancelService
      Void a previously made cancellation for a service
    • voidCancelService
      Void a previously made cancellation for a service
    • withdrawGdprAcceptance
      Withdraws the users acceptance of the GDPR terms.
    • withdrawGdprAcceptance
      Withdraws the users acceptance of the GDPR terms.

    rest

    ruby

Open Source SDKs

softlayer-python
 softlayer-java
 softlayer-go
 softlayer-perl
 softlayer-php
 softlayer-ruby

SL CLI

Standalone SoftLayer CLI
Installation
Documentation
Feature Request
Bug Report
Changelog

SL Plugin

Classic Infrastructure Plugin for ibmcloud CLI
Installation
Documentation
Feature Request
Bug Report
Changelog