From 4fdc06e1ada2a38d0ee4521e5eb7ab50cf70506c Mon Sep 17 00:00:00 2001 From: Christopher Gallo Date: Fri, 27 Jun 2025 13:57:25 -0500 Subject: [PATCH] 20250627 release notes --- ...ontroller_LoadBalancer_VirtualIpAddress.md | 14 - ...m_Network_LoadBalancer_VirtualIpAddress.md | 14 - ...ftLayer_Metric_Tracking_Object_Abstract.md | 14 - ...cking_Object_Virtual_Storage_Repository.md | 14 - ...tLayer_Network_Security_Scanner_Request.md | 7 +- ...Network_Security_Scanner_Request_Status.md | 10 +- .../getAverageArchiveUsageMetricDataByDate.md | 20 - .../getAveragePublicUsageMetricDataByDate.md | 20 - .../_index.md | 13 +- .../getObject.md | 2 +- .../getReport.md | 2 +- .../getAverageUsageMetricDataByDate.md | 20 - .../getUsageMetricDataByDate.md | 20 - .../getUsageMetricImageByDate.md | 20 - content/release_notes/2025/20250627.md | 12 + data/sldn_metadata.json | 119772 ++++++++++----- 16 files changed, 83166 insertions(+), 36808 deletions(-) delete mode 100644 content/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress.md delete mode 100644 content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress.md delete mode 100644 content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Abstract.md delete mode 100644 content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository.md delete mode 100644 content/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate.md delete mode 100644 content/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate.md delete mode 100644 content/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate.md delete mode 100644 content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate.md delete mode 100644 content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate.md create mode 100644 content/release_notes/2025/20250627.md diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress.md deleted file mode 100644 index 8bbbf8a0f4..0000000000 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress" -description: "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. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Billing" -classes: - - "SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress" ---- diff --git a/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress.md b/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress.md deleted file mode 100644 index b31ffaaae8..0000000000 --- a/content/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress" -description: "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. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Billing" -classes: - - "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress" ---- diff --git a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Abstract.md b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Abstract.md deleted file mode 100644 index cd8f079953..0000000000 --- a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Abstract.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Metric_Tracking_Object_Abstract" -description: "SoftLayer_Metric_Tracking_Object_Abstract models a generic tracking object type. Typically a tracking object with a specific purpose has it's own data type defined within the SoftLayer API. " -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Metric" -classes: - - "SoftLayer_Metric_Tracking_Object_Abstract" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Metric_Tracking_Object_Abstract" ---- diff --git a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository.md b/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository.md deleted file mode 100644 index ad7d1176d8..0000000000 --- a/content/reference/datatypes/SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository" -description: "" -date: "2018-02-12" -tags: - - "datatype" - - "sldn" - - "Metric" -classes: - - "SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository" -type: "reference" -layout: "datatype" -mainService : "SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository" ---- diff --git a/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request.md b/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request.md index ed3de56cac..7e5b89504f 100644 --- a/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request.md +++ b/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request.md @@ -1,11 +1,6 @@ --- title: "SoftLayer_Network_Security_Scanner_Request" -description: "The SoftLayer_Network_Security_Scanner_Request data type represents a single vulnerability scan request. It provides information on when the scan was created, last updated, and the current status. The status messages are as follows: -*Scan Pending -*Scan Processing -*Scan Complete -*Scan Cancelled -*Generating Report." +description: "DEPRECATED " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request_Status.md b/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request_Status.md index c41a56b43a..a692831c4b 100644 --- a/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request_Status.md +++ b/content/reference/datatypes/SoftLayer_Network_Security_Scanner_Request_Status.md @@ -1,14 +1,6 @@ --- title: "SoftLayer_Network_Security_Scanner_Request_Status" -description: "The SoftLayer_Network_Security_Scanner_Request_Status data type represents the current status of a vulnerability scan. The status messages are as follows: -*Scan Pending -*Scan Processing -*Scan Complete -*Scan Cancelled -*Generating Report. - - -The status of a vulnerability scan will change over the course of a scan's execution. " +description: "DEPRECATED " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate.md b/content/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate.md deleted file mode 100644 index 44e38f9a5e..0000000000 --- a/content/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getAverageArchiveUsageMetricDataByDate" -description: "Returns the average disk space usage for all archive repositories. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Account" -classes: - - "SoftLayer_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Account" ---- - -### [REST Example](#getAverageArchiveUsageMetricDataByDate-example) {#getAverageArchiveUsageMetricDataByDate-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate' -``` diff --git a/content/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate.md b/content/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate.md deleted file mode 100644 index 3a794dbede..0000000000 --- a/content/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getAveragePublicUsageMetricDataByDate" -description: "Returns the average disk space usage for all public repositories. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Account" -classes: - - "SoftLayer_Account" -type: "reference" -layout: "method" -mainService : "SoftLayer_Account" ---- - -### [REST Example](#getAveragePublicUsageMetricDataByDate-example) {#getAveragePublicUsageMetricDataByDate-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getAveragePublicUsageMetricDataByDate' -``` diff --git a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/_index.md b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/_index.md index 47f212f5ee..16447a0019 100644 --- a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/_index.md +++ b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/_index.md @@ -1,17 +1,6 @@ --- title: "SoftLayer_Network_Security_Scanner_Request" -description: "SoftLayer gives customers the ability to manage vulnerability scans for each of their servers. This service provides the ability to create a new scan request, view the status of a current request, and finally view the report of a finished scan. - -A vulnerability scan attempts to find potential security problems on a server by first searching for open ports and the services that run on them. If any services are found the scanner will then check for version and patch information of each service found. Lastly, the scanner will use the information gathered to search its database of known vulnerabilities and generate a report. Reports typically take five to ten minutes to run but allow for up to thirty minutes in rare cases. - -A vulnerability report will typically include the following information: -*Number of security holes and warnings. -*The hosts that were scanned. -*The port/service and the corresponding issue. -*Detailed information about the issue, risk factor, and possible fixes. - - -If you have a firewall, SoftLayer's administrative networks need to be allowed for the vulnerability scan to be effective. If a firewall is blocking all ports, the report may not show any problems even if some exist. In addition you may have some indication in your firewall logs of the scan taking place as ports on your system are investigated. " +description: "DEPRECATED " date: "2018-02-12" tags: - "service" diff --git a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getObject.md b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getObject.md index cc36fa3e2b..1025c2236b 100644 --- a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getObject.md +++ b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getObject.md @@ -1,6 +1,6 @@ --- title: "getObject" -description: "getObject retrieves the SoftLayer_Network_Security_Scanner_Request object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Security_Scanner_Request service. You can only retrieve requests and reports that are assigned to your SoftLayer account. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getReport.md b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getReport.md index b4aaf12991..8566e56663 100644 --- a/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getReport.md +++ b/content/reference/services/SoftLayer_Network_Security_Scanner_Request/getReport.md @@ -1,6 +1,6 @@ --- title: "getReport" -description: "Get the vulnerability report for a scan request, formatted as HTML string. Previous scan reports are held indefinitely. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate.md deleted file mode 100644 index 60726bf331..0000000000 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getAverageUsageMetricDataByDate" -description: "Returns the average disk space usage for a storage repository. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Virtual" -classes: - - "SoftLayer_Virtual_Storage_Repository" -type: "reference" -layout: "method" -mainService : "SoftLayer_Virtual_Storage_Repository" ---- - -### [REST Example](#getAverageUsageMetricDataByDate-example) {#getAverageUsageMetricDataByDate-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getAverageUsageMetricDataByDate' -``` diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate.md deleted file mode 100644 index 89bf84a0ce..0000000000 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getUsageMetricDataByDate" -description: "Retrieve disk usage data on a [SoftLayer_Virtual_Guest](/reference/datatypes/SoftLayer_Virtual_Guest) image for the time range you provide. Each data entry objects contain ''dateTime'' and ''counter'' properties. ''dateTime'' property indicates the time that the disk usage data was measured and ''counter'' property holds the disk usage in bytes. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Virtual" -classes: - - "SoftLayer_Virtual_Storage_Repository" -type: "reference" -layout: "method" -mainService : "SoftLayer_Virtual_Storage_Repository" ---- - -### [REST Example](#getUsageMetricDataByDate-example) {#getUsageMetricDataByDate-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getUsageMetricDataByDate' -``` diff --git a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate.md b/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate.md deleted file mode 100644 index 13aa31cf32..0000000000 --- a/content/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getUsageMetricImageByDate" -description: "Returns a disk usage image based on disk usage specified by the input parameters. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Virtual" -classes: - - "SoftLayer_Virtual_Storage_Repository" -type: "reference" -layout: "method" -mainService : "SoftLayer_Virtual_Storage_Repository" ---- - -### [REST Example](#getUsageMetricImageByDate-example) {#getUsageMetricImageByDate-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getUsageMetricImageByDate' -``` diff --git a/content/release_notes/2025/20250627.md b/content/release_notes/2025/20250627.md new file mode 100644 index 0000000000..5ba7e20f5d --- /dev/null +++ b/content/release_notes/2025/20250627.md @@ -0,0 +1,12 @@ +--- +title: "Release notes: June 27, 2025" +date: "2025-06-27" +tags: + - "release notes" +--- + +#### API + +- Correct regression in SoftLayer_Metric_Tracking_Object::getBandwidthData(). Revert Validation Changes to the Virtual Guest Tracking Object NETWORK-14992 +- Deprecation of all Security Scanner services, methods, and properties.. Deprecate Nessus Security Scanner Code NETWORK-14963 +- Changing a premium VLAN name will change the notes of the associated billing item.. Update VLAN billing item notes when VLAN name changes NETWORK-14993 diff --git a/data/sldn_metadata.json b/data/sldn_metadata.json index 7ab707973b..e2c01ec368 100644 --- a/data/sldn_metadata.json +++ b/data/sldn_metadata.json @@ -1349,44 +1349,6 @@ "static": true, "limitable": true }, - "getAverageArchiveUsageMetricDataByDate": { - "name": "getAverageArchiveUsageMetricDataByDate", - "type": "float", - "doc": "Returns the average disk space usage for all archive repositories. ", - "docOverview": "Returns the average disk usage for all archive repositories for the timeframe based on the parameters provided. ", - "parameters": [ - { - "name": "startDateTime", - "type": "dateTime", - "doc": "datetime of the start date of the graph" - }, - { - "name": "endDateTime", - "type": "dateTime", - "doc": "datetime of the ending date of the graph" - } - ], - "static": true - }, - "getAveragePublicUsageMetricDataByDate": { - "name": "getAveragePublicUsageMetricDataByDate", - "type": "float", - "doc": "Returns the average disk space usage for all public repositories. ", - "docOverview": "Returns the average disk usage for all public repositories for the timeframe based on the parameters provided. ", - "parameters": [ - { - "name": "startDateTime", - "type": "dateTime", - "doc": "datetime of the start date of the graph" - }, - { - "name": "endDateTime", - "type": "dateTime", - "doc": "datetime of the ending date of the graph" - } - ], - "static": true - }, "getBandwidthList": { "name": "getBandwidthList", "type": "SoftLayer_Container_Bandwidth_Usage", @@ -4536,7 +4498,7 @@ "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, + "deprecated": true, "limitable": true }, "getServiceBillingItems": { @@ -6378,7 +6340,8 @@ "type": "SoftLayer_Network_Security_Scanner_Request", "form": "relational", "typeArray": true, - "doc": "An account's vulnerability scan requests." + "doc": "An account's vulnerability scan requests.", + "deprecated": true }, "serviceBillingItems": { "name": "serviceBillingItems", @@ -15537,6 +15500,230 @@ "docOverview": "Retrieve a SoftLayer_Billing_Invoice_Item record.", "filterable": true, "maskable": true + }, + "getAssociatedChildren": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedInvoiceItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBillingItem": { + "doc": "An Invoice Item's billing item, from which this item was generated.", + "docOverview": "", + "name": "getBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCategory": { + "doc": "This invoice item's \"item category\". ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "An Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children.", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDPart": { + "doc": "This is the DPart for invoice item.", + "docOverview": "", + "name": "getDPart", + "type": "string", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getDiscountingInvoiceItemId": { + "doc": "The invoice item ID from which the discount is derived.", + "docOverview": "", + "name": "getDiscountingInvoiceItemId", + "type": "int", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getFilteredAssociatedChildren": { + "doc": "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.", + "docOverview": "", + "name": "getFilteredAssociatedChildren", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "Indicating whether this invoice item is billed on an hourly basis.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoice": { + "doc": "The invoice to which this item belongs.", + "docOverview": "", + "name": "getInvoice", + "type": "SoftLayer_Billing_Invoice", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "An invoice item's location, if one exists.'", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroAssociatedChildren": { + "doc": "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.", + "docOverview": "", + "name": "getNonZeroAssociatedChildren", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getParent": { + "doc": "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.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProduct": { + "doc": "The entry in the product catalog that a invoice item is based upon.", + "docOverview": "", + "name": "getProduct", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getTopLevelProductGroupName": { + "doc": "A string representing the name of parent level product group of an invoice item.", + "docOverview": "", + "name": "getTopLevelProductGroupName", + "type": "string", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getTotalOneTimeAmount": { + "doc": "An invoice Item's total, including any child invoice items if they exist.", + "docOverview": "", + "name": "getTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getTotalOneTimeTaxAmount": { + "doc": "An invoice Item's total, including any child invoice items if they exist.", + "docOverview": "", + "name": "getTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getTotalRecurringAmount": { + "doc": "An invoice Item's total, including any child invoice items if they exist.", + "docOverview": "", + "name": "getTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getTotalRecurringTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUsageChargeFlag": { + "doc": "Indicating whether this invoice item is for the usage charge.", + "docOverview": "", + "name": "getUsageChargeFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false } } }, @@ -18122,6 +18309,567 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] + }, + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } } }, @@ -19081,237 +19829,798 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - }, - "properties": { - "account": { - "name": "account", + }, + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", - "type": "float", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." + }, + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + }, + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." + }, + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" + }, + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." + }, + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." + }, + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true + }, + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." + }, + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's bundled billing items." + }, + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "cancellationReason": { + "name": "cancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "form": "relational", + "doc": "The billing item's cancellation reason." + }, + "cancellationRequests": { + "name": "cancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", + "typeArray": true, + "doc": "This will return any cancellation requests that are associated with this billing item." + }, + "category": { + "name": "category", + "type": "SoftLayer_Product_Item_Category", + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " + }, + "children": { + "name": "children", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items'" + }, + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "downgradeItems": { + "name": "downgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "For product items which have a downgrade path defined, this will return those product items." + }, + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + }, + "hourlyFlag": { + "name": "hourlyFlag", + "type": "boolean", + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + }, + "invoiceItem": { + "name": "invoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "doc": "Invoice items associated with this billing item" + }, + "invoiceItems": { + "name": "invoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "typeArray": true, + "doc": "All invoice items associated with the billing item" + }, + "item": { + "name": "item", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + }, + "location": { + "name": "location", + "type": "SoftLayer_Location", + "form": "relational", + "doc": "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": { + "name": "nextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items and associated items'" + }, + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" + }, + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" + }, + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", + "type": "float", "form": "relational", "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" }, @@ -19881,6 +21190,567 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] + }, + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } }, "properties": { @@ -21311,6 +23181,567 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] + }, + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } } }, @@ -22216,926 +24647,1380 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Hardware_Colocation": { - "name": "SoftLayer_Billing_Item_Hardware_Colocation", - "base": "SoftLayer_Billing_Item_Hardware", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - }, - "properties": { - "billingCycleBandwidthUsage": { - "name": "billingCycleBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." - }, - "billingCyclePrivateBandwidthUsage": { - "name": "billingCyclePrivateBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePrivateUsageIn": { - "name": "billingCyclePrivateUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total private inbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePrivateUsageOut": { - "name": "billingCyclePrivateUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total private outbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePrivateUsageTotal": { - "name": "billingCyclePrivateUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total private bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicBandwidthUsage": { - "name": "billingCyclePublicBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw public bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicUsageIn": { - "name": "billingCyclePublicUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total public inbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicUsageOut": { - "name": "billingCyclePublicUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total public outbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicUsageTotal": { - "name": "billingCyclePublicUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total public bandwidth for this hardware for the current billing cycle." - }, - "lockboxNetworkStorage": { - "name": "lockboxNetworkStorage", - "type": "SoftLayer_Billing_Item_Network_Storage", - "form": "relational", - "doc": "A lockbox account associated with a server." - }, - "monitoringBillingItems": { - "name": "monitoringBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true - }, - "resource": { - "name": "resource", - "type": "SoftLayer_Hardware_Server", - "form": "relational", - "doc": "The resource for a server billing item." - }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a server billing item." - }, - "billingCycleBandwidthUsageCount": { - "name": "billingCycleBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "billingCyclePrivateBandwidthUsageCount": { - "name": "billingCyclePrivateBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicBandwidthUsageCount": { - "name": "billingCyclePublicBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw public bandwidth usage data for the current billing cycle." - }, - "monitoringBillingItemCount": { - "name": "monitoringBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." - }, - "associatedParent": { - "name": "associatedParent", - "type": "SoftLayer_Billing_Item", - "form": "relational", + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", "type": "float", - "form": "relational", - "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItem": { - "name": "orderItem", + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "originalLocation": { - "name": "originalLocation", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "package": { - "name": "package", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parent": { - "name": "parent", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingOrderItem": { - "name": "pendingOrderItem", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "provisionTransaction": { - "name": "provisionTransaction", + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "softwareDescription": { - "name": "softwareDescription", + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItem": { - "name": "upgradeItem", + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItems": { - "name": "upgradeItems", + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + } + }, + "SoftLayer_Billing_Item_Hardware_Colocation": { + "name": "SoftLayer_Billing_Item_Hardware_Colocation", + "base": "SoftLayer_Billing_Item_Hardware", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. ", + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", - "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "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. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", - "type": "string", - "form": "local", - "doc": "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](/reference/datatypes/$1/#$2). 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. " + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", - "form": "local", - "doc": "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. " + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "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." + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "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. \n\nIn 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. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", - "type": "string", - "form": "local", - "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "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. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of a billing item." + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name is provided for server billing items." + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname is provided for server billing items" + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hoursUsed": { - "name": "hoursUsed", - "type": "string", - "form": "local", - "doc": "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. " + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for this billing item." + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a billing item was last modified." + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", - "form": "local", - "doc": "The date on which your account will be charged for this billing item. " + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "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." + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItemId": { - "name": "orderItemId", - "type": "int", - "form": "local", - "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", - "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local", - "doc": "This is the service provider for this billing item. " + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildrenCount": { - "name": "activeAssociatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildrenCount": { - "name": "associatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedParentCount": { - "name": "associatedParentCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "billableChildrenCount": { - "name": "billableChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequestCount": { - "name": "cancellationRequestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this will return any cancellation requests that are associated with this billing item." + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items'" + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreementCount": { - "name": "childrenWithActiveAgreementCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "downgradeItemCount": { - "name": "downgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of for product items which have a downgrade path defined, this will return those product items." + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "filteredNextInvoiceChildrenCount": { - "name": "filteredNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItemCount": { - "name": "invoiceItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of all invoice items associated with the billing item" + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItemCount": { - "name": "upgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } - } - }, - "SoftLayer_Billing_Item_Hardware_Component": { - "name": "SoftLayer_Billing_Item_Hardware_Component", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components. ", + }, "properties": { + "billingCycleBandwidthUsage": { + "name": "billingCycleBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." + }, + "billingCyclePrivateBandwidthUsage": { + "name": "billingCyclePrivateBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw private bandwidth usage data for the current billing cycle." + }, + "billingCyclePrivateUsageIn": { + "name": "billingCyclePrivateUsageIn", + "type": "decimal", + "form": "relational", + "doc": "The total private inbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePrivateUsageOut": { + "name": "billingCyclePrivateUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total private outbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePrivateUsageTotal": { + "name": "billingCyclePrivateUsageTotal", + "type": "unsignedInt", + "form": "relational", + "doc": "The total private bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicBandwidthUsage": { + "name": "billingCyclePublicBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw public bandwidth usage data for the current billing cycle." + }, + "billingCyclePublicUsageIn": { + "name": "billingCyclePublicUsageIn", + "type": "decimal", + "form": "relational", + "doc": "The total public inbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicUsageOut": { + "name": "billingCyclePublicUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total public outbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicUsageTotal": { + "name": "billingCyclePublicUsageTotal", + "type": "unsignedInt", + "form": "relational", + "doc": "The total public bandwidth for this hardware for the current billing cycle." + }, + "lockboxNetworkStorage": { + "name": "lockboxNetworkStorage", + "type": "SoftLayer_Billing_Item_Network_Storage", + "form": "relational", + "doc": "A lockbox account associated with a server." + }, + "monitoringBillingItems": { + "name": "monitoringBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, "resource": { "name": "resource", - "type": "SoftLayer_Hardware_Component", + "type": "SoftLayer_Hardware_Server", "form": "relational", - "typeArray": true, - "doc": "The hardware component that this billing item points to." + "doc": "The resource for a server billing item." }, "resourceTableId": { "name": "resourceTableId", @@ -23143,11 +26028,29 @@ "form": "local", "doc": "The resource (unique identifier) for a server billing item." }, - "resourceCount": { - "name": "resourceCount", + "billingCycleBandwidthUsageCount": { + "name": "billingCycleBandwidthUsageCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the hardware component that this billing item points to." + "doc": "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." + }, + "billingCyclePrivateBandwidthUsageCount": { + "name": "billingCyclePrivateBandwidthUsageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the raw private bandwidth usage data for the current billing cycle." + }, + "billingCyclePublicBandwidthUsageCount": { + "name": "billingCyclePublicBandwidthUsageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the raw public bandwidth usage data for the current billing cycle." + }, + "monitoringBillingItemCount": { + "name": "monitoringBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, "account": { "name": "account", @@ -23772,426 +26675,20 @@ "form": "count", "doc": "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." } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } } }, - "SoftLayer_Billing_Item_Hardware_Security_Module": { - "name": "SoftLayer_Billing_Item_Hardware_Security_Module", - "base": "SoftLayer_Billing_Item_Hardware", + "SoftLayer_Billing_Item_Hardware_Component": { + "name": "SoftLayer_Billing_Item_Hardware_Component", + "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Hardware_Security_Module data type contains general information relating to a single SoftLayer billing item for a hardware security module. ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - }, + "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components. ", "properties": { - "billingCycleBandwidthUsage": { - "name": "billingCycleBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." - }, - "billingCyclePrivateBandwidthUsage": { - "name": "billingCyclePrivateBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePrivateUsageIn": { - "name": "billingCyclePrivateUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total private inbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePrivateUsageOut": { - "name": "billingCyclePrivateUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total private outbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePrivateUsageTotal": { - "name": "billingCyclePrivateUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total private bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicBandwidthUsage": { - "name": "billingCyclePublicBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw public bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicUsageIn": { - "name": "billingCyclePublicUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total public inbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicUsageOut": { - "name": "billingCyclePublicUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total public outbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicUsageTotal": { - "name": "billingCyclePublicUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total public bandwidth for this hardware for the current billing cycle." - }, - "lockboxNetworkStorage": { - "name": "lockboxNetworkStorage", - "type": "SoftLayer_Billing_Item_Network_Storage", - "form": "relational", - "doc": "A lockbox account associated with a server." - }, - "monitoringBillingItems": { - "name": "monitoringBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true - }, "resource": { "name": "resource", - "type": "SoftLayer_Hardware_Server", + "type": "SoftLayer_Hardware_Component", "form": "relational", - "doc": "The resource for a server billing item." + "typeArray": true, + "doc": "The hardware component that this billing item points to." }, "resourceTableId": { "name": "resourceTableId", @@ -24199,29 +26696,11 @@ "form": "local", "doc": "The resource (unique identifier) for a server billing item." }, - "billingCycleBandwidthUsageCount": { - "name": "billingCycleBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "billingCyclePrivateBandwidthUsageCount": { - "name": "billingCyclePrivateBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicBandwidthUsageCount": { - "name": "billingCyclePublicBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw public bandwidth usage data for the current billing cycle." - }, - "monitoringBillingItemCount": { - "name": "monitoringBillingItemCount", + "resourceCount": { + "name": "resourceCount", "type": "unsignedLong", "form": "count", - "doc": "A count of " + "doc": "A count of the hardware component that this billing item points to." }, "account": { "name": "account", @@ -24846,13 +27325,7 @@ "form": "count", "doc": "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." } - } - }, - "SoftLayer_Billing_Item_Hardware_Server": { - "name": "SoftLayer_Billing_Item_Hardware_Server", - "base": "SoftLayer_Billing_Item_Hardware", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Hardware_Server data type contains billing information about a bare metal server and its relationship to a particular customer account. ", + }, "methods": { "cancelItem": { "name": "cancelItem", @@ -25020,756 +27493,1410 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - }, - "properties": { - "billingCycleBandwidthUsage": { - "name": "billingCycleBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." - }, - "billingCyclePrivateBandwidthUsage": { - "name": "billingCyclePrivateBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw private bandwidth usage data for the current billing cycle." }, - "billingCyclePrivateUsageIn": { - "name": "billingCyclePrivateUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total private inbound bandwidth for this hardware for the current billing cycle." + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billingCyclePrivateUsageOut": { - "name": "billingCyclePrivateUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total private outbound bandwidth for this hardware for the current billing cycle." + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billingCyclePrivateUsageTotal": { - "name": "billingCyclePrivateUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total private bandwidth for this hardware for the current billing cycle." + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billingCyclePublicBandwidthUsage": { - "name": "billingCyclePublicBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, - "doc": "The raw public bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicUsageIn": { - "name": "billingCyclePublicUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total public inbound bandwidth for this hardware for the current billing cycle." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "billingCyclePublicUsageOut": { - "name": "billingCyclePublicUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total public outbound bandwidth for this hardware for the current billing cycle." - }, - "billingCyclePublicUsageTotal": { - "name": "billingCyclePublicUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total public bandwidth for this hardware for the current billing cycle." - }, - "lockboxNetworkStorage": { - "name": "lockboxNetworkStorage", - "type": "SoftLayer_Billing_Item_Network_Storage", - "form": "relational", - "doc": "A lockbox account associated with a server." - }, - "monitoringBillingItems": { - "name": "monitoringBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true - }, - "resource": { - "name": "resource", - "type": "SoftLayer_Hardware_Server", - "form": "relational", - "doc": "The resource for a server billing item." - }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a server billing item." - }, - "billingCycleBandwidthUsageCount": { - "name": "billingCycleBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "billingCyclePrivateBandwidthUsageCount": { - "name": "billingCyclePrivateBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicBandwidthUsageCount": { - "name": "billingCyclePublicBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw public bandwidth usage data for the current billing cycle." - }, - "monitoringBillingItemCount": { - "name": "monitoringBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "account": { - "name": "account", - "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." - }, - "activeAgreement": { - "name": "activeAgreement", - "type": "SoftLayer_Account_Agreement", - "form": "relational" - }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", - "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." - }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." - }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", "type": "float", - "form": "relational", - "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItem": { - "name": "orderItem", + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "originalLocation": { - "name": "originalLocation", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "package": { - "name": "package", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parent": { - "name": "parent", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingOrderItem": { - "name": "pendingOrderItem", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "provisionTransaction": { - "name": "provisionTransaction", + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "softwareDescription": { - "name": "softwareDescription", + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItem": { - "name": "upgradeItem", + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItems": { - "name": "upgradeItems", + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + } + }, + "SoftLayer_Billing_Item_Hardware_Security_Module": { + "name": "SoftLayer_Billing_Item_Hardware_Security_Module", + "base": "SoftLayer_Billing_Item_Hardware", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Item_Hardware_Security_Module data type contains general information relating to a single SoftLayer billing item for a hardware security module. ", + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", - "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "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. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", - "type": "string", - "form": "local", - "doc": "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](/reference/datatypes/$1/#$2). 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. " + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", - "form": "local", - "doc": "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. " + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "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." + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "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. \n\nIn 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. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", - "type": "string", - "form": "local", - "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "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. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of a billing item." + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name is provided for server billing items." + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname is provided for server billing items" + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hoursUsed": { - "name": "hoursUsed", - "type": "string", - "form": "local", - "doc": "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. " + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for this billing item." + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a billing item was last modified." + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", - "form": "local", - "doc": "The date on which your account will be charged for this billing item. " + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "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." + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItemId": { - "name": "orderItemId", - "type": "int", - "form": "local", - "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", - "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local", - "doc": "This is the service provider for this billing item. " + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildrenCount": { - "name": "activeAssociatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildrenCount": { - "name": "associatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedParentCount": { - "name": "associatedParentCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "billableChildrenCount": { - "name": "billableChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequestCount": { - "name": "cancellationRequestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this will return any cancellation requests that are associated with this billing item." + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items'" + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreementCount": { - "name": "childrenWithActiveAgreementCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "downgradeItemCount": { - "name": "downgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of for product items which have a downgrade path defined, this will return those product items." + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "filteredNextInvoiceChildrenCount": { - "name": "filteredNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItemCount": { - "name": "invoiceItemCount", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "billingCycleBandwidthUsage": { + "name": "billingCycleBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." + }, + "billingCyclePrivateBandwidthUsage": { + "name": "billingCyclePrivateBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw private bandwidth usage data for the current billing cycle." + }, + "billingCyclePrivateUsageIn": { + "name": "billingCyclePrivateUsageIn", + "type": "decimal", + "form": "relational", + "doc": "The total private inbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePrivateUsageOut": { + "name": "billingCyclePrivateUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total private outbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePrivateUsageTotal": { + "name": "billingCyclePrivateUsageTotal", + "type": "unsignedInt", + "form": "relational", + "doc": "The total private bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicBandwidthUsage": { + "name": "billingCyclePublicBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw public bandwidth usage data for the current billing cycle." + }, + "billingCyclePublicUsageIn": { + "name": "billingCyclePublicUsageIn", + "type": "decimal", + "form": "relational", + "doc": "The total public inbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicUsageOut": { + "name": "billingCyclePublicUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total public outbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicUsageTotal": { + "name": "billingCyclePublicUsageTotal", + "type": "unsignedInt", + "form": "relational", + "doc": "The total public bandwidth for this hardware for the current billing cycle." + }, + "lockboxNetworkStorage": { + "name": "lockboxNetworkStorage", + "type": "SoftLayer_Billing_Item_Network_Storage", + "form": "relational", + "doc": "A lockbox account associated with a server." + }, + "monitoringBillingItems": { + "name": "monitoringBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "resource": { + "name": "resource", + "type": "SoftLayer_Hardware_Server", + "form": "relational", + "doc": "The resource for a server billing item." + }, + "resourceTableId": { + "name": "resourceTableId", + "type": "int", + "form": "local", + "doc": "The resource (unique identifier) for a server billing item." + }, + "billingCycleBandwidthUsageCount": { + "name": "billingCycleBandwidthUsageCount", "type": "unsignedLong", "form": "count", - "doc": "A count of all invoice items associated with the billing item" + "doc": "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." }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", + "billingCyclePrivateBandwidthUsageCount": { + "name": "billingCyclePrivateBandwidthUsageCount", "type": "unsignedLong", "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" + "doc": "A count of the raw private bandwidth usage data for the current billing cycle." }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", + "billingCyclePublicBandwidthUsageCount": { + "name": "billingCyclePublicBandwidthUsageCount", "type": "unsignedLong", "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "doc": "A count of the raw public bandwidth usage data for the current billing cycle." }, - "upgradeItemCount": { - "name": "upgradeItemCount", + "monitoringBillingItemCount": { + "name": "monitoringBillingItemCount", "type": "unsignedLong", "form": "count", - "doc": "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." - } - } - }, - "SoftLayer_Billing_Item_Network_Application_Delivery_Controller": { - "name": "SoftLayer_Billing_Item_Network_Application_Delivery_Controller", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to a NetScaler VPX ", - "properties": { - "bandwidthAllotmentDetail": { - "name": "bandwidthAllotmentDetail", - "type": "SoftLayer_Network_Bandwidth_Version1_Allotment_Detail", - "form": "relational", - "doc": "The bandwidth allotment detail for a billing item." - }, - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Application_Delivery_Controller", - "form": "relational", - "doc": "The network application controller that a billing item is associated with." + "doc": "A count of " }, "account": { "name": "account", @@ -26394,7 +29521,13 @@ "form": "count", "doc": "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." } - }, + } + }, + "SoftLayer_Billing_Item_Hardware_Server": { + "name": "SoftLayer_Billing_Item_Hardware_Server", + "base": "SoftLayer_Billing_Item_Hardware", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Item_Hardware_Server data type contains billing information about a bare metal server and its relationship to a particular customer account. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -26562,175 +29695,829 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress": { - "name": "SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "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. ", - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress", - "form": "relational", - "doc": "The load balancer that a load balancer billing item is associated with." }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" - }, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "billingCycleBandwidthUsage": { + "name": "billingCycleBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." + }, + "billingCyclePrivateBandwidthUsage": { + "name": "billingCyclePrivateBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw private bandwidth usage data for the current billing cycle." + }, + "billingCyclePrivateUsageIn": { + "name": "billingCyclePrivateUsageIn", + "type": "decimal", + "form": "relational", + "doc": "The total private inbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePrivateUsageOut": { + "name": "billingCyclePrivateUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total private outbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePrivateUsageTotal": { + "name": "billingCyclePrivateUsageTotal", + "type": "unsignedInt", + "form": "relational", + "doc": "The total private bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicBandwidthUsage": { + "name": "billingCyclePublicBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw public bandwidth usage data for the current billing cycle." + }, + "billingCyclePublicUsageIn": { + "name": "billingCyclePublicUsageIn", + "type": "decimal", + "form": "relational", + "doc": "The total public inbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicUsageOut": { + "name": "billingCyclePublicUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total public outbound bandwidth for this hardware for the current billing cycle." + }, + "billingCyclePublicUsageTotal": { + "name": "billingCyclePublicUsageTotal", + "type": "unsignedInt", + "form": "relational", + "doc": "The total public bandwidth for this hardware for the current billing cycle." + }, + "lockboxNetworkStorage": { + "name": "lockboxNetworkStorage", + "type": "SoftLayer_Billing_Item_Network_Storage", + "form": "relational", + "doc": "A lockbox account associated with a server." + }, + "monitoringBillingItems": { + "name": "monitoringBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "resource": { + "name": "resource", + "type": "SoftLayer_Hardware_Server", + "form": "relational", + "doc": "The resource for a server billing item." + }, + "resourceTableId": { + "name": "resourceTableId", + "type": "int", + "form": "local", + "doc": "The resource (unique identifier) for a server billing item." + }, + "billingCycleBandwidthUsageCount": { + "name": "billingCycleBandwidthUsageCount", + "type": "unsignedLong", + "form": "count", + "doc": "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." + }, + "billingCyclePrivateBandwidthUsageCount": { + "name": "billingCyclePrivateBandwidthUsageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the raw private bandwidth usage data for the current billing cycle." + }, + "billingCyclePublicBandwidthUsageCount": { + "name": "billingCyclePublicBandwidthUsageCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the raw public bandwidth usage data for the current billing cycle." + }, + "monitoringBillingItemCount": { + "name": "monitoringBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." + }, + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + }, + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." + }, + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" + }, + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." + }, + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." + }, + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true + }, + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." + }, + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's bundled billing items." + }, + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "cancellationReason": { + "name": "cancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "form": "relational", + "doc": "The billing item's cancellation reason." + }, + "cancellationRequests": { + "name": "cancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", + "typeArray": true, + "doc": "This will return any cancellation requests that are associated with this billing item." + }, + "category": { + "name": "category", + "type": "SoftLayer_Product_Item_Category", + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " + }, + "children": { + "name": "children", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items'" + }, "childrenWithActiveAgreement": { "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", @@ -27200,352 +30987,26 @@ "form": "count", "doc": "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." } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } } }, - "SoftLayer_Billing_Item_Network_Bandwidth": { - "name": "SoftLayer_Billing_Item_Network_Bandwidth", + "SoftLayer_Billing_Item_Network_Application_Delivery_Controller": { + "name": "SoftLayer_Billing_Item_Network_Application_Delivery_Controller", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] + "typeDoc": "The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to a NetScaler VPX ", + "properties": { + "bandwidthAllotmentDetail": { + "name": "bandwidthAllotmentDetail", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment_Detail", + "form": "relational", + "doc": "The bandwidth allotment detail for a billing item." }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Application_Delivery_Controller", + "form": "relational", + "doc": "The network application controller that a billing item is associated with." }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - }, - "properties": { "account": { "name": "account", "type": "SoftLayer_Account", @@ -28169,717 +31630,80 @@ "form": "count", "doc": "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." } - } - }, - "SoftLayer_Billing_Item_Network_Firewall": { - "name": "SoftLayer_Billing_Item_Network_Firewall", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Firewall data type contains general information relating to a single SoftLayer billing item whose item category code is 'firewall' ", - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Component_Firewall", - "form": "relational", - "doc": "The VLAN firewall that a VLAN firewall billing item is associated with." - }, - "account": { - "name": "account", - "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." - }, - "activeAgreement": { - "name": "activeAgreement", - "type": "SoftLayer_Account_Agreement", - "form": "relational" + }, + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", - "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "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. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getObject": { + "name": "getObject", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true }, - "activeBundledItems": { - "name": "activeBundledItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active bundled billing items." - }, - "activeCancellationItem": { - "name": "activeCancellationItem", - "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." - }, - "activeChildren": { - "name": "activeChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active child billing items." - }, - "activeFlag": { - "name": "activeFlag", - "type": "boolean", - "form": "relational" - }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true - }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." - }, - "associatedBillingItem": { - "name": "associatedBillingItem", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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": { - "name": "associatedBillingItemHistory", - "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", - "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." - }, - "associatedChildren": { - "name": "associatedChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." - }, - "associatedParent": { - "name": "associatedParent", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." - }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", - "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true - }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", - "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." - }, - "billableChildren": { - "name": "billableChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." - }, - "bundledItems": { - "name": "bundledItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's bundled billing items." - }, - "canceledChildren": { - "name": "canceledChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active child billing items." - }, - "cancellationReason": { - "name": "cancellationReason", - "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." - }, - "cancellationRequests": { - "name": "cancellationRequests", - "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", - "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." - }, - "category": { - "name": "category", - "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " - }, - "children": { - "name": "children", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's child billing items'" - }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active child billing items." - }, - "downgradeItems": { - "name": "downgradeItems", - "type": "SoftLayer_Product_Item", - "form": "relational", - "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." - }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." - }, - "hourlyFlag": { - "name": "hourlyFlag", - "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." - }, - "invoiceItem": { - "name": "invoiceItem", - "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" - }, - "invoiceItems": { - "name": "invoiceItems", - "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "typeArray": true, - "doc": "All invoice items associated with the billing item" - }, - "item": { - "name": "item", - "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." - }, - "location": { - "name": "location", - "type": "SoftLayer_Location", - "form": "relational", - "doc": "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": { - "name": "nextInvoiceChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" - }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", - "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" - }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", - "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" - }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", - "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" - }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", - "type": "float", - "form": "relational", - "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." - }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." - }, - "orderItem": { - "name": "orderItem", - "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." - }, - "originalLocation": { - "name": "originalLocation", - "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." - }, - "package": { - "name": "package", - "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." - }, - "parent": { - "name": "parent", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." - }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", - "type": "SoftLayer_Billing_Item_Virtual_Guest", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." - }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", - "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." - }, - "pendingOrderItem": { - "name": "pendingOrderItem", - "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." - }, - "provisionTransaction": { - "name": "provisionTransaction", - "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" - }, - "softwareDescription": { - "name": "softwareDescription", - "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" - }, - "upgradeItem": { - "name": "upgradeItem", - "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." - }, - "upgradeItems": { - "name": "upgradeItems", - "type": "SoftLayer_Product_Item", - "form": "relational", - "typeArray": true, - "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." - }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", - "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " - }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", - "type": "string", - "form": "local", - "doc": "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](/reference/datatypes/$1/#$2). 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. " - }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", - "form": "local", - "doc": "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. " - }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "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." - }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." - }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", - "type": "string", - "form": "local", - "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " - }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of a billing item." - }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name is provided for server billing items." - }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname is provided for server billing items" - }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " - }, - "hoursUsed": { - "name": "hoursUsed", - "type": "string", - "form": "local", - "doc": "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. " - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for this billing item." - }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." - }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." - }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a billing item was last modified." - }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", - "form": "local", - "doc": "The date on which your account will be charged for this billing item. " - }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "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." - }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " - }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." - }, - "orderItemId": { - "name": "orderItemId", - "type": "int", - "form": "local", - "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." - }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." - }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." - }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " - }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." - }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", - "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." - }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local", - "doc": "This is the service provider for this billing item. " - }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." - }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." - }, - "activeAssociatedChildrenCount": { - "name": "activeAssociatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." - }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." - }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." - }, - "associatedChildrenCount": { - "name": "associatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "associatedParentCount": { - "name": "associatedParentCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "billableChildrenCount": { - "name": "billableChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." - }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." - }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "cancellationRequestCount": { - "name": "cancellationRequestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this will return any cancellation requests that are associated with this billing item." - }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items'" - }, - "childrenWithActiveAgreementCount": { - "name": "childrenWithActiveAgreementCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "downgradeItemCount": { - "name": "downgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of for product items which have a downgrade path defined, this will return those product items." - }, - "filteredNextInvoiceChildrenCount": { - "name": "filteredNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." - }, - "invoiceItemCount": { - "name": "invoiceItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of all invoice items associated with the billing item" - }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" - }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." - }, - "upgradeItemCount": { - "name": "upgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", "type": "SoftLayer_Billing_Item", "typeArray": true, "doc": "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. \n\nIn 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. ", @@ -28974,645 +31798,575 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Network_Firewall_Module_Context": { - "name": "SoftLayer_Billing_Item_Network_Firewall_Module_Context", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Firewall_Module_Context data type describes the billing items related to VLAN Firewalls. ", - "properties": { - "billingCyclePublicUsageOut": { - "name": "billingCyclePublicUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total public outbound bandwidth for this firewall for the current billing cycle." }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", - "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", "type": "float", - "form": "relational", - "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItem": { - "name": "orderItem", + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "originalLocation": { - "name": "originalLocation", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "package": { - "name": "package", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parent": { - "name": "parent", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingOrderItem": { - "name": "pendingOrderItem", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "provisionTransaction": { - "name": "provisionTransaction", + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "softwareDescription": { - "name": "softwareDescription", + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItem": { - "name": "upgradeItem", + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItems": { - "name": "upgradeItems", + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." - }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", - "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " - }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", - "type": "string", - "form": "local", - "doc": "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](/reference/datatypes/$1/#$2). 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. " - }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", - "form": "local", - "doc": "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. " - }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "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." - }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." - }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", - "type": "string", - "form": "local", - "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " - }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of a billing item." - }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name is provided for server billing items." - }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname is provided for server billing items" - }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " - }, - "hoursUsed": { - "name": "hoursUsed", - "type": "string", - "form": "local", - "doc": "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. " - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for this billing item." - }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." - }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." - }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a billing item was last modified." - }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", - "form": "local", - "doc": "The date on which your account will be charged for this billing item. " - }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "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." - }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " - }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." - }, - "orderItemId": { - "name": "orderItemId", - "type": "int", - "form": "local", - "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." - }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." - }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." - }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " - }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." - }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", - "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." - }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local", - "doc": "This is the service provider for this billing item. " - }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." - }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." - }, - "activeAssociatedChildrenCount": { - "name": "activeAssociatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." - }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." - }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." - }, - "associatedChildrenCount": { - "name": "associatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "associatedParentCount": { - "name": "associatedParentCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "billableChildrenCount": { - "name": "billableChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." - }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." - }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "cancellationRequestCount": { - "name": "cancellationRequestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this will return any cancellation requests that are associated with this billing item." - }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items'" - }, - "childrenWithActiveAgreementCount": { - "name": "childrenWithActiveAgreementCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "downgradeItemCount": { - "name": "downgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of for product items which have a downgrade path defined, this will return those product items." - }, - "filteredNextInvoiceChildrenCount": { - "name": "filteredNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." - }, - "invoiceItemCount": { - "name": "invoiceItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of all invoice items associated with the billing item" - }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" - }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." - }, - "upgradeItemCount": { - "name": "upgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } - }, + } + }, + "SoftLayer_Billing_Item_Network_Bandwidth": { + "name": "SoftLayer_Billing_Item_Network_Bandwidth", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -29780,223 +32534,772 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Network_Interconnect": { - "name": "SoftLayer_Billing_Item_Network_Interconnect", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "A SoftLayer_Billing_Item_Network_Interconnect represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a network interconnect instance. ", - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Interconnect_Tenant", - "form": "relational", - "doc": "The interconnect tenant that the billing item is associated with." }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." + }, + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + }, + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." + }, + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" + }, + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." + }, + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." + }, + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true + }, + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." + }, + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's bundled billing items." + }, + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "cancellationReason": { + "name": "cancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "form": "relational", + "doc": "The billing item's cancellation reason." + }, + "cancellationRequests": { + "name": "cancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", + "typeArray": true, + "doc": "This will return any cancellation requests that are associated with this billing item." + }, + "category": { + "name": "category", + "type": "SoftLayer_Product_Item_Category", + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " + }, + "children": { + "name": "children", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items'" + }, + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "downgradeItems": { + "name": "downgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "For product items which have a downgrade path defined, this will return those product items." + }, + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + }, + "hourlyFlag": { + "name": "hourlyFlag", + "type": "boolean", + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + }, + "invoiceItem": { + "name": "invoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "doc": "Invoice items associated with this billing item" + }, + "invoiceItems": { + "name": "invoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "typeArray": true, + "doc": "All invoice items associated with the billing item" + }, + "item": { + "name": "item", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + }, + "location": { + "name": "location", "type": "SoftLayer_Location", "form": "relational", "doc": "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." @@ -30418,188 +33721,19 @@ "form": "count", "doc": "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." } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } } }, - "SoftLayer_Billing_Item_Network_Interconnect_Routing": { - "name": "SoftLayer_Billing_Item_Network_Interconnect_Routing", + "SoftLayer_Billing_Item_Network_Firewall": { + "name": "SoftLayer_Billing_Item_Network_Firewall", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "A SoftLayer_Billing_Item_Network_Interconnect_Routing represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a network interconnect global routing. ", + "typeDoc": "The SoftLayer_Billing_Item_Network_Firewall data type contains general information relating to a single SoftLayer billing item whose item category code is 'firewall' ", "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Network_Interconnect_Tenant", + "type": "SoftLayer_Network_Component_Firewall", "form": "relational", - "doc": "The interconnect tenant that the billing item is associated with." + "doc": "The VLAN firewall that a VLAN firewall billing item is associated with." }, "account": { "name": "account", @@ -31392,184 +34526,582 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Network_LoadBalancer": { - "name": "SoftLayer_Billing_Item_Network_LoadBalancer", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "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. ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "getObject": { - "name": "getObject", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "typeArray": true, + "ormMethod": true, + "maskable": true, "filterable": true, - "maskable": true + "deprecated": false, + "limitable": true }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, + "ormMethod": true, "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] + "filterable": true, + "deprecated": false, + "limitable": true }, - "removeAssociationId": { - "name": "removeAssociationId", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "setAssociationId": { - "name": "setAssociationId", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "voidCancelService": { - "name": "voidCancelService", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } - }, + } + }, + "SoftLayer_Billing_Item_Network_Firewall_Module_Context": { + "name": "SoftLayer_Billing_Item_Network_Firewall_Module_Context", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Item_Network_Firewall_Module_Context data type describes the billing items related to VLAN Firewalls. ", "properties": { + "billingCyclePublicUsageOut": { + "name": "billingCyclePublicUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total public outbound bandwidth for this firewall for the current billing cycle." + }, "account": { "name": "account", "type": "SoftLayer_Account", @@ -32193,122 +35725,852 @@ "form": "count", "doc": "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." } - } - }, - "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress": { - "name": "SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "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. ", - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_LoadBalancer_VirtualIpAddress", - "form": "relational", - "doc": "The load balancer's virtual IP address that the billing item is associated with." - }, - "account": { - "name": "account", - "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." - }, - "activeAgreement": { - "name": "activeAgreement", - "type": "SoftLayer_Account_Agreement", - "form": "relational" + }, + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", - "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "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. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getObject": { + "name": "getObject", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "doc": "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. \n\nIn 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. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] }, - "activeCancellationItem": { - "name": "activeCancellationItem", - "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] }, - "activeChildren": { - "name": "activeChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active child billing items." + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "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. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] }, - "activeFlag": { - "name": "activeFlag", + "voidCancelService": { + "name": "voidCancelService", "type": "boolean", - "form": "relational" + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItem": { - "name": "associatedBillingItem", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", - "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." - }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", - "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + } + }, + "SoftLayer_Billing_Item_Network_Interconnect": { + "name": "SoftLayer_Billing_Item_Network_Interconnect", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "typeDoc": "A SoftLayer_Billing_Item_Network_Interconnect represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a network interconnect instance. ", + "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Interconnect_Tenant", + "form": "relational", + "doc": "The interconnect tenant that the billing item is associated with." + }, + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." + }, + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + }, + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." + }, + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" + }, + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." + }, + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." + }, + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true + }, + "bandwidthAllocation": { "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", "form": "relational", @@ -32998,995 +37260,581 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Network_Message_Delivery": { - "name": "SoftLayer_Billing_Item_Network_Message_Delivery", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Message_Delivery data describes the related billing item. ", - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Message_Delivery", - "form": "relational", - "doc": "The object this billing item is associated with." }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." - }, - "location": { - "name": "location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", "type": "float", - "form": "relational", - "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItem": { - "name": "orderItem", + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "originalLocation": { - "name": "originalLocation", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "package": { - "name": "package", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parent": { - "name": "parent", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingOrderItem": { - "name": "pendingOrderItem", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "provisionTransaction": { - "name": "provisionTransaction", + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "softwareDescription": { - "name": "softwareDescription", + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" - }, - "upgradeItem": { - "name": "upgradeItem", - "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItems": { - "name": "upgradeItems", + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "typeArray": true, - "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." - }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", - "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " - }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", - "type": "string", - "form": "local", - "doc": "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](/reference/datatypes/$1/#$2). 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. " - }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", - "form": "local", - "doc": "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. " - }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "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." - }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." - }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", - "type": "string", - "form": "local", - "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " - }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of a billing item." - }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name is provided for server billing items." - }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname is provided for server billing items" - }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " - }, - "hoursUsed": { - "name": "hoursUsed", - "type": "string", - "form": "local", - "doc": "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. " - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for this billing item." - }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." - }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." - }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a billing item was last modified." - }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", - "form": "local", - "doc": "The date on which your account will be charged for this billing item. " - }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "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." - }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " - }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." - }, - "orderItemId": { - "name": "orderItemId", - "type": "int", - "form": "local", - "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." - }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." - }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." - }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " - }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." - }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", - "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." - }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local", - "doc": "This is the service provider for this billing item. " - }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." - }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." - }, - "activeAssociatedChildrenCount": { - "name": "activeAssociatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." - }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." - }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." - }, - "associatedChildrenCount": { - "name": "associatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "associatedParentCount": { - "name": "associatedParentCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "billableChildrenCount": { - "name": "billableChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." - }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." - }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "cancellationRequestCount": { - "name": "cancellationRequestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this will return any cancellation requests that are associated with this billing item." - }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items'" - }, - "childrenWithActiveAgreementCount": { - "name": "childrenWithActiveAgreementCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "downgradeItemCount": { - "name": "downgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of for product items which have a downgrade path defined, this will return those product items." - }, - "filteredNextInvoiceChildrenCount": { - "name": "filteredNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." - }, - "invoiceItemCount": { - "name": "invoiceItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of all invoice items associated with the billing item" - }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" - }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." - }, - "upgradeItemCount": { - "name": "upgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "typeArray": null, + "ormMethod": true, + "maskable": true, "filterable": true, - "maskable": true + "deprecated": false }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, + "ormMethod": true, "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] + "filterable": true, + "deprecated": false, + "limitable": true } } }, - "SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi": { - "name": "SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi", - "base": "SoftLayer_Billing_Item_Network_Storage", + "SoftLayer_Billing_Item_Network_Interconnect_Routing": { + "name": "SoftLayer_Billing_Item_Network_Interconnect_Routing", + "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "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' ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - }, + "typeDoc": "A SoftLayer_Billing_Item_Network_Interconnect_Routing represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a network interconnect global routing. ", "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Network_Storage", + "type": "SoftLayer_Network_Interconnect_Tenant", "form": "relational", - "doc": "The StorageLayer account that a network storage billing item is associated with." + "doc": "The interconnect tenant that the billing item is associated with." }, "account": { "name": "account", @@ -34611,13 +38459,7 @@ "form": "count", "doc": "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." } - } - }, - "SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs": { - "name": "SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs", - "base": "SoftLayer_Billing_Item_Network_Storage", - "noservice": true, - "typeDoc": "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' ", + }, "methods": { "cancelItem": { "name": "cancelItem", @@ -34785,652 +38627,1306 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - }, - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Storage", - "form": "relational", - "doc": "The StorageLayer account that a network storage billing item is associated with." }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", "type": "float", - "form": "relational", - "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItem": { - "name": "orderItem", + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "originalLocation": { - "name": "originalLocation", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "package": { - "name": "package", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parent": { - "name": "parent", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingOrderItem": { - "name": "pendingOrderItem", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "provisionTransaction": { - "name": "provisionTransaction", + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "softwareDescription": { - "name": "softwareDescription", + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItem": { - "name": "upgradeItem", + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItems": { - "name": "upgradeItems", + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." - }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", - "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " - }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", - "type": "string", - "form": "local", - "doc": "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](/reference/datatypes/$1/#$2). 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. " + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + } + }, + "SoftLayer_Billing_Item_Network_LoadBalancer": { + "name": "SoftLayer_Billing_Item_Network_LoadBalancer", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "typeDoc": "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. ", + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", - "form": "local", - "doc": "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. " + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "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. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "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." + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", - "type": "string", - "form": "local", - "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "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. \n\nIn 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. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of a billing item." + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "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. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name is provided for server billing items." + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname is provided for server billing items" + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "hoursUsed": { - "name": "hoursUsed", - "type": "string", - "form": "local", - "doc": "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. " + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for this billing item." + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a billing item was last modified." + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", - "form": "local", - "doc": "The date on which your account will be charged for this billing item. " + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "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." + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "orderItemId": { - "name": "orderItemId", - "type": "int", - "form": "local", - "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", - "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local", - "doc": "This is the service provider for this billing item. " + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildrenCount": { - "name": "activeAssociatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedChildrenCount": { - "name": "associatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedParentCount": { - "name": "associatedParentCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildrenCount": { - "name": "billableChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequestCount": { - "name": "cancellationRequestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this will return any cancellation requests that are associated with this billing item." + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items'" + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "childrenWithActiveAgreementCount": { - "name": "childrenWithActiveAgreementCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "downgradeItemCount": { - "name": "downgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of for product items which have a downgrade path defined, this will return those product items." + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildrenCount": { - "name": "filteredNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItemCount": { - "name": "invoiceItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of all invoice items associated with the billing item" + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItemCount": { - "name": "upgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } - } - }, - "SoftLayer_Billing_Item_Network_Storage": { - "name": "SoftLayer_Billing_Item_Network_Storage", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts. ", + }, "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Storage", - "form": "relational", - "doc": "The StorageLayer account that a network storage billing item is associated with." - }, "account": { "name": "account", "type": "SoftLayer_Account", @@ -36054,357 +40550,19 @@ "form": "count", "doc": "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." } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } } }, - "SoftLayer_Billing_Item_Network_Storage_Hub": { - "name": "SoftLayer_Billing_Item_Network_Storage_Hub", - "base": "SoftLayer_Billing_Item_Network_Storage", + "SoftLayer_Billing_Item_Network_Message_Delivery": { + "name": "SoftLayer_Billing_Item_Network_Message_Delivery", + "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Storage_Hub models all billing items related to hub-based StorageLayer offerings, such as CloudLayer storage. ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - }, + "typeDoc": "The SoftLayer_Billing_Item_Network_Message_Delivery data describes the related billing item. ", "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Network_Storage", + "type": "SoftLayer_Network_Message_Delivery", "form": "relational", - "doc": "The StorageLayer account that a network storage billing item is associated with." + "doc": "The object this billing item is associated with." }, "account": { "name": "account", @@ -37029,13 +41187,7 @@ "form": "count", "doc": "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." } - } - }, - "SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth": { - "name": "SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth", - "base": "SoftLayer_Billing_Item_Network_Storage", - "noservice": true, - "typeDoc": "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. ", + }, "methods": { "cancelItem": { "name": "cancelItem", @@ -37203,663 +41355,1311 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - }, - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Storage", - "form": "relational", - "doc": "The StorageLayer account that a network storage billing item is associated with." }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", "type": "float", - "form": "relational", - "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItem": { - "name": "orderItem", + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "originalLocation": { - "name": "originalLocation", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "package": { - "name": "package", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parent": { - "name": "parent", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingOrderItem": { - "name": "pendingOrderItem", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "provisionTransaction": { - "name": "provisionTransaction", + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "softwareDescription": { - "name": "softwareDescription", + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItem": { - "name": "upgradeItem", + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItems": { - "name": "upgradeItems", + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + } + }, + "SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi": { + "name": "SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi", + "base": "SoftLayer_Billing_Item_Network_Storage", + "noservice": true, + "typeDoc": "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' ", + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", - "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "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. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", - "type": "string", - "form": "local", - "doc": "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](/reference/datatypes/$1/#$2). 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. " + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", - "form": "local", - "doc": "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. " + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "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." + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "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. \n\nIn 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. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", - "type": "string", - "form": "local", - "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "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. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of a billing item." + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name is provided for server billing items." + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname is provided for server billing items" + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hoursUsed": { - "name": "hoursUsed", - "type": "string", - "form": "local", - "doc": "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. " + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for this billing item." + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a billing item was last modified." + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", - "form": "local", - "doc": "The date on which your account will be charged for this billing item. " + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "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." + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItemId": { - "name": "orderItemId", - "type": "int", - "form": "local", - "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", - "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local", - "doc": "This is the service provider for this billing item. " + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildrenCount": { - "name": "activeAssociatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildrenCount": { - "name": "associatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedParentCount": { - "name": "associatedParentCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "billableChildrenCount": { - "name": "billableChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequestCount": { - "name": "cancellationRequestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this will return any cancellation requests that are associated with this billing item." + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items'" + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreementCount": { - "name": "childrenWithActiveAgreementCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "downgradeItemCount": { - "name": "downgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of for product items which have a downgrade path defined, this will return those product items." + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "filteredNextInvoiceChildrenCount": { - "name": "filteredNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItemCount": { - "name": "invoiceItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of all invoice items associated with the billing item" + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItemCount": { - "name": "upgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } - } - }, - "SoftLayer_Billing_Item_Network_Subnet": { - "name": "SoftLayer_Billing_Item_Network_Subnet", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "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: \n* pri_ip_address\n* static_sec_ip_addresses (static secondary)\n* sov_sec_ip_addresses (secondary on vlan, also known as \"portable ips\")\n* sov_sec_ip_addresses_pub (sov_sec_ip_addresses public only)\n* sov_sec_ip_addresses_priv (sov_sec_ip_addresses private only)\n* sec_ip_addresses (old style, secondary ip addresses)\n\n\nThese item categories denote that the billing item has subnet information attached. ", + }, "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Network_Subnet", + "type": "SoftLayer_Network_Storage", "form": "relational", - "doc": "The resource for a subnet-related billing item." - }, - "resourceName": { - "name": "resourceName", - "type": "string", - "form": "local", - "doc": "The resource name for a subnet billing item." - }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a server billing item." + "doc": "The StorageLayer account that a network storage billing item is associated with." }, "account": { "name": "account", @@ -38484,182 +43284,13 @@ "form": "count", "doc": "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." } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } } }, - "SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global": { - "name": "SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global", - "base": "SoftLayer_Billing_Item_Network_Subnet", + "SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs": { + "name": "SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs", + "base": "SoftLayer_Billing_Item_Network_Storage", "noservice": true, - "typeDoc": "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: \n* global_ipv4\n* global_ipv6\n\n\nThese item categories denote that the billing item has subnet information attached. ", + "typeDoc": "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' ", "methods": { "cancelItem": { "name": "cancelItem", @@ -38827,143 +43458,692 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - }, - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Subnet", - "form": "relational", - "doc": "The resource for a subnet-related billing item." - }, - "resourceName": { - "name": "resourceName", - "type": "string", - "form": "local", - "doc": "The resource name for a subnet billing item." - }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a server billing item." }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Storage", + "form": "relational", + "doc": "The StorageLayer account that a network storage billing item is associated with." + }, + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." + }, + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + }, + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." + }, + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" + }, + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." + }, + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." + }, + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true + }, + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." + }, + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", "form": "relational", "typeArray": true, @@ -39473,17 +44653,17 @@ } } }, - "SoftLayer_Billing_Item_Network_Tunnel": { - "name": "SoftLayer_Billing_Item_Network_Tunnel", + "SoftLayer_Billing_Item_Network_Storage": { + "name": "SoftLayer_Billing_Item_Network_Storage", "base": "SoftLayer_Billing_Item", "noservice": true, "typeDoc": "The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts. ", "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Network_Tunnel_Module_Context", + "type": "SoftLayer_Network_Storage", "form": "relational", - "doc": "The IPsec VPN that a network tunnel billing item is associated with." + "doc": "The StorageLayer account that a network storage billing item is associated with." }, "account": { "name": "account", @@ -40276,645 +45456,575 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Network_Vlan": { - "name": "SoftLayer_Billing_Item_Network_Vlan", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "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: \n* network_vlan\n\n\nThese item categories denote that the billing item has network vlan information attached. ", - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Vlan", - "form": "relational", - "doc": "The network vlan resource for this billing item." }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", "type": "float", - "form": "relational", - "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItem": { - "name": "orderItem", + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "originalLocation": { - "name": "originalLocation", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "package": { - "name": "package", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parent": { - "name": "parent", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingOrderItem": { - "name": "pendingOrderItem", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "provisionTransaction": { - "name": "provisionTransaction", + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "softwareDescription": { - "name": "softwareDescription", + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItem": { - "name": "upgradeItem", + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItems": { - "name": "upgradeItems", + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." - }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", - "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " - }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", - "type": "string", - "form": "local", - "doc": "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](/reference/datatypes/$1/#$2). 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. " - }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", - "form": "local", - "doc": "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. " - }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "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." - }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." - }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", - "type": "string", - "form": "local", - "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " - }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of a billing item." - }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name is provided for server billing items." - }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname is provided for server billing items" - }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " - }, - "hoursUsed": { - "name": "hoursUsed", - "type": "string", - "form": "local", - "doc": "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. " - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for this billing item." - }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." - }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." - }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a billing item was last modified." - }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", - "form": "local", - "doc": "The date on which your account will be charged for this billing item. " - }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "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." - }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " - }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." - }, - "orderItemId": { - "name": "orderItemId", - "type": "int", - "form": "local", - "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." - }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." - }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." - }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " - }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." - }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", - "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." - }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local", - "doc": "This is the service provider for this billing item. " - }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." - }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." - }, - "activeAssociatedChildrenCount": { - "name": "activeAssociatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." - }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." - }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." - }, - "associatedChildrenCount": { - "name": "associatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "associatedParentCount": { - "name": "associatedParentCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "billableChildrenCount": { - "name": "billableChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." - }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." - }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "cancellationRequestCount": { - "name": "cancellationRequestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this will return any cancellation requests that are associated with this billing item." - }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items'" - }, - "childrenWithActiveAgreementCount": { - "name": "childrenWithActiveAgreementCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "downgradeItemCount": { - "name": "downgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of for product items which have a downgrade path defined, this will return those product items." - }, - "filteredNextInvoiceChildrenCount": { - "name": "filteredNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." - }, - "invoiceItemCount": { - "name": "invoiceItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of all invoice items associated with the billing item" - }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" - }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." - }, - "upgradeItemCount": { - "name": "upgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } - }, + } + }, + "SoftLayer_Billing_Item_Network_Storage_Hub": { + "name": "SoftLayer_Billing_Item_Network_Storage_Hub", + "base": "SoftLayer_Billing_Item_Network_Storage", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Item_Network_Storage_Hub models all billing items related to hub-based StorageLayer offerings, such as CloudLayer storage. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -41082,183 +46192,576 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_NewCustomerSetup": { - "name": "SoftLayer_Billing_Item_NewCustomerSetup", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "getObject": { - "name": "getObject", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "typeArray": true, + "ormMethod": true, + "maskable": true, "filterable": true, - "maskable": true + "deprecated": false, + "limitable": true }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, + "ormMethod": true, "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] + "filterable": true, + "deprecated": false, + "limitable": true }, - "removeAssociationId": { - "name": "removeAssociationId", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "setAssociationId": { - "name": "setAssociationId", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "voidCancelService": { - "name": "voidCancelService", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } }, "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Storage", + "form": "relational", + "doc": "The StorageLayer account that a network storage billing item is associated with." + }, "account": { "name": "account", "type": "SoftLayer_Account", @@ -41884,11 +47387,11 @@ } } }, - "SoftLayer_Billing_Item_Private_Cloud": { - "name": "SoftLayer_Billing_Item_Private_Cloud", - "base": "SoftLayer_Billing_Item", + "SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth": { + "name": "SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth", + "base": "SoftLayer_Billing_Item_Network_Storage", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Private_Cloud data type contains general information relating to a single billing item for a private cloud. ", + "typeDoc": "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. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -42056,185 +47559,752 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - }, - "properties": { - "account": { - "name": "account", + }, + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Storage", + "form": "relational", + "doc": "The StorageLayer account that a network storage billing item is associated with." + }, + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." + }, + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + }, + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." + }, + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" + }, + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." + }, + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." + }, + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true + }, + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." + }, + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's bundled billing items." + }, + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "cancellationReason": { + "name": "cancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "form": "relational", + "doc": "The billing item's cancellation reason." + }, + "cancellationRequests": { + "name": "cancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", + "typeArray": true, + "doc": "This will return any cancellation requests that are associated with this billing item." + }, + "category": { + "name": "category", + "type": "SoftLayer_Product_Item_Category", + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " + }, + "children": { + "name": "children", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items'" + }, + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "downgradeItems": { + "name": "downgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "For product items which have a downgrade path defined, this will return those product items." + }, + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + }, + "hourlyFlag": { "name": "hourlyFlag", "type": "boolean", "form": "relational", @@ -42684,23 +48754,29 @@ } } }, - "SoftLayer_Billing_Item_Software_Component": { - "name": "SoftLayer_Billing_Item_Software_Component", + "SoftLayer_Billing_Item_Network_Subnet": { + "name": "SoftLayer_Billing_Item_Network_Subnet", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components. ", + "typeDoc": "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: \n* pri_ip_address\n* static_sec_ip_addresses (static secondary)\n* sov_sec_ip_addresses (secondary on vlan, also known as \"portable ips\")\n* sov_sec_ip_addresses_pub (sov_sec_ip_addresses public only)\n* sov_sec_ip_addresses_priv (sov_sec_ip_addresses private only)\n* sec_ip_addresses (old style, secondary ip addresses)\n\n\nThese item categories denote that the billing item has subnet information attached. ", "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Software_Component", + "type": "SoftLayer_Network_Subnet", "form": "relational", - "doc": "The software component that this billing item points to." + "doc": "The resource for a subnet-related billing item." + }, + "resourceName": { + "name": "resourceName", + "type": "string", + "form": "local", + "doc": "The resource name for a subnet billing item." }, "resourceTableId": { "name": "resourceTableId", "type": "int", "form": "local", - "doc": "The resource (unique identifier) for a software component billing item." + "doc": "The resource (unique identifier) for a server billing item." }, "account": { "name": "account", @@ -43493,14 +49569,575 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] + }, + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } } }, - "SoftLayer_Billing_Item_Software_Component_Analytics_Urchin": { - "name": "SoftLayer_Billing_Item_Software_Component_Analytics_Urchin", - "base": "SoftLayer_Billing_Item", + "SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global": { + "name": "SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global", + "base": "SoftLayer_Billing_Item_Network_Subnet", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Software_Component_Analytics_Urchin data type contains general information relating to a single SoftLayer billing item for Urchin software components. ", + "typeDoc": "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: \n* global_ipv4\n* global_ipv6\n\n\nThese item categories denote that the billing item has subnet information attached. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -43668,233 +50305,812 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - }, - "properties": { - "account": { - "name": "account", + }, + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Subnet", + "form": "relational", + "doc": "The resource for a subnet-related billing item." + }, + "resourceName": { + "name": "resourceName", + "type": "string", + "form": "local", + "doc": "The resource name for a subnet billing item." + }, + "resourceTableId": { + "name": "resourceTableId", + "type": "int", + "form": "local", + "doc": "The resource (unique identifier) for a server billing item." + }, + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." + }, + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + }, + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." + }, + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" + }, + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." + }, + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." + }, + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true + }, + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." + }, + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's bundled billing items." + }, + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "cancellationReason": { + "name": "cancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "form": "relational", + "doc": "The billing item's cancellation reason." + }, + "cancellationRequests": { + "name": "cancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", + "typeArray": true, + "doc": "This will return any cancellation requests that are associated with this billing item." + }, + "category": { + "name": "category", + "type": "SoftLayer_Product_Item_Category", + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " + }, + "children": { + "name": "children", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items'" + }, + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "downgradeItems": { + "name": "downgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "For product items which have a downgrade path defined, this will return those product items." + }, + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + }, + "hourlyFlag": { + "name": "hourlyFlag", + "type": "boolean", + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + }, + "invoiceItem": { + "name": "invoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "doc": "Invoice items associated with this billing item" + }, + "invoiceItems": { + "name": "invoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "typeArray": true, + "doc": "All invoice items associated with the billing item" + }, + "item": { + "name": "item", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + }, + "location": { + "name": "location", + "type": "SoftLayer_Location", + "form": "relational", + "doc": "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": { + "name": "nextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items and associated items'" + }, + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" + }, + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, "nextInvoiceTotalRecurringAmount": { "name": "nextInvoiceTotalRecurringAmount", @@ -44296,181 +51512,18 @@ } } }, - "SoftLayer_Billing_Item_Software_Component_ControlPanel": { - "name": "SoftLayer_Billing_Item_Software_Component_ControlPanel", + "SoftLayer_Billing_Item_Network_Tunnel": { + "name": "SoftLayer_Billing_Item_Network_Tunnel", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains general information relating to a single SoftLayer billing item for control panel software components. ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - }, + "typeDoc": "The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts. ", "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Tunnel_Module_Context", + "form": "relational", + "doc": "The IPsec VPN that a network tunnel billing item is associated with." + }, "account": { "name": "account", "type": "SoftLayer_Account", @@ -45094,13 +52147,7 @@ "form": "count", "doc": "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." } - } - }, - "SoftLayer_Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing": { - "name": "SoftLayer_Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains general information relating to a single SoftLayer billing item for control panel software components. ", + }, "methods": { "cancelItem": { "name": "cancelItem", @@ -45268,9 +52315,582 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] + }, + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } - }, + } + }, + "SoftLayer_Billing_Item_Network_Vlan": { + "name": "SoftLayer_Billing_Item_Network_Vlan", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "typeDoc": "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: \n* network_vlan\n\n\nThese item categories denote that the billing item has network vlan information attached. ", "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "doc": "The network vlan resource for this billing item." + }, "account": { "name": "account", "type": "SoftLayer_Account", @@ -45894,13 +53514,7 @@ "form": "count", "doc": "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." } - } - }, - "SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon": { - "name": "SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "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. ", + }, "methods": { "cancelItem": { "name": "cancelItem", @@ -46068,810 +53682,1469 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - }, - "properties": { - "account": { - "name": "account", + }, + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" - }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", - "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", "type": "float", - "form": "relational", - "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItem": { - "name": "orderItem", + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "originalLocation": { - "name": "originalLocation", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "package": { - "name": "package", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parent": { - "name": "parent", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingOrderItem": { - "name": "pendingOrderItem", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "provisionTransaction": { - "name": "provisionTransaction", + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "softwareDescription": { - "name": "softwareDescription", + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItem": { - "name": "upgradeItem", + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItems": { - "name": "upgradeItems", + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." - }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", - "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " - }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", - "type": "string", - "form": "local", - "doc": "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](/reference/datatypes/$1/#$2). 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. " - }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", - "form": "local", - "doc": "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. " - }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "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." - }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." - }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", - "type": "string", - "form": "local", - "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " - }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of a billing item." - }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name is provided for server billing items." - }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname is provided for server billing items" - }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " - }, - "hoursUsed": { - "name": "hoursUsed", - "type": "string", - "form": "local", - "doc": "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. " - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for this billing item." - }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." - }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." - }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a billing item was last modified." - }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", - "form": "local", - "doc": "The date on which your account will be charged for this billing item. " - }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "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." - }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " - }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." - }, - "orderItemId": { - "name": "orderItemId", - "type": "int", - "form": "local", - "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." - }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." - }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." - }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " - }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." - }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", - "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." - }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local", - "doc": "This is the service provider for this billing item. " - }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." - }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." - }, - "activeAssociatedChildrenCount": { - "name": "activeAssociatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." - }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." - }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." - }, - "associatedChildrenCount": { - "name": "associatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "associatedParentCount": { - "name": "associatedParentCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "billableChildrenCount": { - "name": "billableChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." - }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." - }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "cancellationRequestCount": { - "name": "cancellationRequestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this will return any cancellation requests that are associated with this billing item." - }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + } + }, + "SoftLayer_Billing_Item_NewCustomerSetup": { + "name": "SoftLayer_Billing_Item_NewCustomerSetup", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] }, - "childrenWithActiveAgreementCount": { - "name": "childrenWithActiveAgreementCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "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. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "downgradeItemCount": { - "name": "downgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of for product items which have a downgrade path defined, this will return those product items." + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "filteredNextInvoiceChildrenCount": { - "name": "filteredNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true }, - "invoiceItemCount": { - "name": "invoiceItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of all invoice items associated with the billing item" + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "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. \n\nIn 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. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "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. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] }, - "upgradeItemCount": { - "name": "upgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - } - } - }, - "SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials": { - "name": "SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials", - "base": "SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon", - "noservice": true, - "typeDoc": "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. ", - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Software_Component", - "form": "relational", - "doc": "The Citrix Essentials software component that a billing item is associated with." + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." - }, - "downgradeItems": { - "name": "downgradeItems", - "type": "SoftLayer_Product_Item", + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." + }, + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + }, + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." + }, + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" + }, + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." + }, + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." + }, + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true + }, + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." + }, + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's bundled billing items." + }, + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "cancellationReason": { + "name": "cancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "form": "relational", + "doc": "The billing item's cancellation reason." + }, + "cancellationRequests": { + "name": "cancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", + "typeArray": true, + "doc": "This will return any cancellation requests that are associated with this billing item." + }, + "category": { + "name": "category", + "type": "SoftLayer_Product_Item_Category", + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " + }, + "children": { + "name": "children", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items'" + }, + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "downgradeItems": { + "name": "downgradeItems", + "type": "SoftLayer_Product_Item", "form": "relational", "typeArray": true, "doc": "For product items which have a downgrade path defined, this will return those product items." @@ -47331,182 +55604,13 @@ "form": "count", "doc": "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." } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } } }, - "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem": { - "name": "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem", + "SoftLayer_Billing_Item_Private_Cloud": { + "name": "SoftLayer_Billing_Item_Private_Cloud", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "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. ", + "typeDoc": "The SoftLayer_Billing_Item_Private_Cloud data type contains general information relating to a single billing item for a private cloud. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -47674,213 +55778,774 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - }, - "properties": { - "account": { - "name": "account", + }, + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." + }, + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + }, + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." + }, + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" + }, + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." + }, + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." + }, + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true + }, + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." + }, + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's bundled billing items." + }, + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "cancellationReason": { + "name": "cancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "form": "relational", + "doc": "The billing item's cancellation reason." + }, + "cancellationRequests": { + "name": "cancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", + "typeArray": true, + "doc": "This will return any cancellation requests that are associated with this billing item." + }, + "category": { + "name": "category", + "type": "SoftLayer_Product_Item_Category", + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " + }, + "children": { + "name": "children", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items'" + }, + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "downgradeItems": { + "name": "downgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "For product items which have a downgrade path defined, this will return those product items." + }, + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + }, + "hourlyFlag": { + "name": "hourlyFlag", + "type": "boolean", + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + }, + "invoiceItem": { + "name": "invoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "doc": "Invoice items associated with this billing item" + }, + "invoiceItems": { + "name": "invoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "typeArray": true, + "doc": "All invoice items associated with the billing item" + }, + "item": { + "name": "item", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + }, + "location": { + "name": "location", + "type": "SoftLayer_Location", "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." - }, - "location": { - "name": "location", - "type": "SoftLayer_Location", - "form": "relational", "doc": "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": { @@ -48302,23 +56967,23 @@ } } }, - "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft": { - "name": "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft", - "base": "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem", + "SoftLayer_Billing_Item_Software_Component": { + "name": "SoftLayer_Billing_Item_Software_Component", + "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "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. ", + "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components. ", "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Software_VirtualLicense", + "type": "SoftLayer_Software_Component", "form": "relational", - "doc": "The software virtual license to which this billing item points." + "doc": "The software component that this billing item points to." }, "resourceTableId": { "name": "resourceTableId", "type": "int", "form": "local", - "doc": "The resource (unique identifier) for a software virtual license billing item." + "doc": "The resource (unique identifier) for a software component billing item." }, "account": { "name": "account", @@ -49111,651 +57776,575 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat": { - "name": "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat", - "base": "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem", - "noservice": true, - "typeDoc": "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. ", - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Software_Component", - "form": "relational", - "doc": "The software component to which this billing item points." - }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a software component billing item." }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", "type": "float", - "form": "relational", - "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItem": { - "name": "orderItem", + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "originalLocation": { - "name": "originalLocation", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "package": { - "name": "package", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parent": { - "name": "parent", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingOrderItem": { - "name": "pendingOrderItem", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "provisionTransaction": { - "name": "provisionTransaction", + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "softwareDescription": { - "name": "softwareDescription", + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItem": { - "name": "upgradeItem", + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItems": { - "name": "upgradeItems", + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." - }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", - "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " - }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", - "type": "string", - "form": "local", - "doc": "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](/reference/datatypes/$1/#$2). 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. " - }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", - "form": "local", - "doc": "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. " - }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "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." - }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." - }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", - "type": "string", - "form": "local", - "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " - }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of a billing item." - }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name is provided for server billing items." - }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname is provided for server billing items" - }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " - }, - "hoursUsed": { - "name": "hoursUsed", - "type": "string", - "form": "local", - "doc": "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. " - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for this billing item." - }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." - }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." - }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a billing item was last modified." - }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", - "form": "local", - "doc": "The date on which your account will be charged for this billing item. " - }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "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." - }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " - }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." - }, - "orderItemId": { - "name": "orderItemId", - "type": "int", - "form": "local", - "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." - }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." - }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." - }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " - }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." - }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", - "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." - }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local", - "doc": "This is the service provider for this billing item. " - }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." - }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." - }, - "activeAssociatedChildrenCount": { - "name": "activeAssociatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." - }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." - }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." - }, - "associatedChildrenCount": { - "name": "associatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "associatedParentCount": { - "name": "associatedParentCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "billableChildrenCount": { - "name": "billableChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." - }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." - }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "cancellationRequestCount": { - "name": "cancellationRequestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this will return any cancellation requests that are associated with this billing item." - }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items'" - }, - "childrenWithActiveAgreementCount": { - "name": "childrenWithActiveAgreementCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "downgradeItemCount": { - "name": "downgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of for product items which have a downgrade path defined, this will return those product items." - }, - "filteredNextInvoiceChildrenCount": { - "name": "filteredNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." - }, - "invoiceItemCount": { - "name": "invoiceItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of all invoice items associated with the billing item" - }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" - }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." - }, - "upgradeItemCount": { - "name": "upgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } - }, + } + }, + "SoftLayer_Billing_Item_Software_Component_Analytics_Urchin": { + "name": "SoftLayer_Billing_Item_Software_Component_Analytics_Urchin", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Item_Software_Component_Analytics_Urchin data type contains general information relating to a single SoftLayer billing item for Urchin software components. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -49923,36 +58512,585 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Software_License": { - "name": "SoftLayer_Billing_Item_Software_License", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Software_License data type contains general information relating to a single SoftLayer billing item for a software license. ", - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Software_AccountLicense", - "form": "relational", - "doc": "The resource for a software license billing item." }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", "doc": "A flag indicating that the billing item is under an active agreement." }, "activeAssociatedChildren": { @@ -50561,182 +59699,13 @@ "form": "count", "doc": "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." } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } } }, - "SoftLayer_Billing_Item_Support": { - "name": "SoftLayer_Billing_Item_Support", + "SoftLayer_Billing_Item_Software_Component_ControlPanel": { + "name": "SoftLayer_Billing_Item_Software_Component_ControlPanel", "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Support data type contains general information relating to a premium support offering ", + "typeDoc": "The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains general information relating to a single SoftLayer billing item for control panel software components. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -50904,646 +59873,570 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - }, - "properties": { - "account": { - "name": "account", + }, + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", "type": "float", - "form": "relational", - "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItem": { - "name": "orderItem", + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "originalLocation": { - "name": "originalLocation", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "package": { - "name": "package", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parent": { - "name": "parent", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingOrderItem": { - "name": "pendingOrderItem", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "provisionTransaction": { - "name": "provisionTransaction", + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "softwareDescription": { - "name": "softwareDescription", + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItem": { - "name": "upgradeItem", + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItems": { - "name": "upgradeItems", + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." - }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", - "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " - }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", - "type": "string", - "form": "local", - "doc": "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](/reference/datatypes/$1/#$2). 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. " - }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", - "form": "local", - "doc": "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. " - }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "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." - }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." - }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", - "type": "string", - "form": "local", - "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " - }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of a billing item." - }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name is provided for server billing items." - }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname is provided for server billing items" - }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " - }, - "hoursUsed": { - "name": "hoursUsed", - "type": "string", - "form": "local", - "doc": "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. " - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for this billing item." - }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." - }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." - }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." - }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a billing item was last modified." - }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", - "form": "local", - "doc": "The date on which your account will be charged for this billing item. " - }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "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." - }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " - }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." - }, - "orderItemId": { - "name": "orderItemId", - "type": "int", - "form": "local", - "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." - }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." - }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." - }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " - }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." - }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", - "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." - }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local", - "doc": "This is the service provider for this billing item. " - }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." - }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." - }, - "activeAssociatedChildrenCount": { - "name": "activeAssociatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." - }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." - }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." - }, - "associatedChildrenCount": { - "name": "associatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "associatedParentCount": { - "name": "associatedParentCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "billableChildrenCount": { - "name": "billableChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." - }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." - }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "cancellationRequestCount": { - "name": "cancellationRequestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this will return any cancellation requests that are associated with this billing item." - }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items'" - }, - "childrenWithActiveAgreementCount": { - "name": "childrenWithActiveAgreementCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." - }, - "downgradeItemCount": { - "name": "downgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of for product items which have a downgrade path defined, this will return those product items." - }, - "filteredNextInvoiceChildrenCount": { - "name": "filteredNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." - }, - "invoiceItemCount": { - "name": "invoiceItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of all invoice items associated with the billing item" - }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" - }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." - }, - "upgradeItemCount": { - "name": "upgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } - } - }, - "SoftLayer_Billing_Item_User_Customer_External_Binding": { - "name": "SoftLayer_Billing_Item_User_Customer_External_Binding", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to an external authentication binding ", + }, "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_User_Customer_External_Binding", - "form": "relational", - "doc": "The external authentication binding that a billing item is associated with." - }, "account": { "name": "account", "type": "SoftLayer_Account", @@ -52167,7 +61060,13 @@ "form": "count", "doc": "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." } - }, + } + }, + "SoftLayer_Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing": { + "name": "SoftLayer_Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains general information relating to a single SoftLayer billing item for control panel software components. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -52335,224 +61234,698 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Virtual_Dedicated_Rack": { - "name": "SoftLayer_Billing_Item_Virtual_Dedicated_Rack", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "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. ", - "properties": { - "billingCycleBandwidthUsage": { - "name": "billingCycleBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw bandwidth usage data for the current billing cycle. One object is returned for each network a virtual rack is attached to." - }, - "billingCyclePrivateBandwidthUsage": { - "name": "billingCyclePrivateBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePrivateUsageIn": { - "name": "billingCyclePrivateUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total private network inbound bandwidth for this virtual rack for the current billing cycle." - }, - "billingCyclePrivateUsageOut": { - "name": "billingCyclePrivateUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total private network outbound bandwidth for this virtual rack for the current billing cycle." - }, - "billingCyclePrivateUsageTotal": { - "name": "billingCyclePrivateUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total private network bandwidth for this virtual rack for the current billing cycle." - }, - "billingCyclePublicBandwidthUsage": { - "name": "billingCyclePublicBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw public bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicUsageIn": { - "name": "billingCyclePublicUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total public inbound bandwidth for this virtual rack for the current billing cycle." - }, - "billingCyclePublicUsageOut": { - "name": "billingCyclePublicUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total public outbound bandwidth for this virtual rack for the current billing cycle." - }, - "billingCyclePublicUsageTotal": { - "name": "billingCyclePublicUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total public bandwidth for this virtual rack for the current billing cycle." - }, - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", - "form": "relational", - "doc": "The virtual rack that a virtual rack billing item is associated with." - }, - "billingCycleBandwidthUsageCount": { - "name": "billingCycleBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw bandwidth usage data for the current billing cycle. One object is returned for each network a virtual rack is attached to." - }, - "billingCyclePrivateBandwidthUsageCount": { - "name": "billingCyclePrivateBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicBandwidthUsageCount": { - "name": "billingCyclePublicBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw public bandwidth usage data for the current billing cycle." }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." - }, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." + }, + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + }, + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." + }, + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" + }, + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." + }, + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." + }, + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true + }, + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." + }, + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's bundled billing items." + }, + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, "cancellationReason": { "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", @@ -53048,7 +62421,13 @@ "form": "count", "doc": "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." } - }, + } + }, + "SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon": { + "name": "SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "typeDoc": "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. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -53216,189 +62595,6 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Virtual_DedicatedHost": { - "name": "SoftLayer_Billing_Item_Virtual_DedicatedHost", - "base": "SoftLayer_Billing_Item", - "methods": { - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item_Virtual_DedicatedHost", - "docOverview": "Retrieve a SoftLayer_Billing_Item_Virtual_DedicatedHost record.", - "filterable": true, - "maskable": true - }, - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] - }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] - }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] - }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - }, - "getResource": { - "doc": "The resource for a virtual dedicated host billing item.", - "docOverview": "", - "name": "getResource", - "type": "SoftLayer_Virtual_DedicatedHost", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false }, "getAccount": { "doc": "The account that a billing item belongs to.", @@ -53963,18 +63159,6 @@ } }, "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Virtual_DedicatedHost", - "form": "relational", - "doc": "The resource for a virtual dedicated host billing item." - }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a server billing item." - }, "account": { "name": "account", "type": "SoftLayer_Account", @@ -54600,23 +63784,17 @@ } } }, - "SoftLayer_Billing_Item_Virtual_Disk_Image": { - "name": "SoftLayer_Billing_Item_Virtual_Disk_Image", - "base": "SoftLayer_Billing_Item", + "SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials": { + "name": "SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials", + "base": "SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Virtual_Disk_Image data type contains general information relating to a single SoftLayer billing item for disk images. ", + "typeDoc": "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. ", "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Virtual_Disk_Image", + "type": "SoftLayer_Software_Component", "form": "relational", - "doc": "The disk image to which the billing item points." - }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a disk image billing item." + "doc": "The Citrix Essentials software component that a billing item is associated with." }, "account": { "name": "account", @@ -55409,926 +64587,1306 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Virtual_Guest": { - "name": "SoftLayer_Billing_Item_Virtual_Guest", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Virtual_Guest data type contains general information relating to a single SoftLayer billing item for guests. ", - "properties": { - "billingCycleBandwidthUsage": { - "name": "billingCycleBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to." - }, - "billingCyclePrivateBandwidthUsage": { - "name": "billingCyclePrivateBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePrivateUsageIn": { - "name": "billingCyclePrivateUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total private inbound bandwidth for this virtual server for the current billing cycle." - }, - "billingCyclePrivateUsageOut": { - "name": "billingCyclePrivateUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total private outbound bandwidth for this virtual server for the current billing cycle." - }, - "billingCyclePrivateUsageTotal": { - "name": "billingCyclePrivateUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total private bandwidth for this virtual server for the current billing cycle." - }, - "billingCyclePublicBandwidthUsage": { - "name": "billingCyclePublicBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw public bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicUsageIn": { - "name": "billingCyclePublicUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total public inbound bandwidth for this virtual server for the current billing cycle." - }, - "billingCyclePublicUsageOut": { - "name": "billingCyclePublicUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total public outbound bandwidth for this virtual server for the current billing cycle." - }, - "billingCyclePublicUsageTotal": { - "name": "billingCyclePublicUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total public bandwidth for this virtual server for the current billing cycle." - }, - "monitoringBillingItems": { - "name": "monitoringBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true - }, - "resource": { - "name": "resource", - "type": "SoftLayer_Virtual_Guest", - "form": "relational", - "doc": "The resource for a cloud server billing item." - }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a server billing item." - }, - "billingCycleBandwidthUsageCount": { - "name": "billingCycleBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - }, - "billingCyclePrivateBandwidthUsageCount": { - "name": "billingCyclePrivateBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw private bandwidth usage data for the current billing cycle." - }, - "billingCyclePublicBandwidthUsageCount": { - "name": "billingCyclePublicBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw public bandwidth usage data for the current billing cycle." - }, - "monitoringBillingItemCount": { - "name": "monitoringBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " }, - "account": { - "name": "account", + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreement": { - "name": "activeAgreement", + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", "type": "SoftLayer_Account_Agreement", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItems": { - "name": "activeBundledItems", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeCancellationItem": { - "name": "activeCancellationItem", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildren": { - "name": "activeChildren", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeFlag": { - "name": "activeFlag", + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItem": { - "name": "associatedBillingItem", + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedBillingItemHistory": { - "name": "associatedBillingItemHistory", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", - "form": "relational", "typeArray": true, - "doc": "A history of billing items which a billing item has been associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildren": { - "name": "associatedChildren", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedParent": { - "name": "associatedParent", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billableChildren": { - "name": "billableChildren", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "bundledItems": { - "name": "bundledItems", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "canceledChildren": { - "name": "canceledChildren", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationReason": { - "name": "cancellationReason", + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancellationRequests": { - "name": "cancellationRequests", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", - "form": "relational", "typeArray": true, - "doc": "This will return any cancellation requests that are associated with this billing item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "category": { - "name": "category", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "children": { - "name": "children", + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "downgradeItems": { - "name": "downgradeItems", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hourlyFlag": { - "name": "hourlyFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItem": { - "name": "invoiceItem", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "invoiceItems": { - "name": "invoiceItems", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", "typeArray": true, - "doc": "All invoice items associated with the billing item" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "item": { - "name": "item", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "location": { - "name": "location", + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", "type": "float", - "form": "relational", - "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItem": { - "name": "orderItem", + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "originalLocation": { - "name": "originalLocation", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "package": { - "name": "package", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parent": { - "name": "parent", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "pendingOrderItem": { - "name": "pendingOrderItem", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "provisionTransaction": { - "name": "provisionTransaction", + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "softwareDescription": { - "name": "softwareDescription", + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItem": { - "name": "upgradeItem", + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItems": { - "name": "upgradeItems", + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", "type": "SoftLayer_Product_Item", - "form": "relational", "typeArray": true, - "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + } + }, + "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem": { + "name": "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "typeDoc": "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. ", + "methods": { + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], + "parameters": [ + { + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null + } + ] }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", - "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "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. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", - "type": "string", - "form": "local", - "doc": "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](/reference/datatypes/$1/#$2). 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. " + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", - "form": "local", - "doc": "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. " + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "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." + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "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. \n\nIn 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. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false + } + ] }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", - "type": "string", - "form": "local", - "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "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. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of a billing item." + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name is provided for server billing items." + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname is provided for server billing items" + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " - }, - "hoursUsed": { - "name": "hoursUsed", - "type": "string", - "form": "local", - "doc": "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. " - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for this billing item." - }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", - "form": "local", - "doc": "The last time this billing item was charged." + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that a billing item was last modified." + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", - "form": "local", - "doc": "The date on which your account will be charged for this billing item. " + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "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." + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "orderItemId": { - "name": "orderItemId", - "type": "int", - "form": "local", - "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", - "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", - "form": "local", - "doc": "This is the service provider for this billing item. " + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeAssociatedChildrenCount": { - "name": "activeAssociatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "associatedChildrenCount": { - "name": "associatedChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "associatedParentCount": { - "name": "associatedParentCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "billableChildrenCount": { - "name": "billableChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cancellationRequestCount": { - "name": "cancellationRequestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this will return any cancellation requests that are associated with this billing item." + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items'" + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "childrenWithActiveAgreementCount": { - "name": "childrenWithActiveAgreementCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "downgradeItemCount": { - "name": "downgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of for product items which have a downgrade path defined, this will return those product items." + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "filteredNextInvoiceChildrenCount": { - "name": "filteredNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "invoiceItemCount": { - "name": "invoiceItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of all invoice items associated with the billing item" + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "upgradeItemCount": { - "name": "upgradeItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "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." - } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, "filterable": true, - "maskable": true + "deprecated": false }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] + "filterable": true, + "deprecated": false }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } - } - }, - "SoftLayer_Billing_Item_Virtual_Host_Usage": { - "name": "SoftLayer_Billing_Item_Virtual_Host_Usage", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Virtual_Host_Usage data type contains general information relating to a single SoftLayer billing item for virtual machine peak usage ", + }, "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Hardware", - "form": "relational", - "doc": "The resource for a peak virtual machine usage billing item." - }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a server billing item." - }, "account": { "name": "account", "type": "SoftLayer_Account", @@ -56952,240 +66510,78 @@ "form": "count", "doc": "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." } - }, - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] + } + }, + "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft": { + "name": "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft", + "base": "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem", + "noservice": true, + "typeDoc": "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. ", + "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Software_VirtualLicense", + "form": "relational", + "doc": "The software virtual license to which this billing item points." }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] + "resourceTableId": { + "name": "resourceTableId", + "type": "int", + "form": "local", + "doc": "The resource (unique identifier) for a software virtual license billing item." }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getObject": { - "name": "getObject", + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", + "form": "relational" + }, + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." + }, + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", - "filterable": true, - "maskable": true + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] + "doc": "A Billing Item's active bundled billing items." }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] - }, - "setAssociationId": { - "name": "setAssociationId", - "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] - }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] - } - } - }, - "SoftLayer_Billing_Item_Virtual_ReservedCapacity": { - "name": "SoftLayer_Billing_Item_Virtual_ReservedCapacity", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "properties": { - "resource": { - "name": "resource", - "type": "SoftLayer_Virtual_ReservedCapacityGroup_Instance", - "form": "relational", - "doc": "The resource for a virtual dedicated host billing item." - }, - "account": { - "name": "account", - "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account that a billing item belongs to." - }, - "activeAgreement": { - "name": "activeAgreement", - "type": "SoftLayer_Account_Agreement", - "form": "relational" - }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", - "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." - }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." - }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true - }, - "activeBundledItems": { - "name": "activeBundledItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active bundled billing items." - }, - "activeCancellationItem": { - "name": "activeCancellationItem", - "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." - }, - "activeChildren": { - "name": "activeChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active child billing items." - }, - "activeFlag": { - "name": "activeFlag", + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", "type": "boolean", "form": "relational" }, @@ -57925,184 +67321,588 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] - } - } - }, - "SoftLayer_Billing_Item_Workspace": { - "name": "SoftLayer_Billing_Item_Workspace", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Workspace data type contains general information relating to a single SoftLayer billing item whose item category code is 'workspace' ", - "methods": { - "cancelItem": { - "name": "cancelItem", - "type": "boolean", - "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", - "docOverview": "Cancel a service or resource.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ], - "parameters": [ - { - "name": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false - }, - { - "name": "cancelAssociatedBillingItems", - "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", - "defaultValue": false - }, - { - "name": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, - { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null - } - ] }, - "cancelService": { - "name": "cancelService", - "type": "boolean", - "doc": "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. ", - "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] + "getAccount": { + "doc": "The account that a billing item belongs to.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cancelServiceOnAnniversaryDate": { - "name": "cancelServiceOnAnniversaryDate", - "type": "boolean", - "doc": "Cancel the resource or service for a billing Item ", - "docOverview": "Cancel a service or resource on the next bill date", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." - } - ] + "getActiveAgreement": { + "doc": "", + "docOverview": "", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "getObject": { - "name": "getObject", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", "type": "SoftLayer_Billing_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "typeArray": true, + "ormMethod": true, + "maskable": true, "filterable": true, - "maskable": true + "deprecated": false, + "limitable": true }, - "getServiceBillingItemsByCategory": { - "name": "getServiceBillingItemsByCategory", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", "typeArray": true, - "doc": "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. \n\nIn 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. ", - "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", - "static": true, + "ormMethod": true, "maskable": true, - "parameters": [ - { - "name": "categoryCode", - "type": "string", - "doc": "The category code of billing items you wish to retrieve." - }, - { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false - } - ] + "filterable": true, + "deprecated": false, + "limitable": true }, - "removeAssociationId": { - "name": "removeAssociationId", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" - } - ] + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "setAssociationId": { - "name": "setAssociationId", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "doc": "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. ", - "docOverview": "Set the associated billing item for an orphan billing item.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" - } - ], - "parameters": [ - { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" - } - ] + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "voidCancelService": { - "name": "voidCancelService", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" - } - ] + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } - }, + } + }, + "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat": { + "name": "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat", + "base": "SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem", + "noservice": true, + "typeDoc": "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. ", "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Software_Component", + "form": "relational", + "doc": "The software component to which this billing item points." + }, + "resourceTableId": { + "name": "resourceTableId", + "type": "int", + "form": "local", + "doc": "The resource (unique identifier) for a software component billing item." + }, "account": { "name": "account", "type": "SoftLayer_Account", @@ -58726,110 +68526,177 @@ "form": "count", "doc": "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." } - } - }, - "SoftLayer_Billing_Order": { - "name": "SoftLayer_Billing_Order", - "base": "SoftLayer_Entity", - "serviceDoc": "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: \n*'''QUOTE_PENDING''': Orders which have not been paid yet. Orders pending approval from a Softlayer customer.\n\n\nOnce an order is paid it moves from QUOTE_PENDING to PENDING_APPROVAL state. \n\nOrders 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. \n\nQuery the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service to get a list of orders for your account. ", + }, "methods": { - "approveModifiedOrder": { - "name": "approveModifiedOrder", + "cancelItem": { + "name": "cancelItem", "type": "boolean", - "doc": "When an order has been modified, the customer will need to approve the changes. This method will allow the customer to approve the changes. ", - "docOverview": "Approve the changes of a modified order" - }, - "getAllObjects": { - "name": "getAllObjects", - "type": "SoftLayer_Billing_Order", - "typeArray": true, - "doc": "This will get all billing orders for your account. ", - "docOverview": "Get all billing orders for your account", - "static": true, - "limitable": true, - "filterable": true, - "maskable": true - }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Order", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Order record.", + "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", "docErrorHandling": [ { - "exception": "SoftLayer_Exception_ObjectNotFound", - "description": "Throw the error \"Unable to find object with id of {id}.\" if the given initialization parameter has an invalid id field." + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." } ], - "docAssociatedMethods": [ + "parameters": [ { - "service": "SoftLayer_Account", - "method": "getInvoices" + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null } - ], - "filterable": true, - "maskable": true + ] }, - "getOrderStatuses": { - "name": "getOrderStatuses", - "type": "SoftLayer_Container_Billing_Order_Status", - "typeArray": true, - "doc": "Get a list of [SoftLayer_Container_Billing_Order_Status](/reference/datatypes/SoftLayer_Container_Billing_Order_Status) objects. ", - "docOverview": "Get a list of SoftLayer_Container_Billing_Order_Status objects.", - "static": true + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "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. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ] }, - "getPdf": { - "name": "getPdf", - "type": "base64Binary", - "doc": "Retrieve a PDF record of a SoftLayer quote. If the order is not a quote, an error will be thrown. ", - "docOverview": "Retrieve a PDF copy of a quote.", - "docAssociatedMethods": [ + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ { - "service": "SoftLayer_Billing_Order_Quote", - "method": "getPdf" + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." } ] }, - "getPdfFilename": { - "name": "getPdfFilename", - "type": "string", - "doc": "Retrieve the default filename of an order PDF. ", - "docOverview": "Retrieve the default name of the PDF" + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true }, - "getRecalculatedOrderContainer": { - "name": "getRecalculatedOrderContainer", - "type": "SoftLayer_Container_Product_Order", - "doc": "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. ", - "docOverview": "Generate an [SoftLayer_Container_Product_Order](/reference/datatypes/SoftLayer_Container_Product_Order) from a billing order. ", + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "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. \n\nIn 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. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, "parameters": [ { - "name": "message", + "name": "categoryCode", "type": "string", - "doc": "Message to return with the verified order", - "defaultValue": null + "doc": "The category code of billing items you wish to retrieve." }, { - "name": "ignoreDiscountsFlag", + "name": "includeZeroRecurringFee", "type": "boolean", - "doc": "This flag is set and used internally", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", "defaultValue": false } ] }, - "getReceipt": { - "name": "getReceipt", - "type": "SoftLayer_Container_Product_Order_Receipt", - "doc": "Generate a [SoftLayer_Container_Product_Order_Receipt](/reference/datatypes/SoftLayer_Container_Product_Order_Receipt) object with all the order information. ", - "docOverview": "Generate and return an order receipt." - }, - "isPendingEditApproval": { - "name": "isPendingEditApproval", + "removeAssociationId": { + "name": "removeAssociationId", "type": "boolean", - "doc": "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. ", - "docOverview": "Determine if the existing order is pending edit approval" + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] }, - "getAccount": { - "doc": "The [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) to which an order belongs.", + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "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. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], + "parameters": [ + { + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" + } + ] + }, + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + } + ] + }, + "getAccount": { + "doc": "The account that a billing item belongs to.", "docOverview": "", "name": "getAccount", "type": "SoftLayer_Account", @@ -58839,33 +68706,33 @@ "filterable": true, "deprecated": false }, - "getBrand": { + "getActiveAgreement": { "doc": "", "docOverview": "", - "name": "getBrand", - "type": "SoftLayer_Brand", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getCart": { - "doc": "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.", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", "docOverview": "", - "name": "getCart", - "type": "SoftLayer_Billing_Order_Cart", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getCoreRestrictedItems": { - "doc": "The [SoftLayer_Billing_Order_Item](/reference/datatypes/SoftLayer_Billing_Order_Item) that are core restricted", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", "docOverview": "", - "name": "getCoreRestrictedItems", - "type": "SoftLayer_Billing_Order_Item", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -58873,11 +68740,11 @@ "deprecated": false, "limitable": true }, - "getCreditCardTransactions": { - "doc": "All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", "docOverview": "", - "name": "getCreditCardTransactions", - "type": "SoftLayer_Billing_Payment_Card_Transaction", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -58885,33 +68752,57 @@ "deprecated": false, "limitable": true }, - "getExchangeRate": { - "doc": "", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", "docOverview": "", - "name": "getExchangeRate", - "type": "SoftLayer_Billing_Currency_ExchangeRate", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getInitialInvoice": { + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getActiveFlag": { "doc": "", "docOverview": "", - "name": "getInitialInvoice", - "type": "SoftLayer_Billing_Invoice", + "name": "getActiveFlag", + "type": "boolean", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getItems": { - "doc": "The SoftLayer_Billing_Order_items included in an order.", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", "docOverview": "", - "name": "getItems", - "type": "SoftLayer_Billing_Order_Item", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -58919,44 +68810,140 @@ "deprecated": false, "limitable": true }, - "getOrderApprovalDate": { - "doc": "", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", "docOverview": "", - "name": "getOrderApprovalDate", - "type": "dateTime", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrderNonServerMonthlyAmount": { - "doc": "An order's non-server items total monthly fee.", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", "docOverview": "", - "name": "getOrderNonServerMonthlyAmount", - "type": "decimal", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrderServerMonthlyAmount": { - "doc": "An order's server items total monthly fee.", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", "docOverview": "", - "name": "getOrderServerMonthlyAmount", - "type": "decimal", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrderTopLevelItems": { - "doc": "An order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI.", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", "docOverview": "", - "name": "getOrderTopLevelItems", - "type": "SoftLayer_Billing_Order_Item", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", "typeArray": true, "ormMethod": true, "maskable": true, @@ -58964,110 +68951,182 @@ "deprecated": false, "limitable": true }, - "getOrderTotalAmount": { - "doc": "This amount represents the order's initial charge including set up fee and taxes.", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", "docOverview": "", - "name": "getOrderTotalAmount", - "type": "decimal", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrderTotalOneTime": { - "doc": "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.", + "getChildren": { + "doc": "A Billing Item's child billing items'", "docOverview": "", - "name": "getOrderTotalOneTime", - "type": "decimal", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrderTotalOneTimeAmount": { - "doc": "An order's total one time amount. This amount represents the initial fees before tax.", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", "docOverview": "", - "name": "getOrderTotalOneTimeAmount", - "type": "decimal", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrderTotalOneTimeTaxAmount": { - "doc": "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.", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", "docOverview": "", - "name": "getOrderTotalOneTimeTaxAmount", - "type": "decimal", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrderTotalRecurring": { - "doc": "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.", + "getLocation": { + "doc": "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.", "docOverview": "", - "name": "getOrderTotalRecurring", - "type": "decimal", + "name": "getLocation", + "type": "SoftLayer_Location", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrderTotalRecurringAmount": { - "doc": "An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis.", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", "docOverview": "", - "name": "getOrderTotalRecurringAmount", - "type": "decimal", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrderTotalRecurringTaxAmount": { - "doc": "The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", "docOverview": "", - "name": "getOrderTotalRecurringTaxAmount", - "type": "decimal", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrderTotalSetupAmount": { - "doc": "An order's total setup fee.", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", "docOverview": "", - "name": "getOrderTotalSetupAmount", - "type": "decimal", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrderType": { - "doc": "The type of an order. This lets you know where this order was generated from.", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", "docOverview": "", - "name": "getOrderType", - "type": "SoftLayer_Billing_Order_Type", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getPaypalTransactions": { - "doc": "All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", "docOverview": "", - "name": "getPaypalTransactions", - "type": "SoftLayer_Billing_Payment_PayPal_Transaction", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -59075,43 +69134,65 @@ "deprecated": false, "limitable": true }, - "getPresaleEvent": { - "doc": "", + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", "docOverview": "", - "name": "getPresaleEvent", - "type": "SoftLayer_Sales_Presale_Event", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getQuote": { - "doc": "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'", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", "docOverview": "", - "name": "getQuote", - "type": "SoftLayer_Billing_Order_Quote", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getReferralPartner": { - "doc": "The Referral Partner who referred this order. (Only necessary for new customer orders)", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", "docOverview": "", - "name": "getReferralPartner", - "type": "SoftLayer_Account", + "name": "getPackage", + "type": "SoftLayer_Product_Package", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getUpgradeRequestFlag": { - "doc": "This flag indicates an order is an upgrade.", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", "docOverview": "", - "name": "getUpgradeRequestFlag", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", "typeArray": null, "ormMethod": true, @@ -59119,538 +69200,870 @@ "filterable": true, "deprecated": false }, - "getUserRecord": { - "doc": "The SoftLayer_User_Customer object tied to an order.", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", "docOverview": "", - "name": "getUserRecord", - "type": "SoftLayer_User_Customer", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } - }, - "typeDoc": "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_Item_Software_License": { + "name": "SoftLayer_Billing_Item_Software_License", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Item_Software_License data type contains general information relating to a single SoftLayer billing item for a software license. ", "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_Software_AccountLicense", + "form": "relational", + "doc": "The resource for a software license billing item." + }, "account": { "name": "account", "type": "SoftLayer_Account", "form": "relational", - "doc": "The [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) to which an order belongs." + "doc": "The account that a billing item belongs to." }, - "brand": { - "name": "brand", - "type": "SoftLayer_Brand", + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", "form": "relational" }, - "cart": { - "name": "cart", - "type": "SoftLayer_Billing_Order_Cart", + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", "form": "relational", - "doc": "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." + "doc": "A flag indicating that the billing item is under an active agreement." }, - "coreRestrictedItems": { - "name": "coreRestrictedItems", - "type": "SoftLayer_Billing_Order_Item", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", "form": "relational", "typeArray": true, - "doc": "The [SoftLayer_Billing_Order_Item](/reference/datatypes/SoftLayer_Billing_Order_Item) that are core restricted" + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." }, - "creditCardTransactions": { - "name": "creditCardTransactions", - "type": "SoftLayer_Billing_Payment_Card_Transaction", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", "form": "relational", "typeArray": true, - "doc": "All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty." + "doc": "A Billing Item's active bundled billing items." }, - "exchangeRate": { - "name": "exchangeRate", - "type": "SoftLayer_Billing_Currency_ExchangeRate", - "form": "relational" + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "initialInvoice": { - "name": "initialInvoice", - "type": "SoftLayer_Billing_Invoice", + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "activeFlag": { + "name": "activeFlag", + "type": "boolean", "form": "relational" }, - "items": { - "name": "items", - "type": "SoftLayer_Billing_Order_Item", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", "form": "relational", "typeArray": true, - "doc": "The SoftLayer_Billing_Order_items included in an order." + "doc": "A Billing Item's spare pool bundled billing items." }, - "orderApprovalDate": { - "name": "orderApprovalDate", - "type": "dateTime", - "form": "relational" + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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." }, - "orderNonServerMonthlyAmount": { - "name": "orderNonServerMonthlyAmount", - "type": "decimal", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", "form": "relational", - "doc": "An order's non-server items total monthly fee." + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." }, - "orderServerMonthlyAmount": { - "name": "orderServerMonthlyAmount", - "type": "decimal", + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", "form": "relational", - "doc": "An order's server items total monthly fee." + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." }, - "orderTopLevelItems": { - "name": "orderTopLevelItems", - "type": "SoftLayer_Billing_Order_Item", + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", "form": "relational", "typeArray": true, - "doc": "An order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI." + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." }, - "orderTotalAmount": { - "name": "orderTotalAmount", - "type": "decimal", + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", "form": "relational", - "doc": "This amount represents the order's initial charge including set up fee and taxes." + "typeArray": true }, - "orderTotalOneTime": { - "name": "orderTotalOneTime", - "type": "decimal", + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", "form": "relational", - "doc": "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." + "doc": "The bandwidth allocation for a billing item." }, - "orderTotalOneTimeAmount": { - "name": "orderTotalOneTimeAmount", - "type": "decimal", + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", "form": "relational", - "doc": "An order's total one time amount. This amount represents the initial fees before tax." + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "orderTotalOneTimeTaxAmount": { - "name": "orderTotalOneTimeTaxAmount", - "type": "decimal", + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", "form": "relational", - "doc": "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." + "typeArray": true, + "doc": "A Billing Item's bundled billing items." }, - "orderTotalRecurring": { - "name": "orderTotalRecurring", - "type": "decimal", + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", "form": "relational", - "doc": "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." + "typeArray": true, + "doc": "A Billing Item's active child billing items." }, - "orderTotalRecurringAmount": { - "name": "orderTotalRecurringAmount", - "type": "decimal", + "cancellationReason": { + "name": "cancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", "form": "relational", - "doc": "An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis." + "doc": "The billing item's cancellation reason." }, - "orderTotalRecurringTaxAmount": { - "name": "orderTotalRecurringTaxAmount", - "type": "decimal", + "cancellationRequests": { + "name": "cancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", "form": "relational", - "doc": "The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account." + "typeArray": true, + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "orderTotalSetupAmount": { - "name": "orderTotalSetupAmount", - "type": "decimal", + "category": { + "name": "category", + "type": "SoftLayer_Product_Item_Category", "form": "relational", - "doc": "An order's total setup fee." + "doc": "The item category to which the billing item's item belongs. " }, - "orderType": { - "name": "orderType", - "type": "SoftLayer_Billing_Order_Type", + "children": { + "name": "children", + "type": "SoftLayer_Billing_Item", "form": "relational", - "doc": "The type of an order. This lets you know where this order was generated from." + "typeArray": true, + "doc": "A Billing Item's child billing items'" }, - "paypalTransactions": { - "name": "paypalTransactions", - "type": "SoftLayer_Billing_Payment_PayPal_Transaction", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", "form": "relational", "typeArray": true, - "doc": "All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty." + "doc": "A Billing Item's active child billing items." }, - "presaleEvent": { - "name": "presaleEvent", - "type": "SoftLayer_Sales_Presale_Event", - "form": "relational" + "downgradeItems": { + "name": "downgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "quote": { - "name": "quote", - "type": "SoftLayer_Billing_Order_Quote", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", "form": "relational", - "doc": "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'" + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "referralPartner": { - "name": "referralPartner", - "type": "SoftLayer_Account", + "hourlyFlag": { + "name": "hourlyFlag", + "type": "boolean", "form": "relational", - "doc": "The Referral Partner who referred this order. (Only necessary for new customer orders)" + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "upgradeRequestFlag": { - "name": "upgradeRequestFlag", + "invoiceItem": { + "name": "invoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "doc": "Invoice items associated with this billing item" + }, + "invoiceItems": { + "name": "invoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "typeArray": true, + "doc": "All invoice items associated with the billing item" + }, + "item": { + "name": "item", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + }, + "location": { + "name": "location", + "type": "SoftLayer_Location", + "form": "relational", + "doc": "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": { + "name": "nextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items and associated items'" + }, + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" + }, + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" + }, + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + }, + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", + "type": "float", + "form": "relational", + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + }, + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + }, + "orderItem": { + "name": "orderItem", + "type": "SoftLayer_Billing_Order_Item", + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + }, + "originalLocation": { + "name": "originalLocation", + "type": "SoftLayer_Location", + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." + }, + "package": { + "name": "package", + "type": "SoftLayer_Product_Package", + "form": "relational", + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + }, + "parent": { + "name": "parent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + }, + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + }, + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", "type": "boolean", "form": "relational", - "doc": "This flag indicates an order is an upgrade." + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." }, - "userRecord": { - "name": "userRecord", - "type": "SoftLayer_User_Customer", + "pendingOrderItem": { + "name": "pendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", "form": "relational", - "doc": "The SoftLayer_User_Customer object tied to an order." + "doc": "The new order item that will replace this billing item." }, - "accountId": { - "name": "accountId", + "provisionTransaction": { + "name": "provisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "form": "relational", + "doc": "Provisioning transaction for this billing item" + }, + "softwareDescription": { + "name": "softwareDescription", + "type": "SoftLayer_Software_Description", + "form": "relational", + "doc": "A friendly description of software component" + }, + "upgradeItem": { + "name": "upgradeItem", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + }, + "upgradeItems": { + "name": "upgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." + }, + "allowCancellationFlag": { + "name": "allowCancellationFlag", "type": "int", "form": "local", - "doc": "The account ID to which an order belongs." + "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " + }, + "associatedBillingItemId": { + "name": "associatedBillingItemId", + "type": "string", + "form": "local", + "doc": "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](/reference/datatypes/$1/#$2). 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. " + }, + "cancellationDate": { + "name": "cancellationDate", + "type": "dateTime", + "form": "local", + "doc": "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. " + }, + "categoryCode": { + "name": "categoryCode", + "type": "string", + "form": "local", + "doc": "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." }, "createDate": { "name": "createDate", "type": "dateTime", "form": "local", - "doc": "The point in time at which a billing item was created." + "doc": "The date the billing item was created. You can see this date on the invoice." + }, + "currentHourlyCharge": { + "name": "currentHourlyCharge", + "type": "string", + "form": "local", + "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " + }, + "cycleStartDate": { + "name": "cycleStartDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." + }, + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "A brief description of a billing item." + }, + "domainName": { + "name": "domainName", + "type": "string", + "form": "local", + "doc": "The domain name is provided for server billing items." + }, + "hostName": { + "name": "hostName", + "type": "string", + "form": "local", + "doc": "The hostname is provided for server billing items" + }, + "hourlyRecurringFee": { + "name": "hourlyRecurringFee", + "type": "decimal", + "form": "local", + "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " + }, + "hoursUsed": { + "name": "hoursUsed", + "type": "string", + "form": "local", + "doc": "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. " }, "id": { "name": "id", "type": "int", "form": "local", - "doc": "*" + "doc": "The unique identifier for this billing item." }, - "impersonatingUserRecordId": { - "name": "impersonatingUserRecordId", - "type": "int", + "laborFee": { + "name": "laborFee", + "type": "decimal", "form": "local", - "doc": "The SoftLayer_User_Customer id of the portal or API user who impersonated the user which submitted an order." + "doc": "The labor fee, if any. This is a one time charge." + }, + "laborFeeTaxRate": { + "name": "laborFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which labor fees are taxed if you are a taxable customer." + }, + "lastBillDate": { + "name": "lastBillDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." }, "modifyDate": { "name": "modifyDate", "type": "dateTime", "form": "local", - "doc": "The last time an order was updated." + "doc": "The date that a billing item was last modified." }, - "orderQuoteId": { - "name": "orderQuoteId", - "type": "int", + "nextBillDate": { + "name": "nextBillDate", + "type": "dateTime", "form": "local", - "doc": "The SoftLayer_Billing_Order_Quote id of the quote's user who finalized an order." + "doc": "The date on which your account will be charged for this billing item. " }, - "orderTypeId": { - "name": "orderTypeId", - "type": "int", + "notes": { + "name": "notes", + "type": "string", "form": "local", - "doc": "The SoftLayer_Billing_Order_Type id of the order." - }, - "presaleEventId": { - "name": "presaleEventId", - "type": "int", - "form": "local" + "doc": "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." }, - "privateCloudOrderFlag": { - "name": "privateCloudOrderFlag", - "type": "boolean", + "oneTimeFee": { + "name": "oneTimeFee", + "type": "decimal", "form": "local", - "doc": "Deprecated.", - "deprecated": true + "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " }, - "status": { - "name": "status", - "type": "string", + "oneTimeFeeTaxRate": { + "name": "oneTimeFeeTaxRate", + "type": "decimal", "form": "local", - "doc": "Purchaser current status e.i. Approved, Pending_Approval" + "doc": "The rate at which one time fees are taxed if you are a taxable customer." }, - "userRecordId": { - "name": "userRecordId", + "orderItemId": { + "name": "orderItemId", "type": "int", "form": "local", - "doc": "The SoftLayer_User_Customer id of the portal or API user who submitted an order." + "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." }, - "coreRestrictedItemCount": { - "name": "coreRestrictedItemCount", + "packageId": { + "name": "packageId", + "type": "int", + "form": "local", + "doc": "This is the package id for this billing item." + }, + "parentId": { + "name": "parentId", + "type": "int", + "form": "local", + "doc": "The unique identifier of the parent of this billing item." + }, + "recurringFee": { + "name": "recurringFee", + "type": "decimal", + "form": "local", + "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " + }, + "recurringFeeTaxRate": { + "name": "recurringFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which recurring fees are taxed if you are a taxable customer." + }, + "recurringMonths": { + "name": "recurringMonths", + "type": "int", + "form": "local", + "doc": "The number of months in which the recurring fees will be incurred." + }, + "serviceProviderId": { + "name": "serviceProviderId", + "type": "int", + "form": "local", + "doc": "This is the service provider for this billing item. " + }, + "setupFee": { + "name": "setupFee", + "type": "decimal", + "form": "local", + "doc": "The setup fee, if any. This is a one time charge." + }, + "setupFeeTaxRate": { + "name": "setupFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which setup fees are taxed if you are a taxable customer." + }, + "activeAssociatedChildrenCount": { + "name": "activeAssociatedChildrenCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the [SoftLayer_Billing_Order_Item](/reference/datatypes/SoftLayer_Billing_Order_Item) that are core restricted" + "doc": "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." }, - "creditCardTransactionCount": { - "name": "creditCardTransactionCount", + "activeAssociatedGuestDiskBillingItemCount": { + "name": "activeAssociatedGuestDiskBillingItemCount", "type": "unsignedLong", "form": "count", - "doc": "A count of all credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty." + "doc": "A count of " }, - "itemCount": { - "name": "itemCount", + "activeBundledItemCount": { + "name": "activeBundledItemCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the SoftLayer_Billing_Order_items included in an order." + "doc": "A count of a Billing Item's active bundled billing items." }, - "orderTopLevelItemCount": { - "name": "orderTopLevelItemCount", + "activeChildrenCount": { + "name": "activeChildrenCount", "type": "unsignedLong", "form": "count", - "doc": "A count of an order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI." + "doc": "A count of a Billing Item's active child billing items." }, - "paypalTransactionCount": { - "name": "paypalTransactionCount", + "activeSparePoolAssociatedGuestDiskBillingItemCount": { + "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", "type": "unsignedLong", "form": "count", - "doc": "A count of all PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty." + "doc": "A count of " + }, + "activeSparePoolBundledItemCount": { + "name": "activeSparePoolBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's spare pool bundled billing items." + }, + "associatedBillingItemHistoryCount": { + "name": "associatedBillingItemHistoryCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a history of billing items which a billing item has been associated with." + }, + "associatedChildrenCount": { + "name": "associatedChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "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." + }, + "associatedParentCount": { + "name": "associatedParentCount", + "type": "unsignedLong", + "form": "count", + "doc": "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." + }, + "availableMatchingVlanCount": { + "name": "availableMatchingVlanCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "billableChildrenCount": { + "name": "billableChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItemCount": { + "name": "bundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's bundled billing items." + }, + "canceledChildrenCount": { + "name": "canceledChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." + }, + "cancellationRequestCount": { + "name": "cancellationRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of this will return any cancellation requests that are associated with this billing item." + }, + "childrenCount": { + "name": "childrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing items'" + }, + "childrenWithActiveAgreementCount": { + "name": "childrenWithActiveAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." + }, + "downgradeItemCount": { + "name": "downgradeItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of for product items which have a downgrade path defined, this will return those product items." + }, + "filteredNextInvoiceChildrenCount": { + "name": "filteredNextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + }, + "invoiceItemCount": { + "name": "invoiceItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all invoice items associated with the billing item" + }, + "nextInvoiceChildrenCount": { + "name": "nextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing items and associated items'" + }, + "nonZeroNextInvoiceChildrenCount": { + "name": "nonZeroNextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + }, + "upgradeItemCount": { + "name": "upgradeItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "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." } - } - }, - "SoftLayer_Billing_Order_Cart": { - "name": "SoftLayer_Billing_Order_Cart", - "base": "SoftLayer_Billing_Order_Quote", - "serviceDoc": "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. ", + }, "methods": { - "createCart": { - "name": "createCart", - "type": "int", - "doc": "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. \n\nThe response is the new cart id. ", - "docOverview": "Create a new cart from the order data provided", - "static": true, - "parameters": [ - { - "name": "orderData", - "type": "SoftLayer_Container_Product_Order", - "doc": "The order data to save as a cart" - } - ] - }, - "deleteCart": { - "name": "deleteCart", + "cancelItem": { + "name": "cancelItem", "type": "boolean", - "doc": "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. ", - "docOverview": "Delete an existing cart" - }, - "getCartByCartKey": { - "name": "getCartByCartKey", - "type": "SoftLayer_Billing_Order_Cart", - "doc": "Retrieve a valid cart record of a SoftLayer order. ", - "docOverview": "Retrieve a cart.", + "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", "docErrorHandling": [ { - "exception": "SoftLayer_Exception_Public.", - "description": "Throw the exception \"No cart found\"" - }, - { - "exception": "SoftLayer_Exception_Public.", - "description": "Throw the exception \"You do not have permissions to access this cart.\"" + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." } ], - "static": true, - "maskable": true, "parameters": [ { - "name": "cartKey", + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", "type": "string", - "doc": "Key required to retrieve a cart." + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, + { + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null } ] }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Order_Cart", - "docOverview": "Retrieve a SoftLayer_Billing_Order_Cart record.", - "filterable": true, - "maskable": true - }, - "getPdf": { - "name": "getPdf", - "type": "base64Binary", - "doc": "Retrieve a PDF copy of the cart. ", - "docOverview": "Retrieve a PDF copy of the cart." - }, - "getRecalculatedOrderContainer": { - "name": "getRecalculatedOrderContainer", - "type": "SoftLayer_Container_Product_Order", - "doc": "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. ", - "docOverview": "Retrieve order container from a saved cart", - "parameters": [ - { - "name": "orderData", - "type": "SoftLayer_Container_Product_Order", - "doc": "Details for an order", - "defaultValue": null - }, + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "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. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ { - "name": "orderBeingPlacedFlag", - "type": "boolean", - "doc": "Determines if an order is actually being placed", - "defaultValue": false + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." } ] }, - "updateCart": { - "name": "updateCart", - "type": "int", - "doc": "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. \n\nThis will return the cart id. ", - "docOverview": "Update an existing cart with the modified order data", - "parameters": [ + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ { - "name": "orderData", - "type": "SoftLayer_Container_Product_Order", - "doc": "The order data to save as a cart" + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." } ] }, - "claim": { - "name": "claim", - "type": "SoftLayer_Billing_Order_Quote", - "doc": "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. \n\nTo claim a quote, both the quote id and the quote key (the 32-character random string) must be provided. ", - "docOverview": "Claim an anonymous quote", + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Item", + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", + "filterable": true, + "maskable": true + }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "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. \n\nIn 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. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", "static": true, "maskable": true, "parameters": [ { - "name": "quoteKey", + "name": "categoryCode", "type": "string", - "doc": "The 32-character random string generated when the quote was created" + "doc": "The category code of billing items you wish to retrieve." }, { - "name": "quoteId", - "type": "int", - "doc": "The quote's unique identifier (id) property" + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false } ] }, - "deleteQuote": { - "name": "deleteQuote", - "type": "SoftLayer_Billing_Order_Quote", - "doc": "Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order. ", - "docOverview": "Delete the quote of an order", + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", "docErrorHandling": [ { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception 'You cannot delete a deleted quote.'" + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." } ], "docAssociatedMethods": [ { - "service": "SoftLayer_Billing_Order_Quote", - "method": "deleteQuote" - }, - { - "service": "SoftLayer_Billing_Order_Quote", - "method": "saveQuote" + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" } - ], - "maskable": true + ] }, - "getQuoteByQuoteKey": { - "name": "getQuoteByQuoteKey", - "type": "SoftLayer_Billing_Order_Quote", - "doc": "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. ", - "docOverview": "Retrieve a [SoftLayer_Billing_Order_Quote](/reference/datatypes/SoftLayer_Billing_Order_Quote) by the quote key specified.", + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "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. ", + "docOverview": "Set the associated billing item for an orphan billing item.", "docErrorHandling": [ { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception \"No quote found\"" - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception \"Quote is no longer valid.\"" - }, - { - "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception \"Quote expired.\"" + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." }, { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception \"Quote has been removed from the system.\"" + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." }, { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception \"Quote is unavailable.\"" + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." }, { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception \"Could not authenticate quote.\"" + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." } ], - "static": true, - "maskable": true, - "parameters": [ - { - "name": "quoteKey", - "type": "string", - "doc": "Key required to retrieve a quote." - } - ] - }, - "placeOrder": { - "name": "placeOrder", - "type": "SoftLayer_Container_Product_Order_Receipt", - "doc": "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. ", - "docOverview": "Place an order", - "parameters": [ + "docAssociatedMethods": [ { - "name": "orderData", - "type": "SoftLayer_Container_Product_Order", - "doc": "Details required to order." + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" } - ] - }, - "placeQuote": { - "name": "placeQuote", - "type": "SoftLayer_Container_Product_Order", - "doc": "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. ", - "docOverview": "Saves changes to a quote", + ], "parameters": [ { - "name": "orderData", - "type": "SoftLayer_Container_Product_Order", - "doc": "Details required to order." + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" } ] }, - "saveQuote": { - "name": "saveQuote", - "type": "SoftLayer_Billing_Order_Quote", - "doc": "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. ", - "docOverview": "Save the quote of an order", + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", "docErrorHandling": [ { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception 'You cannot save a saved quote.'" + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." }, { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception 'You cannot save a deleted quote.'" + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." }, { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception 'You cannot save an invalid quote.'" - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Order_Quote", - "method": "saveQuote" - }, - { - "service": "SoftLayer_Billing_Order_Quote", - "method": "deleteQuote" - } - ], - "maskable": true - }, - "verifyOrder": { - "name": "verifyOrder", - "type": "SoftLayer_Container_Product_Order", - "doc": "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. ", - "docOverview": "Verify an order", - "parameters": [ - { - "name": "orderData", - "type": "SoftLayer_Container_Product_Order", - "doc": "Details required to order." + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] }, - "withdrawGdprAcceptance": { - "name": "withdrawGdprAcceptance", - "type": "void", - "doc": "Withdraws the users acceptance of the GDPR terms. ", - "docOverview": "Withdraws the users acceptance of the GDPR terms." - }, "getAccount": { - "doc": "A quote's corresponding account.", + "doc": "The account that a billing item belongs to.", "docOverview": "", "name": "getAccount", "type": "SoftLayer_Account", @@ -59660,164 +70073,244 @@ "filterable": true, "deprecated": false }, - "getDoNotContactFlag": { - "doc": "Indicates whether the owner of the quote chosen to no longer be contacted.", + "getActiveAgreement": { + "doc": "", "docOverview": "", - "name": "getDoNotContactFlag", - "type": "boolean", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrder": { - "doc": "This order contains the records for which products were selected for this quote.", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", "docOverview": "", - "name": "getOrder", - "type": "SoftLayer_Billing_Order", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrdersFromQuote": { - "doc": "These are all the orders that were created from this quote.", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", "docOverview": "", - "name": "getOrdersFromQuote", - "type": "SoftLayer_Billing_Order", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false, "limitable": true - } - }, - "properties": { - "account": { - "name": "account", - "type": "SoftLayer_Account", - "form": "relational", - "doc": "A quote's corresponding account." }, - "doNotContactFlag": { - "name": "doNotContactFlag", - "type": "boolean", - "form": "relational", - "doc": "Indicates whether the owner of the quote chosen to no longer be contacted." + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "order": { - "name": "order", - "type": "SoftLayer_Billing_Order", - "form": "relational", - "doc": "This order contains the records for which products were selected for this quote." + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "ordersFromQuote": { - "name": "ordersFromQuote", - "type": "SoftLayer_Billing_Order", - "form": "relational", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, - "doc": "These are all the orders that were created from this quote." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "accountId": { - "name": "accountId", - "type": "int", - "form": "local", - "doc": "Identification Number of the account record tied to the quote" + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "completedPurchaseDataId": { - "name": "completedPurchaseDataId", - "type": "int", - "form": "local", - "doc": "Identification Number of the order record tied to the quote." + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "Holds the date the quote record was created" + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "expirationDate": { - "name": "expirationDate", - "type": "dateTime", - "form": "local", - "doc": "This property holds the date of expiration of a quote, after that date the quote would be deem expired" + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The id use to identify a quote." + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "Holds the date when the quote record was modified with reference to its creation date" + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "The name given to quote by the initiator" + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "publicNote": { - "name": "publicNote", - "type": "string", - "form": "local", - "doc": "This property Holds system generated notes. In our case if a quote is tied to an order where one of the order item has an inactive promotion code, the quote will be considered invalid." + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "quoteKey": { - "name": "quoteKey", - "type": "string", - "form": "local", - "doc": "Holds system generated hash password for the Quote" + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "status": { - "name": "status", - "type": "string", - "form": "local", - "doc": "This property Holds the current status of a Quote: pending,expired, saved or deleted" + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "ordersFromQuoteCount": { - "name": "ordersFromQuoteCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of these are all the orders that were created from this quote." - } - } - }, - "SoftLayer_Billing_Order_Item": { - "name": "SoftLayer_Billing_Order_Item", - "base": "SoftLayer_Entity", - "serviceDoc": "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. \n\nThis 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. ", - "methods": { - "getObject": { - "name": "getObject", - "type": "SoftLayer_Billing_Order_Item", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Order_Item record.", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, "filterable": true, - "maskable": true + "deprecated": false, + "limitable": true }, - "getBillingItem": { - "doc": "The SoftLayer_Billing_Item tied to the order item.", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", "docOverview": "", - "name": "getBillingItem", + "name": "getCanceledChildren", "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getBundledItems": { - "doc": "The other items included with an ordered item.", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", "docOverview": "", - "name": "getBundledItems", - "type": "SoftLayer_Billing_Order_Item", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", "typeArray": true, "ormMethod": true, "maskable": true, @@ -59826,7 +70319,7 @@ "limitable": true }, "getCategory": { - "doc": "The item category tied to an order item.", + "doc": "The item category to which the billing item's item belongs. ", "docOverview": "", "name": "getCategory", "type": "SoftLayer_Product_Item_Category", @@ -59837,10 +70330,10 @@ "deprecated": false }, "getChildren": { - "doc": "The child order items for an order item. All server order items should have children. These children are considered a part of the server.", + "doc": "A Billing Item's child billing items'", "docOverview": "", "name": "getChildren", - "type": "SoftLayer_Billing_Order_Item", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -59848,44 +70341,69 @@ "deprecated": false, "limitable": true }, - "getGlobalIdentifier": { - "doc": "A hardware's universally unique identifier.", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", "docOverview": "", - "name": "getGlobalIdentifier", - "type": "string", - "typeArray": null, + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": false, + "limitable": true }, - "getHardwareGenericComponent": { - "doc": "The component type tied to an order item. All hardware-specific items should have a generic hardware component.", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", "docOverview": "", - "name": "getHardwareGenericComponent", - "type": "SoftLayer_Hardware_Component_Model_Generic", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getItem": { - "doc": "The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold.", + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", "docOverview": "", - "name": "getItem", - "type": "SoftLayer_Product_Item", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getItemCategoryAnswers": { - "doc": "This is an item's category answers.", + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", "docOverview": "", - "name": "getItemCategoryAnswers", - "type": "SoftLayer_Billing_Order_Item_Category_Answer", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -59893,11 +70411,11 @@ "deprecated": false, "limitable": true }, - "getItemPrice": { - "doc": "The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item.", + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", "docOverview": "", - "name": "getItemPrice", - "type": "SoftLayer_Product_Item_Price", + "name": "getItem", + "type": "SoftLayer_Product_Item", "typeArray": null, "ormMethod": true, "maskable": true, @@ -59905,7 +70423,7 @@ "deprecated": false }, "getLocation": { - "doc": "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.", + "doc": "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.", "docOverview": "", "name": "getLocation", "type": "SoftLayer_Location", @@ -59915,11 +70433,11 @@ "filterable": true, "deprecated": false }, - "getNextOrderChildren": { - "doc": "", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", "docOverview": "", - "name": "getNextOrderChildren", - "type": "SoftLayer_Billing_Order_Item", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -59927,54 +70445,66 @@ "deprecated": false, "limitable": true }, - "getOldBillingItem": { - "doc": "This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened.", + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", "docOverview": "", - "name": "getOldBillingItem", - "type": "SoftLayer_Billing_Item", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrder": { - "doc": "The order to which this item belongs. The order contains all the information related to the items included in an order", + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", "docOverview": "", - "name": "getOrder", - "type": "SoftLayer_Billing_Order", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrderApprovalDate": { - "doc": "", + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", "docOverview": "", - "name": "getOrderApprovalDate", - "type": "dateTime", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getPackage": { - "doc": "The SoftLayer_Product_Package an order item is a part of.", + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", "docOverview": "", - "name": "getPackage", - "type": "SoftLayer_Product_Package", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getParent": { - "doc": "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.", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", "docOverview": "", - "name": "getParent", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", "type": "SoftLayer_Billing_Order_Item", "typeArray": null, "ormMethod": true, @@ -59982,67 +70512,88 @@ "filterable": true, "deprecated": false }, - "getPreset": { - "doc": "The SoftLayer_Product_Package_Preset related to this order item.", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", "docOverview": "", - "name": "getPreset", - "type": "SoftLayer_Product_Package_Preset", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getPromoCode": { - "doc": "", + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", "docOverview": "", - "name": "getPromoCode", - "type": "SoftLayer_Product_Promotion", + "name": "getPackage", + "type": "SoftLayer_Product_Package", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getRedundantPowerSupplyCount": { - "doc": "A count of power supplies contained within this SoftLayer_Billing_Order", + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", "docOverview": "", - "name": "getRedundantPowerSupplyCount", - "type": "unsignedInt", + "name": "getParent", + "type": "SoftLayer_Billing_Item", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getSoftwareDescription": { - "doc": "For ordered items that are software items, a full description of that software can be found with this property. ", + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", "docOverview": "", - "name": "getSoftwareDescription", - "type": "SoftLayer_Software_Description", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getStorageGroups": { - "doc": "The drive storage groups that are attached to this billing order item.", + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", "docOverview": "", - "name": "getStorageGroups", - "type": "SoftLayer_Configuration_Storage_Group_Order", - "typeArray": true, + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, - "limitable": true + "deprecated": false }, - "getTotalRecurringAmount": { - "doc": "The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis.", + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", "docOverview": "", - "name": "getTotalRecurringAmount", - "type": "float", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", "typeArray": null, "ormMethod": true, "maskable": true, @@ -60050,7 +70601,7 @@ "deprecated": false }, "getUpgradeItem": { - "doc": "The next SoftLayer_Product_Item in the upgrade path for this order item.", + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", "docOverview": "", "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", @@ -60059,608 +70610,196 @@ "maskable": true, "filterable": true, "deprecated": false - } - }, - "typeDoc": "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. \n\nBilling 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. ", - "properties": { - "billingItem": { - "name": "billingItem", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "The SoftLayer_Billing_Item tied to the order item." - }, - "bundledItems": { - "name": "bundledItems", - "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "typeArray": true, - "doc": "The other items included with an ordered item." - }, - "category": { - "name": "category", - "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category tied to an order item." }, - "children": { - "name": "children", - "type": "SoftLayer_Billing_Order_Item", - "form": "relational", + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", "typeArray": true, - "doc": "The child order items for an order item. All server order items should have children. These children are considered a part of the server." - }, - "globalIdentifier": { - "name": "globalIdentifier", - "type": "string", - "form": "relational", - "doc": "A hardware's universally unique identifier." - }, - "hardwareGenericComponent": { - "name": "hardwareGenericComponent", - "type": "SoftLayer_Hardware_Component_Model_Generic", - "form": "relational", - "doc": "The component type tied to an order item. All hardware-specific items should have a generic hardware component." - }, - "item": { - "name": "item", - "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold." - }, - "itemCategoryAnswers": { - "name": "itemCategoryAnswers", - "type": "SoftLayer_Billing_Order_Item_Category_Answer", - "form": "relational", - "typeArray": true, - "doc": "This is an item's category answers." - }, - "itemPrice": { - "name": "itemPrice", - "type": "SoftLayer_Product_Item_Price", - "form": "relational", - "doc": "The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item." - }, - "location": { - "name": "location", - "type": "SoftLayer_Location", - "form": "relational", - "doc": "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." - }, - "nextOrderChildren": { - "name": "nextOrderChildren", - "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "typeArray": true - }, - "oldBillingItem": { - "name": "oldBillingItem", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "doc": "This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened." - }, - "order": { - "name": "order", - "type": "SoftLayer_Billing_Order", - "form": "relational", - "doc": "The order to which this item belongs. The order contains all the information related to the items included in an order" - }, - "orderApprovalDate": { - "name": "orderApprovalDate", - "type": "dateTime", - "form": "relational" - }, - "package": { - "name": "package", - "type": "SoftLayer_Product_Package", - "form": "relational", - "doc": "The SoftLayer_Product_Package an order item is a part of." - }, - "parent": { - "name": "parent", - "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "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." - }, - "preset": { - "name": "preset", - "type": "SoftLayer_Product_Package_Preset", - "form": "relational", - "doc": "The SoftLayer_Product_Package_Preset related to this order item." - }, - "promoCode": { - "name": "promoCode", - "type": "SoftLayer_Product_Promotion", - "form": "relational" - }, - "redundantPowerSupplyCount": { - "name": "redundantPowerSupplyCount", - "type": "unsignedInt", - "form": "relational", - "doc": "A count of power supplies contained within this SoftLayer_Billing_Order" - }, - "softwareDescription": { - "name": "softwareDescription", - "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "For ordered items that are software items, a full description of that software can be found with this property. " - }, - "storageGroups": { - "name": "storageGroups", - "type": "SoftLayer_Configuration_Storage_Group_Order", - "form": "relational", - "typeArray": true, - "doc": "The drive storage groups that are attached to this billing order item." - }, - "totalRecurringAmount": { - "name": "totalRecurringAmount", - "type": "float", - "form": "relational", - "doc": "The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis." - }, - "upgradeItem": { - "name": "upgradeItem", - "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The next SoftLayer_Product_Item in the upgrade path for this order item." - }, - "categoryCode": { - "name": "categoryCode", - "type": "string", - "form": "local", - "doc": "The category code for the order item." - }, - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "friendly description of purchase item." - }, - "domainName": { - "name": "domainName", - "type": "string", - "form": "local", - "doc": "The domain name of the server as designated by the purchaser at the time of order placement." - }, - "hostName": { - "name": "hostName", - "type": "string", - "form": "local", - "doc": "The hostname of the server as designated by the purchaser at the time of order placement." - }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per hourly for an order item, if applicable, and only if it was ordered this day. hourlyRecurringFee is measured in US Dollars ($USD). " - }, - "id": { - "name": "id", - "type": "int", - "form": "local" - }, - "itemId": { - "name": "itemId", - "type": "int", - "form": "local", - "doc": "The SoftLayer_Product_Item ID for this order item." - }, - "itemPriceId": { - "name": "itemPriceId", - "type": "decimal", - "form": "local", - "doc": "the item price id (SoftLayer_Product_Item_Price->id) of the ordered item." - }, - "laborAfterTaxAmount": { - "name": "laborAfterTaxAmount", - "type": "decimal", - "form": "local", - "doc": "An order item's labor fee total after taxes. This does not include any child invoice items." - }, - "laborFee": { - "name": "laborFee", - "type": "decimal", - "form": "local", - "doc": "The labor fee, if any. This is a one time charge." - }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." - }, - "laborTaxAmount": { - "name": "laborTaxAmount", - "type": "decimal", - "form": "local", - "doc": "An order item's labor tax amount. This does not include any child invoice items." - }, - "oneTimeAfterTaxAmount": { - "name": "oneTimeAfterTaxAmount", - "type": "decimal", - "form": "local", - "doc": "An order item's one-time fee total after taxes. This does not include any child invoice items." - }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged as a one-time charge for an order item, if applicable. oneTimeFee is measured in US Dollars ($USD). " - }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." - }, - "oneTimeTaxAmount": { - "name": "oneTimeTaxAmount", - "type": "decimal", - "form": "local", - "doc": "An order item's one-time tax amount. This does not include any child invoice items." - }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local" - }, - "presetId": { - "name": "presetId", - "type": "int", - "form": "local", - "doc": "The id for the preset configuration ordered." - }, - "promoCodeId": { - "name": "promoCodeId", - "type": "int", - "form": "local" - }, - "quantity": { - "name": "quantity", - "type": "int", - "form": "local", - "doc": "the quantity of the ordered item in a quote." - }, - "recurringAfterTaxAmount": { - "name": "recurringAfterTaxAmount", - "type": "decimal", - "form": "local", - "doc": "An order item's recurring fee total after taxes. This does not include any child invoice items." - }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", - "form": "local", - "doc": "The amount of money charged per month for an order item, if applicable. recurringFee is measured in US Dollars ($USD). " - }, - "recurringTaxAmount": { - "name": "recurringTaxAmount", - "type": "decimal", - "form": "local", - "doc": "An order item's recurring tax amount. This does not include any child invoice items." - }, - "setupAfterTaxAmount": { - "name": "setupAfterTaxAmount", - "type": "decimal", - "form": "local", - "doc": "An order item's setup fee total after taxes. This does not include any child invoice items." - }, - "setupFee": { - "name": "setupFee", - "type": "decimal", - "form": "local", - "doc": "The setup fee, if any. This is a one time charge." - }, - "setupFeeDeferralMonths": { - "name": "setupFeeDeferralMonths", - "type": "int", - "form": "local", - "doc": "The month set up fee deferral." - }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." - }, - "setupTaxAmount": { - "name": "setupTaxAmount", - "type": "decimal", - "form": "local", - "doc": "An order item's setup tax amount. This does not include any child invoice items." - }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the other items included with an ordered item." - }, - "childrenCount": { - "name": "childrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the child order items for an order item. All server order items should have children. These children are considered a part of the server." - }, - "itemCategoryAnswerCount": { - "name": "itemCategoryAnswerCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this is an item's category answers." - }, - "nextOrderChildrenCount": { - "name": "nextOrderChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "storageGroupCount": { - "name": "storageGroupCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the drive storage groups that are attached to this billing order item." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } } }, - "SoftLayer_Billing_Order_Item_Category_Answer": { - "name": "SoftLayer_Billing_Order_Item_Category_Answer", - "base": "SoftLayer_Entity", + "SoftLayer_Billing_Item_Support": { + "name": "SoftLayer_Billing_Item_Support", + "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Order_Item_Category_Answer data type represents a single answer to an item category question. ", - "properties": { - "orderItem": { - "name": "orderItem", - "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The billing order item that the answer is for." - }, - "question": { - "name": "question", - "type": "SoftLayer_Product_Item_Category_Question", - "form": "relational", - "doc": "The question that is being answered." - }, - "answer": { - "name": "answer", - "type": "string", - "form": "local", - "doc": "The answer to the question." - }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date that the answer was created." - }, - "questionId": { - "name": "questionId", - "type": "int", - "form": "local", - "doc": "The identifier for the question that the answer belongs to." - } - }, - "deprecated": true, - "methods": {} - }, - "SoftLayer_Billing_Order_Quote": { - "name": "SoftLayer_Billing_Order_Quote", - "base": "SoftLayer_Entity", - "serviceDoc": "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: \n*'''PENDING''': Quotes which have not been paid yet. Quotes pending approval from a Softlayer customer.\n\n\nOnce 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. \n\nQuotes 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. \n\nQuery the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service to get a list of quotes for your account. ", + "typeDoc": "The SoftLayer_Billing_Item_Support data type contains general information relating to a premium support offering ", "methods": { - "claim": { - "name": "claim", - "type": "SoftLayer_Billing_Order_Quote", - "doc": "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. \n\nTo claim a quote, both the quote id and the quote key (the 32-character random string) must be provided. ", - "docOverview": "Claim an anonymous quote", - "static": true, - "maskable": true, + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], "parameters": [ { - "name": "quoteKey", + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false + }, + { + "name": "cancelAssociatedBillingItems", + "type": "boolean", + "doc": "This only applies to servers and virtual servers and will", + "defaultValue": false + }, + { + "name": "reason", "type": "string", - "doc": "The 32-character random string generated when the quote was created" + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null }, { - "name": "quoteId", - "type": "int", - "doc": "The quote's unique identifier (id) property" + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", + "defaultValue": null } ] }, - "deleteQuote": { - "name": "deleteQuote", - "type": "SoftLayer_Billing_Order_Quote", - "doc": "Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order. ", - "docOverview": "Delete the quote of an order", + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "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. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", "docErrorHandling": [ { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception 'You cannot delete a deleted quote.'" + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Order_Quote", - "method": "deleteQuote" - }, + ] + }, + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ { - "service": "SoftLayer_Billing_Order_Quote", - "method": "saveQuote" + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." } - ], - "maskable": true + ] }, "getObject": { "name": "getObject", - "type": "SoftLayer_Billing_Order_Quote", - "doc": "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. ", - "docOverview": "Retrieve a SoftLayer_Billing_Order_Quote record.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_ObjectNotFound", - "description": "Throw the error \"Unable to find object with id of {id}.\" if the given initialization parameter has an invalid id field." - } - ], + "type": "SoftLayer_Billing_Item", + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", "filterable": true, "maskable": true }, - "getPdf": { - "name": "getPdf", - "type": "base64Binary", - "doc": "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. ", - "docOverview": "Retrieve a PDF copy of a quote.", - "docErrorHandling": [ - { - "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception 'PDF does not exist: Order has not yet been created.'" - }, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "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. \n\nIn 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. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, + "parameters": [ { - "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception 'PDF does not exist: file not found.'" + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." }, { - "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception 'PDF does not exist: Unable to load the quote PDF.'" + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false } ] }, - "getQuoteByQuoteKey": { - "name": "getQuoteByQuoteKey", - "type": "SoftLayer_Billing_Order_Quote", - "doc": "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. ", - "docOverview": "Retrieve a [SoftLayer_Billing_Order_Quote](/reference/datatypes/SoftLayer_Billing_Order_Quote) by the quote key specified.", + "removeAssociationId": { + "name": "removeAssociationId", + "type": "boolean", + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", "docErrorHandling": [ { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception \"No quote found\"" - }, + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + } + ], + "docAssociatedMethods": [ { - "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception \"Quote is no longer valid.\"" - }, + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" + } + ] + }, + "setAssociationId": { + "name": "setAssociationId", + "type": "boolean", + "doc": "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. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception \"Quote expired.\"" + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." }, { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception \"Quote has been removed from the system.\"" + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." }, { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception \"Quote is unavailable.\"" + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." }, { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception \"Could not authenticate quote.\"" + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." } ], - "static": true, - "maskable": true, - "parameters": [ - { - "name": "quoteKey", - "type": "string", - "doc": "Key required to retrieve a quote." - } - ] - }, - "getRecalculatedOrderContainer": { - "name": "getRecalculatedOrderContainer", - "type": "SoftLayer_Container_Product_Order", - "doc": "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. ", - "docOverview": "Generate an [SoftLayer_Container_Product_Order](/reference/datatypes/SoftLayer_Container_Product_Order) from the previously-created quote. ", - "parameters": [ - { - "name": "userOrderData", - "type": "SoftLayer_Container_Product_Order", - "doc": "User supplied order data", - "defaultValue": null - }, - { - "name": "orderBeingPlacedFlag", - "type": "boolean", - "doc": "This flag is set and used internally", - "defaultValue": false - } - ] - }, - "placeOrder": { - "name": "placeOrder", - "type": "SoftLayer_Container_Product_Order_Receipt", - "doc": "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. ", - "docOverview": "Place an order", - "parameters": [ + "docAssociatedMethods": [ { - "name": "orderData", - "type": "SoftLayer_Container_Product_Order", - "doc": "Details required to order." + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" } - ] - }, - "placeQuote": { - "name": "placeQuote", - "type": "SoftLayer_Container_Product_Order", - "doc": "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. ", - "docOverview": "Saves changes to a quote", + ], "parameters": [ { - "name": "orderData", - "type": "SoftLayer_Container_Product_Order", - "doc": "Details required to order." + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" } ] }, - "saveQuote": { - "name": "saveQuote", - "type": "SoftLayer_Billing_Order_Quote", - "doc": "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. ", - "docOverview": "Save the quote of an order", + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", "docErrorHandling": [ { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception 'You cannot save a saved quote.'" + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." }, { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception 'You cannot save a deleted quote.'" + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." }, { "exception": "SoftLayer_Exception_Public", - "description": "Throws the exception 'You cannot save an invalid quote.'" - } - ], - "docAssociatedMethods": [ - { - "service": "SoftLayer_Billing_Order_Quote", - "method": "saveQuote" - }, - { - "service": "SoftLayer_Billing_Order_Quote", - "method": "deleteQuote" - } - ], - "maskable": true - }, - "verifyOrder": { - "name": "verifyOrder", - "type": "SoftLayer_Container_Product_Order", - "doc": "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. ", - "docOverview": "Verify an order", - "parameters": [ - { - "name": "orderData", - "type": "SoftLayer_Container_Product_Order", - "doc": "Details required to order." + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] }, - "withdrawGdprAcceptance": { - "name": "withdrawGdprAcceptance", - "type": "void", - "doc": "Withdraws the users acceptance of the GDPR terms. ", - "docOverview": "Withdraws the users acceptance of the GDPR terms." - }, "getAccount": { - "doc": "A quote's corresponding account.", + "doc": "The account that a billing item belongs to.", "docOverview": "", "name": "getAccount", "type": "SoftLayer_Account", @@ -60670,1579 +70809,1989 @@ "filterable": true, "deprecated": false }, - "getDoNotContactFlag": { - "doc": "Indicates whether the owner of the quote chosen to no longer be contacted.", + "getActiveAgreement": { + "doc": "", "docOverview": "", - "name": "getDoNotContactFlag", - "type": "boolean", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrder": { - "doc": "This order contains the records for which products were selected for this quote.", + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", "docOverview": "", - "name": "getOrder", - "type": "SoftLayer_Billing_Order", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOrdersFromQuote": { - "doc": "These are all the orders that were created from this quote.", + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", "docOverview": "", - "name": "getOrdersFromQuote", - "type": "SoftLayer_Billing_Order", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false, "limitable": true - } - }, - "typeDoc": "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. ", - "properties": { - "account": { - "name": "account", - "type": "SoftLayer_Account", - "form": "relational", - "doc": "A quote's corresponding account." }, - "doNotContactFlag": { - "name": "doNotContactFlag", - "type": "boolean", - "form": "relational", - "doc": "Indicates whether the owner of the quote chosen to no longer be contacted." - }, - "order": { - "name": "order", - "type": "SoftLayer_Billing_Order", - "form": "relational", - "doc": "This order contains the records for which products were selected for this quote." + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "ordersFromQuote": { - "name": "ordersFromQuote", - "type": "SoftLayer_Billing_Order", - "form": "relational", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", + "docOverview": "", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", "typeArray": true, - "doc": "These are all the orders that were created from this quote." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "accountId": { - "name": "accountId", - "type": "int", - "form": "local", - "doc": "Identification Number of the account record tied to the quote" + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", + "docOverview": "", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "completedPurchaseDataId": { - "name": "completedPurchaseDataId", - "type": "int", - "form": "local", - "doc": "Identification Number of the order record tied to the quote." + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "Holds the date the quote record was created" + "getActiveFlag": { + "doc": "", + "docOverview": "", + "name": "getActiveFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "expirationDate": { - "name": "expirationDate", - "type": "dateTime", - "form": "local", - "doc": "This property holds the date of expiration of a quote, after that date the quote would be deem expired" + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", + "docOverview": "", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The id use to identify a quote." + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", + "docOverview": "", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "Holds the date when the quote record was modified with reference to its creation date" + "getAssociatedBillingItem": { + "doc": "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.", + "docOverview": "", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "The name given to quote by the initiator" + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", + "docOverview": "", + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "publicNote": { - "name": "publicNote", - "type": "string", - "form": "local", - "doc": "This property Holds system generated notes. In our case if a quote is tied to an order where one of the order item has an inactive promotion code, the quote will be considered invalid." + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", + "docOverview": "", + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "quoteKey": { - "name": "quoteKey", - "type": "string", - "form": "local", - "doc": "Holds system generated hash password for the Quote" + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", + "docOverview": "", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "status": { - "name": "status", - "type": "string", - "form": "local", - "doc": "This property Holds the current status of a Quote: pending,expired, saved or deleted" + "getAvailableMatchingVlans": { + "doc": "", + "docOverview": "", + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "ordersFromQuoteCount": { - "name": "ordersFromQuoteCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of these are all the orders that were created from this quote." - } - } - }, - "SoftLayer_Billing_Order_Type": { - "name": "SoftLayer_Billing_Order_Type", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "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. ", - "properties": { - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "A brief description of where a SoftLayer order originated from. " + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", + "docOverview": "", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "A SoftLayer order type's internal identifier. " + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", + "docOverview": "", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "type": { - "name": "type", - "type": "string", - "form": "local", - "doc": "A simple keyname stating where a SoftLayer order originated from. " - } - }, - "methods": {} - }, - "SoftLayer_Billing_Payment_Card_ChangeRequest": { - "name": "SoftLayer_Billing_Payment_Card_ChangeRequest", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "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. ", - "properties": { - "account": { - "name": "account", - "type": "SoftLayer_Account", - "form": "relational" + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", + "docOverview": "", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "authorizedCreditCardTransaction": { - "name": "authorizedCreditCardTransaction", - "type": "SoftLayer_Billing_Payment_Card_Transaction", - "form": "relational", - "doc": "The SoftLayer_Billing_Payment_Card_Transaction tied to the authorization performed as part of this change request." + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "captureCreditCardTransaction": { - "name": "captureCreditCardTransaction", - "type": "SoftLayer_Billing_Payment_Card_Transaction", - "form": "relational", - "doc": "The SoftLayer_Billing_Payment_Card_Transaction tied to the capture of funds performed as part of this change request." + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "ticketAttachmentReferences": { - "name": "ticketAttachmentReferences", - "type": "SoftLayer_Ticket_Attachment", - "form": "relational", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", + "docOverview": "", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", "typeArray": true, - "doc": "These are tickets tied to a credit card change request." - }, - "accountId": { - "name": "accountId", - "type": "int", - "form": "local", - "doc": "The account ID to which the credit card and billing information is associated with." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "amount": { - "name": "amount", - "type": "decimal", - "form": "local", - "doc": "The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD)." + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", + "docOverview": "", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billingAddressLine1": { - "name": "billingAddressLine1", - "type": "string", - "form": "local", - "doc": "The physical street address. Reserve information such as \"apartment #123\" or \"Suite 2\" for line 1." + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "billingAddressLine2": { - "name": "billingAddressLine2", - "type": "string", - "form": "local", - "doc": "The second line in the address. Information such as suite number goes here." + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", + "docOverview": "", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "billingCity": { - "name": "billingCity", - "type": "string", - "form": "local", - "doc": "The city in which a customer's account resides." + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", + "docOverview": "", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "billingCountryCode": { - "name": "billingCountryCode", - "type": "string", - "form": "local", - "doc": "The 2-character Country code for an account's address. (i.e. US)" - }, - "billingEmail": { - "name": "billingEmail", - "type": "string", - "form": "local", - "doc": "The email address associated with a customer account." - }, - "billingNameCompany": { - "name": "billingNameCompany", - "type": "string", - "form": "local", - "doc": "the company name for an account." - }, - "billingNameFirst": { - "name": "billingNameFirst", - "type": "string", - "form": "local", - "doc": "The first name of the customer account owner." - }, - "billingNameLast": { - "name": "billingNameLast", - "type": "string", - "form": "local", - "doc": "The last name of the customer account owner" - }, - "billingPhoneFax": { - "name": "billingPhoneFax", - "type": "string", - "form": "local", - "doc": "The fax number associated with a customer account." - }, - "billingPhoneVoice": { - "name": "billingPhoneVoice", - "type": "string", - "form": "local", - "doc": "The phone number associated with a customer account." + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "billingPostalCode": { - "name": "billingPostalCode", - "type": "string", - "form": "local", - "doc": "The Zip or Postal Code for the billing address on an account." + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billingState": { - "name": "billingState", - "type": "string", - "form": "local", - "doc": "The State for the account." + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "browserScreenHeight": { - "name": "browserScreenHeight", - "type": "string", - "form": "local", - "doc": "Total height of browser screen in pixels. " + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "browserScreenWidth": { - "name": "browserScreenWidth", - "type": "string", - "form": "local", - "doc": "Total width of browser screen in pixels. " + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cardAccountLast4": { - "name": "cardAccountLast4", - "type": "string", - "form": "local", - "doc": "The last 4 digits of a customer's credit card." + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cardAccountNumber": { - "name": "cardAccountNumber", - "type": "string", - "form": "local", - "doc": "The card number submitted in the change request." + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "cardExpirationMonth": { - "name": "cardExpirationMonth", - "type": "string", - "form": "local", - "doc": "The month (MM) in which a customer's payment card will expire." + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cardExpirationYear": { - "name": "cardExpirationYear", - "type": "string", - "form": "local", - "doc": "The year (YYYY) in which a customer's payment card will expire." + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cardNickname": { - "name": "cardNickname", - "type": "string", - "form": "local" + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "cardType": { - "name": "cardType", - "type": "string", - "form": "local", - "doc": "The type of payment card a customer has. (i.e. Visa, MasterCard, American Express)." + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "creditCardVerificationNumber": { - "name": "creditCardVerificationNumber", - "type": "string", - "form": "local", - "doc": "The credit card verification number submitted in the change request." + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "currencyShortName": { - "name": "currencyShortName", - "type": "string", - "form": "local", - "doc": "Describes the currency selected for payment" + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "deviceFingerprintId": { - "name": "deviceFingerprintId", - "type": "string", - "form": "local", - "doc": "Device Fingerprint Identifier - Used internally and can safely be ignored." + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for a single change request." + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "notes": { - "name": "notes", - "type": "string", - "form": "local", - "doc": "the notes stored about a customer's payment card." + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "payerAuthenticationEnrollmentReferenceId": { - "name": "payerAuthenticationEnrollmentReferenceId", - "type": "string", - "form": "local", - "doc": "The purpose of this property is to allow enablement of 3D Secure (3DS). This is the Reference ID that corresponds to the device data for Payer Authentication. In order to properly enable 3DS, this will require implementation of Cardinal Cruise Hybrid. \n\nPlease refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under \"DFReferenceId / ReferenceId\" to populate this property accordingly. " + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "payerAuthenticationEnrollmentReturnUrl": { - "name": "payerAuthenticationEnrollmentReturnUrl", - "type": "string", - "form": "local", - "doc": "The URL where the issuing bank will redirect. " + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "payerAuthenticationWebToken": { - "name": "payerAuthenticationWebToken", - "type": "string", - "form": "local", - "doc": "\"Continue with Consumer Authentication\" decoded response JWT (JSON Web Token) after successful authentication. The response is part of the implementation of Cardinal Cruise Hybrid. \n\nPlease refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under \"Continue with Consumer Authentication\" to populate this property accordingly based on the CCA response. " + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "paymentRoleId": { - "name": "paymentRoleId", - "type": "int", - "form": "local" + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "paymentType": { - "name": "paymentType", - "type": "string", - "form": "local", - "doc": "The description of the type of payment sent in a change transaction." + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "ticketId": { - "name": "ticketId", - "type": "int", - "form": "local", - "doc": "Unique identifier for a ticket discussing the switch between payment methods." + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "ticketAttachmentReferenceCount": { - "name": "ticketAttachmentReferenceCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of these are tickets tied to a credit card change request." + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true } }, - "methods": {} - }, - "SoftLayer_Billing_Payment_Card_ManualPayment": { - "name": "SoftLayer_Billing_Payment_Card_ManualPayment", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "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. ", "properties": { "account": { "name": "account", "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." + }, + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", "form": "relational" }, - "authorizedCreditCardTransaction": { - "name": "authorizedCreditCardTransaction", - "type": "SoftLayer_Billing_Payment_Card_Transaction", + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", "form": "relational", - "doc": "This is the credit card transaction data tied to a credit card manual payment." + "doc": "A flag indicating that the billing item is under an active agreement." }, - "authorizedPayPalTransaction": { - "name": "authorizedPayPalTransaction", - "type": "SoftLayer_Billing_Payment_PayPal_Transaction", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", "form": "relational", - "doc": "This is the PayPal transaction data tied to a PayPal manual payment." + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." }, - "captureCreditCardTransaction": { - "name": "captureCreditCardTransaction", - "type": "SoftLayer_Billing_Payment_Card_Transaction", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", "form": "relational", - "doc": "The SoftLayer_Billing_Payment_Card_Transaction tied to the capture performed as part of this manual payment. This will only exist if the manual payment was performed with a credit card." + "typeArray": true }, - "capturePayPalTransaction": { - "name": "capturePayPalTransaction", - "type": "SoftLayer_Billing_Payment_PayPal_Transaction", + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", "form": "relational", - "doc": "The SoftLayer_Billing_Payment_PayPal_Transaction tied to the capture performed as part of this manual payment. This will only exist if the manual payment was performed via PayPal." + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." }, - "ticketAttachmentReferences": { - "name": "ticketAttachmentReferences", - "type": "SoftLayer_Ticket_Attachment", + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." + }, + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", "form": "relational", "typeArray": true, - "doc": "These are tickets tied to a credit card manual payment." + "doc": "A Billing Item's active child billing items." }, - "accountId": { - "name": "accountId", - "type": "int", - "form": "local", - "doc": "The account ID to which the credit card and billing information is associated with." + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" }, - "amount": { - "name": "amount", - "type": "decimal", - "form": "local", - "doc": "The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD)." + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true }, - "authorizedCreditCardTransactionId": { - "name": "authorizedCreditCardTransactionId", - "type": "int", - "form": "local", - "doc": "The unique identifier of an attempted credit card transaction." + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." }, - "authorizedPayPalTransactionId": { - "name": "authorizedPayPalTransactionId", - "type": "int", - "form": "local", - "doc": "The unique identifier of an attempted PayPal transaction." + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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." }, - "billingAddressLine1": { - "name": "billingAddressLine1", - "type": "string", - "form": "local", - "doc": "The physical street address. Reserve information such as \"apartment #123\" or \"Suite 2\" for line 1." + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." }, - "billingAddressLine2": { - "name": "billingAddressLine2", - "type": "string", - "form": "local", - "doc": "The second line in the address. Information such as suite number goes here." + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." }, - "billingCity": { - "name": "billingCity", - "type": "string", - "form": "local", - "doc": "The city in which a customer's account resides." + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." }, - "billingCountryCode": { - "name": "billingCountryCode", - "type": "string", - "form": "local", - "doc": "The 2-character Country code for an account's address. (i.e. US)" + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true }, - "billingEmail": { - "name": "billingEmail", - "type": "string", - "form": "local", - "doc": "The email address associated with a customer account." + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." }, - "billingNameCompany": { - "name": "billingNameCompany", - "type": "string", - "form": "local", - "doc": "the company name for an account." + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "billingNameFirst": { - "name": "billingNameFirst", - "type": "string", - "form": "local", - "doc": "The first name of the customer account owner." + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's bundled billing items." }, - "billingNameLast": { - "name": "billingNameLast", - "type": "string", - "form": "local", - "doc": "The last name of the customer account owner." + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." }, - "billingPhoneFax": { - "name": "billingPhoneFax", - "type": "string", - "form": "local", - "doc": "The fax number associated with a customer account." + "cancellationReason": { + "name": "cancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "billingPhoneVoice": { - "name": "billingPhoneVoice", - "type": "string", - "form": "local", - "doc": "The phone number associated with a customer account." + "cancellationRequests": { + "name": "cancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", + "typeArray": true, + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "billingPostalCode": { - "name": "billingPostalCode", - "type": "string", - "form": "local", - "doc": "The Zip or Postal Code for the billing address on an account." + "category": { + "name": "category", + "type": "SoftLayer_Product_Item_Category", + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "billingState": { - "name": "billingState", - "type": "string", - "form": "local", - "doc": "The State for the account." + "children": { + "name": "children", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items'" }, - "browserScreenHeight": { - "name": "browserScreenHeight", - "type": "string", - "form": "local", - "doc": "Total height of browser screen in pixels. " + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." }, - "browserScreenWidth": { - "name": "browserScreenWidth", - "type": "string", - "form": "local", - "doc": "Total width of browser screen in pixels. " + "downgradeItems": { + "name": "downgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "cancelUrl": { - "name": "cancelUrl", - "type": "string", - "form": "local", - "doc": "The cancel URL is the page to which PayPal redirects if payment is not approved." + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "cardAccountHash": { - "name": "cardAccountHash", - "type": "string", - "form": "local", - "doc": "A hash value of the credit card number." + "hourlyFlag": { + "name": "hourlyFlag", + "type": "boolean", + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "cardAccountLast4": { - "name": "cardAccountLast4", - "type": "string", - "form": "local", - "doc": "The last 4 digits of a customer's credit card." + "invoiceItem": { + "name": "invoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "cardAccountNumber": { - "name": "cardAccountNumber", - "type": "string", - "form": "local", - "doc": "The card number submitted in the change request." + "invoiceItems": { + "name": "invoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "typeArray": true, + "doc": "All invoice items associated with the billing item" }, - "cardExpirationMonth": { - "name": "cardExpirationMonth", - "type": "string", - "form": "local", - "doc": "The month (MM) in which a customer's payment card will expire." + "item": { + "name": "item", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "cardExpirationYear": { - "name": "cardExpirationYear", - "type": "string", - "form": "local", - "doc": "The year (YYYY) in which a customer's payment card will expire." + "location": { + "name": "location", + "type": "SoftLayer_Location", + "form": "relational", + "doc": "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." }, - "cardType": { - "name": "cardType", - "type": "string", - "form": "local", - "doc": "The method key of the type payment issued (Visa - 001, Mastercard - 002, American Express - 003, Discover - 004, PayPal - paypal)." + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items and associated items'" }, - "creditCardVerificationNumber": { - "name": "creditCardVerificationNumber", - "type": "string", - "form": "local", - "doc": "The credit card verification number submitted in the change request." + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "currencyShortName": { - "name": "currencyShortName", - "type": "string", - "form": "local", - "doc": "Describes the currency selected for payment" + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "deviceFingerprintId": { - "name": "deviceFingerprintId", - "type": "string", - "form": "local", - "doc": "Device Fingerprint Identifier - Used internally and can safely be ignored." + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" }, - "fromIpAddress": { - "name": "fromIpAddress", - "type": "string", - "form": "local", - "doc": "The IP address from which the transaction originates." + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", + "type": "float", + "form": "relational", + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." }, - "id": { - "name": "id", + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + }, + "orderItem": { + "name": "orderItem", + "type": "SoftLayer_Billing_Order_Item", + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + }, + "originalLocation": { + "name": "originalLocation", + "type": "SoftLayer_Location", + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." + }, + "package": { + "name": "package", + "type": "SoftLayer_Product_Package", + "form": "relational", + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + }, + "parent": { + "name": "parent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + }, + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + }, + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", + "type": "boolean", + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + }, + "pendingOrderItem": { + "name": "pendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "form": "relational", + "doc": "The new order item that will replace this billing item." + }, + "provisionTransaction": { + "name": "provisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "form": "relational", + "doc": "Provisioning transaction for this billing item" + }, + "softwareDescription": { + "name": "softwareDescription", + "type": "SoftLayer_Software_Description", + "form": "relational", + "doc": "A friendly description of software component" + }, + "upgradeItem": { + "name": "upgradeItem", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + }, + "upgradeItems": { + "name": "upgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." + }, + "allowCancellationFlag": { + "name": "allowCancellationFlag", "type": "int", "form": "local", - "doc": "The unique identifier for a single manual payment request." + "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " }, - "notes": { - "name": "notes", + "associatedBillingItemId": { + "name": "associatedBillingItemId", "type": "string", "form": "local", - "doc": "Notes generated as a result of the payment request." + "doc": "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](/reference/datatypes/$1/#$2). 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. " }, - "payerAuthenticationEnrollmentReferenceId": { - "name": "payerAuthenticationEnrollmentReferenceId", - "type": "string", + "cancellationDate": { + "name": "cancellationDate", + "type": "dateTime", "form": "local", - "doc": "The purpose of this property is to allow enablement of 3D Secure (3DS). This is the Reference ID that corresponds to the device data for Payer Authentication. In order to properly enable 3DS, this will require implementation of Cardinal Cruise Hybrid. \n\nPlease refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under \"DFReferenceId / ReferenceId\" to populate this property accordingly. " + "doc": "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. " }, - "payerAuthenticationEnrollmentReturnUrl": { - "name": "payerAuthenticationEnrollmentReturnUrl", + "categoryCode": { + "name": "categoryCode", "type": "string", "form": "local", - "doc": "The URL where the issuing bank will redirect. " + "doc": "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." }, - "payerAuthenticationWebToken": { - "name": "payerAuthenticationWebToken", - "type": "string", + "createDate": { + "name": "createDate", + "type": "dateTime", "form": "local", - "doc": "\"Continue with Consumer Authentication\" decoded response JWT (JSON Web Token) after successful authentication. The response is part of the implementation of Cardinal Cruise Hybrid. \n\nPlease refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under \"Continue with Consumer Authentication\" to populate this property accordingly based on the CCA response. " + "doc": "The date the billing item was created. You can see this date on the invoice." }, - "paymentType": { - "name": "paymentType", + "currentHourlyCharge": { + "name": "currentHourlyCharge", "type": "string", "form": "local", - "doc": "The description of the type of payment sent in a change transaction." + "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " }, - "returnUrl": { - "name": "returnUrl", - "type": "string", + "cycleStartDate": { + "name": "cycleStartDate", + "type": "dateTime", "form": "local", - "doc": "The return URL is the page to which PayPal redirects after payment is approved." + "doc": "The last time this billing item was charged." }, - "type": { - "name": "type", + "description": { + "name": "description", "type": "string", "form": "local", - "doc": "Describes the type of manual payment (PAYPAL or CREDIT_CARD)." + "doc": "A brief description of a billing item." }, - "ticketAttachmentReferenceCount": { - "name": "ticketAttachmentReferenceCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of these are tickets tied to a credit card manual payment." - } - }, - "methods": {} - }, - "SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup": { - "name": "SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "This datatype payer authentication setup ", - "properties": { - "accessToken": { - "name": "accessToken", + "domainName": { + "name": "domainName", "type": "string", "form": "local", - "doc": "This is used to authenticate the customer with the authentication provider." + "doc": "The domain name is provided for server billing items." }, - "deviceDataCollectionUrl": { - "name": "deviceDataCollectionUrl", + "hostName": { + "name": "hostName", "type": "string", "form": "local", - "doc": "Location to send the authentication when you invoke device data collection." + "doc": "The hostname is provided for server billing items" }, - "referenceId": { - "name": "referenceId", - "type": "string", + "hourlyRecurringFee": { + "name": "hourlyRecurringFee", + "type": "decimal", "form": "local", - "doc": "This identifier indicates that the device data collection" - } - }, - "methods": {} - }, - "SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup_Information": { - "name": "SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup_Information", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Account::initiatePayerAuthentication. ", - "properties": { - "billingAddressLine1": { - "name": "billingAddressLine1", + "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " + }, + "hoursUsed": { + "name": "hoursUsed", "type": "string", "form": "local", - "doc": "The physical street address. Reserve information such as \"apartment #123\" or \"Suite 2\" for line 1." + "doc": "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. " }, - "billingAddressLine2": { - "name": "billingAddressLine2", - "type": "string", + "id": { + "name": "id", + "type": "int", "form": "local", - "doc": "The second line in the address. Information such as suite number goes here." + "doc": "The unique identifier for this billing item." }, - "billingCity": { - "name": "billingCity", - "type": "string", + "laborFee": { + "name": "laborFee", + "type": "decimal", "form": "local", - "doc": "The city in which a customer's account resides." + "doc": "The labor fee, if any. This is a one time charge." }, - "billingCountryCode": { - "name": "billingCountryCode", - "type": "string", + "laborFeeTaxRate": { + "name": "laborFeeTaxRate", + "type": "decimal", "form": "local", - "doc": "The 2-character Country code for an account's address. (i.e. US)" + "doc": "The rate at which labor fees are taxed if you are a taxable customer." }, - "billingEmail": { - "name": "billingEmail", - "type": "string", + "lastBillDate": { + "name": "lastBillDate", + "type": "dateTime", "form": "local", - "doc": "The email address associated with a customer account." + "doc": "The last time this billing item was charged." }, - "billingNameFirst": { - "name": "billingNameFirst", - "type": "string", + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", "form": "local", - "doc": "The first name of the customer account owner." + "doc": "The date that a billing item was last modified." }, - "billingNameLast": { - "name": "billingNameLast", - "type": "string", + "nextBillDate": { + "name": "nextBillDate", + "type": "dateTime", "form": "local", - "doc": "The last name of the customer account owner" + "doc": "The date on which your account will be charged for this billing item. " }, - "billingPostalCode": { - "name": "billingPostalCode", + "notes": { + "name": "notes", "type": "string", "form": "local", - "doc": "The Zip or Postal Code for the billing address on an account." + "doc": "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." }, - "billingState": { - "name": "billingState", - "type": "string", + "oneTimeFee": { + "name": "oneTimeFee", + "type": "decimal", "form": "local", - "doc": "The State for the account." + "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " }, - "cardAccountNumber": { - "name": "cardAccountNumber", - "type": "string", + "oneTimeFeeTaxRate": { + "name": "oneTimeFeeTaxRate", + "type": "decimal", "form": "local", - "doc": "The credit card number to use." + "doc": "The rate at which one time fees are taxed if you are a taxable customer." }, - "cardExpirationMonth": { - "name": "cardExpirationMonth", + "orderItemId": { + "name": "orderItemId", "type": "int", "form": "local", - "doc": "The payment card expiration month" + "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." }, - "cardExpirationYear": { - "name": "cardExpirationYear", + "packageId": { + "name": "packageId", "type": "int", "form": "local", - "doc": "The payment card expiration year" + "doc": "This is the package id for this billing item." }, - "cardType": { - "name": "cardType", - "type": "string", + "parentId": { + "name": "parentId", + "type": "int", "form": "local", - "doc": "The method key of the type payment issued" + "doc": "The unique identifier of the parent of this billing item." }, - "creditCardVerificationNumber": { - "name": "creditCardVerificationNumber", - "type": "string", + "recurringFee": { + "name": "recurringFee", + "type": "decimal", "form": "local", - "doc": "The credit card verification number" - } - }, - "methods": {} - }, - "SoftLayer_Billing_Payment_Card_Transaction": { - "name": "SoftLayer_Billing_Payment_Card_Transaction", - "base": "SoftLayer_Billing_Payment_Transaction", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Payment_Card_Transaction data type contains general information relating to attempted credit card transactions. ", - "properties": { - "account": { - "name": "account", - "type": "SoftLayer_Account", - "form": "relational", - "doc": "The account to which a transaction belongs." - }, - "order": { - "name": "order", - "type": "SoftLayer_Billing_Order", - "form": "relational" - }, - "accountId": { - "name": "accountId", - "type": "int", - "form": "local", - "doc": "The account ID to which the credit card and billing information is associated with." + "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " }, - "amount": { - "name": "amount", + "recurringFeeTaxRate": { + "name": "recurringFeeTaxRate", "type": "decimal", "form": "local", - "doc": "The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD)." + "doc": "The rate at which recurring fees are taxed if you are a taxable customer." }, - "billingAddressLine1": { - "name": "billingAddressLine1", - "type": "string", + "recurringMonths": { + "name": "recurringMonths", + "type": "int", "form": "local", - "doc": "The physical street address. Reserve information such as \"apartment #123\" or \"Suite 2\" for line 1." + "doc": "The number of months in which the recurring fees will be incurred." }, - "billingAddressLine2": { - "name": "billingAddressLine2", - "type": "string", + "serviceProviderId": { + "name": "serviceProviderId", + "type": "int", "form": "local", - "doc": "The second line in the address. Information such as suite number goes here." + "doc": "This is the service provider for this billing item. " }, - "billingCity": { - "name": "billingCity", - "type": "string", + "setupFee": { + "name": "setupFee", + "type": "decimal", "form": "local", - "doc": "The city in which a customer's account resides." + "doc": "The setup fee, if any. This is a one time charge." }, - "billingCountryCode": { - "name": "billingCountryCode", - "type": "string", + "setupFeeTaxRate": { + "name": "setupFeeTaxRate", + "type": "decimal", "form": "local", - "doc": "The 2-character Country code for an account's address. (i.e. US)" + "doc": "The rate at which setup fees are taxed if you are a taxable customer." }, - "billingEmail": { - "name": "billingEmail", - "type": "string", - "form": "local", - "doc": "The email address associated with a customer account." + "activeAssociatedChildrenCount": { + "name": "activeAssociatedChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "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." }, - "billingNameCompany": { - "name": "billingNameCompany", - "type": "string", - "form": "local", - "doc": "the company name for an account." + "activeAssociatedGuestDiskBillingItemCount": { + "name": "activeAssociatedGuestDiskBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "billingNameFirst": { - "name": "billingNameFirst", - "type": "string", - "form": "local", - "doc": "The first name of the customer account owner." + "activeBundledItemCount": { + "name": "activeBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active bundled billing items." }, - "billingNameLast": { - "name": "billingNameLast", - "type": "string", - "form": "local", - "doc": "The last name of the customer account owner." + "activeChildrenCount": { + "name": "activeChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." }, - "billingPhoneFax": { - "name": "billingPhoneFax", - "type": "string", - "form": "local", - "doc": "The fax number associated with a customer account." + "activeSparePoolAssociatedGuestDiskBillingItemCount": { + "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "billingPhoneVoice": { - "name": "billingPhoneVoice", - "type": "string", - "form": "local", - "doc": "The phone number associated with a customer account." + "activeSparePoolBundledItemCount": { + "name": "activeSparePoolBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's spare pool bundled billing items." }, - "billingPostalCode": { - "name": "billingPostalCode", - "type": "string", - "form": "local", - "doc": "The Zip or Postal Code for the billing address on an account." + "associatedBillingItemHistoryCount": { + "name": "associatedBillingItemHistoryCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a history of billing items which a billing item has been associated with." }, - "billingState": { - "name": "billingState", - "type": "string", - "form": "local", - "doc": "The State for the account." + "associatedChildrenCount": { + "name": "associatedChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "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." }, - "cardAccountLast4": { - "name": "cardAccountLast4", - "type": "int", - "form": "local", - "doc": "The last 4 digits of a customer's credit card." + "associatedParentCount": { + "name": "associatedParentCount", + "type": "unsignedLong", + "form": "count", + "doc": "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." }, - "cardExpirationMonth": { - "name": "cardExpirationMonth", - "type": "int", - "form": "local", - "doc": "The month (MM) in which a customer's payment card will expire." + "availableMatchingVlanCount": { + "name": "availableMatchingVlanCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "cardExpirationYear": { - "name": "cardExpirationYear", - "type": "int", - "form": "local", - "doc": "The year (YYYY) in which a customer's payment card will expire." + "billableChildrenCount": { + "name": "billableChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "cardType": { - "name": "cardType", - "type": "string", - "form": "local", - "doc": "The type of payment issued (i.e. Visa, MasterCard, American Express)." + "bundledItemCount": { + "name": "bundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's bundled billing items." }, - "createDate": { - "name": "createDate", - "type": "dateTime", - "form": "local", - "doc": "The date that the transaction was attempted." + "canceledChildrenCount": { + "name": "canceledChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for a single credit card transaction request." + "cancellationRequestCount": { + "name": "cancellationRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of this will return any cancellation requests that are associated with this billing item." }, - "invoiceId": { - "name": "invoiceId", - "type": "int", - "form": "local", - "doc": "Unique identifier of the invoice to which funds will be applied." + "childrenCount": { + "name": "childrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing items'" }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", - "form": "local", - "doc": "The date that the transaction was modified." + "childrenWithActiveAgreementCount": { + "name": "childrenWithActiveAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." }, - "orderFromIpAddress": { - "name": "orderFromIpAddress", - "type": "string", - "form": "local", - "doc": "The IP address from which the transaction originates." + "downgradeItemCount": { + "name": "downgradeItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of for product items which have a downgrade path defined, this will return those product items." }, - "referenceCode": { - "name": "referenceCode", - "type": "string", - "form": "local", - "doc": "A code used by the financial institution to refer to the requested transaction." + "filteredNextInvoiceChildrenCount": { + "name": "filteredNextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "requestId": { - "name": "requestId", - "type": "string", - "form": "local", - "doc": "The unique identifier of the request submitted to the financial institution." + "invoiceItemCount": { + "name": "invoiceItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all invoice items associated with the billing item" }, - "returnStatus": { - "name": "returnStatus", - "type": "int", - "form": "local", - "doc": "The status code returned from the financial institution." + "nextInvoiceChildrenCount": { + "name": "nextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing items and associated items'" }, - "serializedReply": { - "name": "serializedReply", - "type": "string", - "form": "local", - "doc": "A serialized, delimited string of the transaction request sent to the financial institution." + "nonZeroNextInvoiceChildrenCount": { + "name": "nonZeroNextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." }, - "serializedRequest": { - "name": "serializedRequest", - "type": "string", - "form": "local", - "doc": "A serialized, delimited string of the transaction request sent to the financial institution." + "upgradeItemCount": { + "name": "upgradeItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "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." } - }, - "methods": {} + } }, - "SoftLayer_Billing_Payment_PayPal_Transaction": { - "name": "SoftLayer_Billing_Payment_PayPal_Transaction", - "base": "SoftLayer_Billing_Payment_Transaction", + "SoftLayer_Billing_Item_User_Customer_External_Binding": { + "name": "SoftLayer_Billing_Item_User_Customer_External_Binding", + "base": "SoftLayer_Billing_Item", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Payment_PayPal_Transaction data type contains general information relating to attempted PayPal transactions. ", + "typeDoc": "The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to an external authentication binding ", "properties": { + "resource": { + "name": "resource", + "type": "SoftLayer_User_Customer_External_Binding", + "form": "relational", + "doc": "The external authentication binding that a billing item is associated with." + }, "account": { "name": "account", "type": "SoftLayer_Account", "form": "relational", - "doc": "The account to which a transaction belongs." + "doc": "The account that a billing item belongs to." }, - "order": { - "name": "order", - "type": "SoftLayer_Billing_Order", + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", "form": "relational" }, - "accountId": { - "name": "accountId", - "type": "int", - "form": "local", - "doc": "The account ID to which the PayPal and billing information is associated with." + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "addressCityName": { - "name": "addressCityName", - "type": "string", - "form": "local", - "doc": "City given in the address of the PayPal user." + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." }, - "addressCountry": { - "name": "addressCountry", - "type": "string", - "form": "local", - "doc": "Country given in the named address of the PayPal user." + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true }, - "addressName": { - "name": "addressName", - "type": "string", - "form": "local", - "doc": "Name given to the address provided for the PayPal user." + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." }, - "addressPostalCode": { - "name": "addressPostalCode", - "type": "string", - "form": "local", - "doc": "Postal Code of the address of the PayPal user." + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "addressStateProvence": { - "name": "addressStateProvence", - "type": "string", - "form": "local", - "doc": "State or Province in the address of the PayPal user." + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." }, - "addressStatus": { - "name": "addressStatus", - "type": "string", + "activeFlag": { + "name": "activeFlag", + "type": "boolean", + "form": "relational" + }, + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." + }, + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." + }, + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." + }, + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." + }, + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true + }, + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." + }, + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." + }, + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's bundled billing items." + }, + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "cancellationReason": { + "name": "cancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "form": "relational", + "doc": "The billing item's cancellation reason." + }, + "cancellationRequests": { + "name": "cancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", + "typeArray": true, + "doc": "This will return any cancellation requests that are associated with this billing item." + }, + "category": { + "name": "category", + "type": "SoftLayer_Product_Item_Category", + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " + }, + "children": { + "name": "children", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items'" + }, + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." + }, + "downgradeItems": { + "name": "downgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "For product items which have a downgrade path defined, this will return those product items." + }, + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + }, + "hourlyFlag": { + "name": "hourlyFlag", + "type": "boolean", + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + }, + "invoiceItem": { + "name": "invoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "doc": "Invoice items associated with this billing item" + }, + "invoiceItems": { + "name": "invoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "typeArray": true, + "doc": "All invoice items associated with the billing item" + }, + "item": { + "name": "item", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + }, + "location": { + "name": "location", + "type": "SoftLayer_Location", + "form": "relational", + "doc": "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": { + "name": "nextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items and associated items'" + }, + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" + }, + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" + }, + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", + "type": "float", + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + }, + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", + "type": "float", + "form": "relational", + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only." + }, + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + }, + "orderItem": { + "name": "orderItem", + "type": "SoftLayer_Billing_Order_Item", + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." + }, + "originalLocation": { + "name": "originalLocation", + "type": "SoftLayer_Location", + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." + }, + "package": { + "name": "package", + "type": "SoftLayer_Product_Package", + "form": "relational", + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms." + }, + "parent": { + "name": "parent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + }, + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + }, + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", + "type": "boolean", + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + }, + "pendingOrderItem": { + "name": "pendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "form": "relational", + "doc": "The new order item that will replace this billing item." + }, + "provisionTransaction": { + "name": "provisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "form": "relational", + "doc": "Provisioning transaction for this billing item" + }, + "softwareDescription": { + "name": "softwareDescription", + "type": "SoftLayer_Software_Description", + "form": "relational", + "doc": "A friendly description of software component" + }, + "upgradeItem": { + "name": "upgradeItem", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path." + }, + "upgradeItems": { + "name": "upgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", + "typeArray": true, + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." + }, + "allowCancellationFlag": { + "name": "allowCancellationFlag", + "type": "int", "form": "local", - "doc": "PayPal defined status of the address of the PayPal user." + "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " }, - "addressStreet1": { - "name": "addressStreet1", + "associatedBillingItemId": { + "name": "associatedBillingItemId", "type": "string", "form": "local", - "doc": "First line of the street address of the PayPal user." + "doc": "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](/reference/datatypes/$1/#$2). 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. " }, - "addressStreet2": { - "name": "addressStreet2", - "type": "string", + "cancellationDate": { + "name": "cancellationDate", + "type": "dateTime", "form": "local", - "doc": "Second line of the street address of the PayPal user." + "doc": "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. " }, - "contactPhone": { - "name": "contactPhone", + "categoryCode": { + "name": "categoryCode", "type": "string", "form": "local", - "doc": "Phone number provided for the PayPal user." + "doc": "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." }, "createDate": { "name": "createDate", "type": "dateTime", "form": "local", - "doc": "The date that the transaction was attempted." + "doc": "The date the billing item was created. You can see this date on the invoice." }, - "exchangeRate": { - "name": "exchangeRate", + "currentHourlyCharge": { + "name": "currentHourlyCharge", "type": "string", "form": "local", - "doc": "Exchange rate imposed on the payment amount." - }, - "feeAmount": { - "name": "feeAmount", - "type": "decimal", - "form": "local", - "doc": "PayPal fee applied to the payment." - }, - "grossAmount": { - "name": "grossAmount", - "type": "decimal", - "form": "local", - "doc": "The total amount of the payment executed by PayPal, represented in decimal format as US Dollars ($USD)." - }, - "id": { - "name": "id", - "type": "int", - "form": "local", - "doc": "The unique identifier for a single PayPal transaction request." + "doc": "This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. " }, - "invoiceId": { - "name": "invoiceId", - "type": "int", + "cycleStartDate": { + "name": "cycleStartDate", + "type": "dateTime", "form": "local", - "doc": "Unique identifier of the invoice to which funds will be applied." + "doc": "The last time this billing item was charged." }, - "lastPaypalCommand": { - "name": "lastPaypalCommand", + "description": { + "name": "description", "type": "string", "form": "local", - "doc": "The name of the command issued to PayPal with regards to the attempted transaction." + "doc": "A brief description of a billing item." }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", + "domainName": { + "name": "domainName", + "type": "string", "form": "local", - "doc": "The date that the transaction was modified." + "doc": "The domain name is provided for server billing items." }, - "orderFromIpAddress": { - "name": "orderFromIpAddress", + "hostName": { + "name": "hostName", "type": "string", "form": "local", - "doc": "The IP address from where the PayPal payment request originated." + "doc": "The hostname is provided for server billing items" }, - "orderTotal": { - "name": "orderTotal", + "hourlyRecurringFee": { + "name": "hourlyRecurringFee", "type": "decimal", "form": "local", - "doc": "The amount of the payment submitted through the SoftLayer interface, represented in decimal format as US Dollars ($USD)." - }, - "payer": { - "name": "payer", - "type": "string", - "form": "local", - "doc": "The PayPal user account name (email address) associated with the customer account." + "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " }, - "payerBusiness": { - "name": "payerBusiness", + "hoursUsed": { + "name": "hoursUsed", "type": "string", "form": "local", - "doc": "The name of the business associated with the PayPal user." + "doc": "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. " }, - "payerCountry": { - "name": "payerCountry", - "type": "string", + "id": { + "name": "id", + "type": "int", "form": "local", - "doc": "Country given in the address of the PayPal user." + "doc": "The unique identifier for this billing item." }, - "payerFirstName": { - "name": "payerFirstName", - "type": "string", + "laborFee": { + "name": "laborFee", + "type": "decimal", "form": "local", - "doc": "First name of the PayPal user." + "doc": "The labor fee, if any. This is a one time charge." }, - "payerId": { - "name": "payerId", - "type": "string", + "laborFeeTaxRate": { + "name": "laborFeeTaxRate", + "type": "decimal", "form": "local", - "doc": "Unique PayPal user account identifier." + "doc": "The rate at which labor fees are taxed if you are a taxable customer." }, - "payerLastName": { - "name": "payerLastName", - "type": "string", + "lastBillDate": { + "name": "lastBillDate", + "type": "dateTime", "form": "local", - "doc": "Last name of the PayPal user." + "doc": "The last time this billing item was charged." }, - "payerStatus": { - "name": "payerStatus", - "type": "string", + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", "form": "local", - "doc": "Current PayPal status associated with the user account." + "doc": "The date that a billing item was last modified." }, - "paymentDate": { - "name": "paymentDate", + "nextBillDate": { + "name": "nextBillDate", "type": "dateTime", "form": "local", - "doc": "Date that the payment was confirmed in PayPal by the user." + "doc": "The date on which your account will be charged for this billing item. " }, - "paymentStatus": { - "name": "paymentStatus", + "notes": { + "name": "notes", "type": "string", "form": "local", - "doc": "PayPal defined status of the attempted payment." + "doc": "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." }, - "paymentType": { - "name": "paymentType", - "type": "string", + "oneTimeFee": { + "name": "oneTimeFee", + "type": "decimal", "form": "local", - "doc": "PayPal defined code used to identify the type of payment. Provided in a PayPal response." + "doc": "The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). " }, - "pendingReason": { - "name": "pendingReason", - "type": "string", + "oneTimeFeeTaxRate": { + "name": "oneTimeFeeTaxRate", + "type": "decimal", "form": "local", - "doc": "Reason provided by PayPal for a payment given a pending status." + "doc": "The rate at which one time fees are taxed if you are a taxable customer." }, - "serializedReply": { - "name": "serializedReply", - "type": "string", + "orderItemId": { + "name": "orderItemId", + "type": "int", "form": "local", - "doc": "A serialized, delimited string of the reply received from PayPal." + "doc": "the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created." }, - "serializedRequest": { - "name": "serializedRequest", - "type": "string", + "packageId": { + "name": "packageId", + "type": "int", "form": "local", - "doc": "A serialized, delimited string of the request submitted to PayPal." + "doc": "This is the package id for this billing item." }, - "settleAmount": { - "name": "settleAmount", + "parentId": { + "name": "parentId", + "type": "int", + "form": "local", + "doc": "The unique identifier of the parent of this billing item." + }, + "recurringFee": { + "name": "recurringFee", "type": "decimal", "form": "local", - "doc": "PayPal defined fee." + "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " }, - "taxAmount": { - "name": "taxAmount", + "recurringFeeTaxRate": { + "name": "recurringFeeTaxRate", "type": "decimal", "form": "local", - "doc": "Tax applied by PayPal to the payment amount." + "doc": "The rate at which recurring fees are taxed if you are a taxable customer." }, - "token": { - "name": "token", - "type": "string", + "recurringMonths": { + "name": "recurringMonths", + "type": "int", "form": "local", - "doc": "Value issued by PayPal for referencing the attempted transaction." + "doc": "The number of months in which the recurring fees will be incurred." }, - "transactionId": { - "name": "transactionId", - "type": "string", + "serviceProviderId": { + "name": "serviceProviderId", + "type": "int", "form": "local", - "doc": "Unique transaction ID provided in a PayPal response." + "doc": "This is the service provider for this billing item. " }, - "transactionType": { - "name": "transactionType", - "type": "string", + "setupFee": { + "name": "setupFee", + "type": "decimal", "form": "local", - "doc": "PayPal defined code used to identify the type of transaction. Provided in a PayPal response." - } - }, - "methods": {} - }, - "SoftLayer_Billing_Payment_Processor": { - "name": "SoftLayer_Billing_Payment_Processor", - "base": "SoftLayer_Entity", - "noservice": true, - "properties": { - "brandAssignments": { - "name": "brandAssignments", - "type": "SoftLayer_Brand_Payment_Processor", - "form": "relational", - "typeArray": true + "doc": "The setup fee, if any. This is a one time charge." }, - "ownerAccount": { - "name": "ownerAccount", - "type": "SoftLayer_Account", - "form": "relational" + "setupFeeTaxRate": { + "name": "setupFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which setup fees are taxed if you are a taxable customer." }, - "paymentMethods": { - "name": "paymentMethods", - "type": "SoftLayer_Billing_Payment_Processor_Method", - "form": "relational", - "typeArray": true + "activeAssociatedChildrenCount": { + "name": "activeAssociatedChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "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": { - "name": "type", - "type": "SoftLayer_Billing_Payment_Processor_Type", - "form": "relational" + "activeAssociatedGuestDiskBillingItemCount": { + "name": "activeAssociatedGuestDiskBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "description": { - "name": "description", - "type": "string", - "form": "local" + "activeBundledItemCount": { + "name": "activeBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active bundled billing items." }, - "name": { - "name": "name", - "type": "string", - "form": "local" + "activeChildrenCount": { + "name": "activeChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." }, - "brandAssignmentCount": { - "name": "brandAssignmentCount", + "activeSparePoolAssociatedGuestDiskBillingItemCount": { + "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", "type": "unsignedLong", "form": "count", "doc": "A count of " }, - "paymentMethodCount": { - "name": "paymentMethodCount", + "activeSparePoolBundledItemCount": { + "name": "activeSparePoolBundledItemCount", "type": "unsignedLong", "form": "count", - "doc": "A count of " - } - }, - "methods": {} - }, - "SoftLayer_Billing_Payment_Processor_Method": { - "name": "SoftLayer_Billing_Payment_Processor_Method", - "base": "SoftLayer_Entity", - "noservice": true, - "properties": { - "paymentProcessor": { - "name": "paymentProcessor", - "type": "SoftLayer_Billing_Payment_Processor", - "form": "relational" + "doc": "A count of a Billing Item's spare pool bundled billing items." }, - "paymentType": { - "name": "paymentType", - "type": "SoftLayer_Billing_Payment_Type", - "form": "relational" + "associatedBillingItemHistoryCount": { + "name": "associatedBillingItemHistoryCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a history of billing items which a billing item has been associated with." }, - "methodKey": { - "name": "methodKey", - "type": "string", - "form": "local" + "associatedChildrenCount": { + "name": "associatedChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "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." }, - "multipleCurrencyFlag": { - "name": "multipleCurrencyFlag", - "type": "boolean", - "form": "local" - } - }, - "methods": {} - }, - "SoftLayer_Billing_Payment_Processor_Type": { - "name": "SoftLayer_Billing_Payment_Processor_Type", - "base": "SoftLayer_Entity", - "noservice": true, - "properties": { - "paymentProcessors": { - "name": "paymentProcessors", - "type": "SoftLayer_Billing_Payment_Processor", - "form": "relational", - "typeArray": true + "associatedParentCount": { + "name": "associatedParentCount", + "type": "unsignedLong", + "form": "count", + "doc": "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." }, - "description": { - "name": "description", - "type": "string", - "form": "local" + "availableMatchingVlanCount": { + "name": "availableMatchingVlanCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "keyName": { - "name": "keyName", - "type": "string", - "form": "local" + "billableChildrenCount": { + "name": "billableChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "name": { - "name": "name", - "type": "string", - "form": "local" + "bundledItemCount": { + "name": "bundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's bundled billing items." }, - "paymentProcessorCount": { - "name": "paymentProcessorCount", + "canceledChildrenCount": { + "name": "canceledChildrenCount", "type": "unsignedLong", "form": "count", - "doc": "A count of " - } - }, - "methods": {} - }, - "SoftLayer_Billing_Payment_Transaction": { - "name": "SoftLayer_Billing_Payment_Transaction", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "Implementation for payment transactions. ", - "methods": {}, - "properties": {} - }, - "SoftLayer_Billing_Payment_Type": { - "name": "SoftLayer_Billing_Payment_Type", - "base": "SoftLayer_Entity", - "noservice": true, - "properties": { - "description": { - "name": "description", - "type": "string", - "form": "local" + "doc": "A count of a Billing Item's active child billing items." }, - "keyName": { - "name": "keyName", - "type": "string", - "form": "local" + "cancellationRequestCount": { + "name": "cancellationRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of this will return any cancellation requests that are associated with this billing item." }, - "name": { - "name": "name", - "type": "string", - "form": "local" + "childrenCount": { + "name": "childrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing items'" + }, + "childrenWithActiveAgreementCount": { + "name": "childrenWithActiveAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." + }, + "downgradeItemCount": { + "name": "downgradeItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of for product items which have a downgrade path defined, this will return those product items." + }, + "filteredNextInvoiceChildrenCount": { + "name": "filteredNextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + }, + "invoiceItemCount": { + "name": "invoiceItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all invoice items associated with the billing item" + }, + "nextInvoiceChildrenCount": { + "name": "nextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing items and associated items'" + }, + "nonZeroNextInvoiceChildrenCount": { + "name": "nonZeroNextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." + }, + "upgradeItemCount": { + "name": "upgradeItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "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." } }, - "methods": {} - }, - "SoftLayer_Brand": { - "name": "SoftLayer_Brand", - "base": "SoftLayer_Entity", - "serviceDoc": "Every IBM Cloud Infrastructure customer account is associated to a brand. \n\nIBM Cloud Infrastructure customers are unable to change their brand information in the portal or the API. ", "methods": { - "createCustomerAccount": { - "name": "createCustomerAccount", - "type": "SoftLayer_Account", - "doc": "Create a new customer account record. By default, the newly created account will be associated to a platform (PaaS) account. To skip the automatic creation and linking to a new platform account, set the bluemixLinkedFlag to false on the account template. ", - "docOverview": "Create a new customer account record.", - "static": true, - "maskable": true, + "cancelItem": { + "name": "cancelItem", + "type": "boolean", + "doc": "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. \n\nThe reason parameter could be from the list below: \n* \"No longer needed\"\n* \"Business closing down\"\n* \"Server / Upgrade Costs\"\n* \"Migrating to larger server\"\n* \"Migrating to smaller server\"\n* \"Migrating to a different SoftLayer datacenter\"\n* \"Network performance / latency\"\n* \"Support response / timing\"\n* \"Sales process / upgrades\"\n* \"Moving to competitor\"", + "docOverview": "Cancel a service or resource.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." + } + ], "parameters": [ { - "name": "account", - "type": "SoftLayer_Account", - "doc": "The template of the account object to be created." + "name": "cancelImmediately", + "type": "boolean", + "doc": "This will trigger an immediate cancellation with a reclaim of the resource", + "defaultValue": false }, { - "name": "bypassDuplicateAccountCheck", + "name": "cancelAssociatedBillingItems", "type": "boolean", - "doc": "Bypass validation for duplicate account(s).", + "doc": "This only applies to servers and virtual servers and will", "defaultValue": false - } - ] - }, - "createObject": { - "name": "createObject", - "type": "SoftLayer_Brand", - "doc": "\ncreateObject() allows the creation of a new brand. This will also create an `account` \nto serve as the owner of the brand. \n\n\nIn order to create a brand, a template object must be sent in with several required values. \n\n\n### Input [SoftLayer_Brand](/reference/datatypes/SoftLayer_Brand)\n\n\n\n- `name` \n + Name of brand \n + Required \n + Type: string \n- `keyName` \n + Reference key name \n + Required \n + Type: string \n- `longName` \n + More descriptive name of brand \n + Required \n + Type: string \n- `account.firstName` \n + First Name of account contact \n + Required \n + Type: string \n- `account.lastName` \n + Last Name of account contact \n + Required \n + Type: string \n- `account.address1` \n + Street Address of company \n + Required \n + Type: string \n- `account.address2` \n + Street Address of company \n + Optional \n + Type: string \n- `account.city` \n + City of company \n + Required \n + Type: string \n- `account.state` \n + State of company (if applicable) \n + Conditionally Required \n + Type: string \n- `account.postalCode` \n + Postal Code of company \n + Required \n + Type: string \n- `account.country` \n + Country of company \n + Required \n + Type: string \n- `account.officePhone` \n + Office Phone number of Company \n + Required \n + Type: string \n- `account.alternatePhone` \n + Alternate Phone number of Company \n + Optional \n + Type: string \n- `account.companyName` \n + Name of company \n + Required \n + Type: string \n- `account.email` \n + Email address of account contact \n + Required \n + Type: string \n\n\nREST Example: \n``` \ncurl -X POST -d '{ \n \"parameters\":[{ \n \"name\": \"Brand Corp\", \n \"keyName\": \"BRAND_CORP\", \n \"longName\": \"Brand Corporation\", \n \"account\": { \n \"firstName\": \"Gloria\", \n \"lastName\": \"Brand\", \n \"address1\": \"123 Drive\", \n \"city\": \"Boston\", \n \"state\": \"MA\", \n \"postalCode\": \"02107\", \n \"country\": \"US\", \n \"companyName\": \"Brand Corp\", \n \"officePhone\": \"857-111-1111\", \n \"email\": \"noreply@example.com\" \n } \n }] \n}' https://api.softlayer.com/rest/v3.1/SoftLayer_Brand/createObject.json \n``` ", - "docOverview": "Create a new brand.", - "static": true, - "maskable": true, - "parameters": [ - { - "name": "templateObject", - "type": "SoftLayer_Brand", - "doc": "The SoftLayer_Brand object that you wish to create." - } - ] - }, - "disableAccount": { - "name": "disableAccount", - "type": "void", - "doc": "Disable an account associated with this Brand. Anything that would disqualify the account from being disabled will cause an exception to be raised. ", - "parameters": [ + }, { - "name": "accountId", - "type": "int" - } - ] - }, - "getAllTicketSubjects": { - "name": "getAllTicketSubjects", - "type": "SoftLayer_Ticket_Subject", - "typeArray": true, - "doc": "(DEPRECATED) Use [SoftLayer_Ticket_Subject::getAllObjects](/reference/datatypes/$1/#$2) method. ", - "maskable": true, - "deprecated": true, - "parameters": [ + "name": "reason", + "type": "string", + "doc": "The cancellation reason. See the documentation overview to see some possible values.", + "defaultValue": null + }, { - "name": "account", - "type": "SoftLayer_Account", - "doc": "Deprecated. Account is no longer required", + "name": "customerNote", + "type": "string", + "doc": "Tracks any additional information that the customer wanted to provide.", "defaultValue": null } ] }, - "getBillingItemSnapshotsForSingleOwnedAccount": { - "name": "getBillingItemSnapshotsForSingleOwnedAccount", - "type": "SoftLayer_Billing_Item_Chronicle", - "typeArray": true, - "doc": "This service returns the snapshots of billing items recorded periodically given an account ID. The provided account ID must be owned by the brand that calls this service. In this context, it can be interpreted that the billing items snapshots belong to both the account and that accounts brand. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. \n\nThe downside is, they are not real time, and do not share relational parity with the original billing item. ", - "docOverview": "Returns billing item snapshots on accounts owned by specific brands.", - "limitable": true, - "filterable": true, - "maskable": true, - "parameters": [ + "cancelService": { + "name": "cancelService", + "type": "boolean", + "doc": "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. ", + "docOverview": "Cancel a service or resource immediately. This does not include bare metal servers. ", + "docErrorHandling": [ { - "name": "accountId", - "type": "int", - "doc": "The IBM Cloud infrastructure account ID the billing items belong to." + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." } ] }, - "getBillingItemSnapshotsWithExternalAccountId": { - "name": "getBillingItemSnapshotsWithExternalAccountId", - "type": "SoftLayer_Billing_Item_Chronicle", - "typeArray": true, - "doc": "This service returns the snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. \n\nThe downside is, they are not real time, and do not share relational parity with the original billing item. ", - "docOverview": "Returns billing item snapshots on accounts owned by specific brands.", - "limitable": true, - "filterable": true, - "maskable": true, - "parameters": [ + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", + "type": "boolean", + "doc": "Cancel the resource or service for a billing Item ", + "docOverview": "Cancel a service or resource on the next bill date", + "docErrorHandling": [ { - "name": "externalAccountId", - "type": "string", - "doc": "The IBM Cloud account ID the billing items belong to." + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This type of service cannot be cancelled through the API. Please submit a cancellation ticket\" If a billing items service type cannot be cancelled through the API." } ] }, - "getContactInformation": { - "name": "getContactInformation", - "type": "SoftLayer_Brand_Contact", - "typeArray": true, - "doc": "Retrieve the contact information for the brand such as the corporate or support contact. This will include the contact name, telephone number, fax number, email address, and mailing address of the contact. ", - "docOverview": "Retrieve the contact information for the customer account brand.", - "maskable": true - }, - "getMerchantName": { - "name": "getMerchantName", - "type": "string", - "doc": "Get the payment processor merchant name." - }, "getObject": { "name": "getObject", - "type": "SoftLayer_Brand", - "docOverview": "Retrieve a SoftLayer_Brand record.", + "type": "SoftLayer_Billing_Item", + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Item record.", "filterable": true, "maskable": true }, - "getToken": { - "name": "getToken", - "type": "string", - "doc": "(DEPRECATED) Use [SoftLayer_User_Customer::getImpersonationToken](/reference/datatypes/$1/#$2) method. ", - "deprecated": true, + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "doc": "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. \n\nIn 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. ", + "docOverview": "Returns billing item in a given category code. Use this method to retrieve service billing items that you wish to cancel.", + "static": true, + "maskable": true, "parameters": [ { - "name": "userId", - "type": "int" + "name": "categoryCode", + "type": "string", + "doc": "The category code of billing items you wish to retrieve." + }, + { + "name": "includeZeroRecurringFee", + "type": "boolean", + "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "defaultValue": false } ] }, - "isIbmSlicBrand": { - "name": "isIbmSlicBrand", - "type": "boolean", - "doc": "Check if the brand is IBM SLIC top level brand or sub brand. ", - "docOverview": "Check if the brand is IBM SLIC top level brand or sub brand." - }, - "isPlatformServicesBrand": { - "name": "isPlatformServicesBrand", + "removeAssociationId": { + "name": "removeAssociationId", "type": "boolean", - "doc": "Check if the alternate billing system of brand is Bluemix. ", - "docOverview": "Check if the alternate billing system of brand is Bluemix." - }, - "migrateExternalAccount": { - "name": "migrateExternalAccount", - "type": "SoftLayer_Account_Brand_Migration_Request", - "doc": "Will attempt to migrate an external account to the brand in context. ", - "docOverview": "Migrates an account from an external brand to this brand.", - "maskable": true, - "parameters": [ + "doc": "Remove the association from a billing item. ", + "docOverview": "Remove an association from an orphan billing item.", + "docErrorHandling": [ { - "name": "accountId", - "type": "int" + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." } - ] - }, - "reactivateAccount": { - "name": "reactivateAccount", - "type": "void", - "doc": "Reactivate an account associated with this Brand. Anything that would disqualify the account from being reactivated will cause an exception to be raised. ", - "parameters": [ + ], + "docAssociatedMethods": [ { - "name": "accountId", - "type": "int" + "service": "SoftLayer_Billing_Item", + "method": "setAssociationId" } ] }, - "refreshBillingItemSnapshot": { - "name": "refreshBillingItemSnapshot", + "setAssociationId": { + "name": "setAssociationId", "type": "boolean", - "doc": "When this service is called given an IBM Cloud infrastructure account ID owned by the calling brand, the process is started to refresh the billing item snapshots belonging to that account. This refresh is async and can take an undetermined amount of time. Even if this endpoint returns an OK, it doesn't guarantee that refresh did not fail or encounter issues. \n\n", - "docOverview": "Begins the process for refreshing the billing item snapshots", - "parameters": [ + "doc": "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. ", + "docOverview": "Set the associated billing item for an orphan billing item.", + "docErrorHandling": [ { - "name": "accountId", - "type": "int" + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"This billing item is not an orphan billing item.\" if the current billing item has a parent item or already has an association defined." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"There was a problem fetching data for the associated billing Item ([associatedId])\" if the SoftLayer API is unable to locate the billing item you wish to associate." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may only associate orphan billing items to server billing items. You chose a [categoryCode] billing item.\" if the billing item you're attempting to associate is not a server billing item." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"You may not associate to this billing item ($associatedId) as it is scheduled for cancellation.\" if the associated billing item has a cancellationDate set." } - ] - }, - "verifyCanDisableAccount": { - "name": "verifyCanDisableAccount", - "type": "void", - "doc": "Verify that an account may be disabled by a Brand Agent. Anything that would disqualify the account from being disabled will cause an exception to be raised. ", + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Item", + "method": "removeAssociationId" + } + ], "parameters": [ { - "name": "accountId", - "type": "int" + "name": "associatedId", + "type": "int", + "doc": "the billing item to associate to this item" } ] }, - "verifyCanReactivateAccount": { - "name": "verifyCanReactivateAccount", - "type": "void", - "doc": "Verify that an account may be reactivated by a Brand Agent. Anything that would disqualify the account from being reactivated will cause an exception to be raised. ", - "parameters": [ + "voidCancelService": { + "name": "voidCancelService", + "type": "boolean", + "doc": "Void a previously made cancellation for a service ", + "docOverview": "Void a service cancellation that was previously made.", + "docErrorHandling": [ { - "name": "accountId", - "type": "int" + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation for this service through the API.\" If a billing items service type cannot have a cancellation voided through the API." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. This billing item is not set to cancel.\" If a service is not cancelled." + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] }, "getAccount": { - "doc": "", + "doc": "The account that a billing item belongs to.", "docOverview": "", "name": "getAccount", "type": "SoftLayer_Account", @@ -62252,11 +72801,33 @@ "filterable": true, "deprecated": false }, - "getAllOwnedAccounts": { - "doc": "All accounts owned by the brand.", + "getActiveAgreement": { + "doc": "", "docOverview": "", - "name": "getAllOwnedAccounts", - "type": "SoftLayer_Account", + "name": "getActiveAgreement", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAgreementFlag": { + "doc": "A flag indicating that the billing item is under an active agreement.", + "docOverview": "", + "name": "getActiveAgreementFlag", + "type": "SoftLayer_Account_Agreement", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getActiveAssociatedChildren": { + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item.", + "docOverview": "", + "name": "getActiveAssociatedChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -62264,22 +72835,23 @@ "deprecated": false, "limitable": true }, - "getAllowAccountCreationFlag": { - "doc": "This flag indicates if creation of accounts is allowed.", + "getActiveAssociatedGuestDiskBillingItems": { + "doc": "", "docOverview": "", - "name": "getAllowAccountCreationFlag", - "type": "boolean", - "typeArray": null, + "name": "getActiveAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "typeArray": true, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": false, + "limitable": true }, - "getBillingItemSnapshots": { - "doc": "Returns snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. The downside is, they are not real time, and do not share relational parity with the original billing item.", + "getActiveBundledItems": { + "doc": "A Billing Item's active bundled billing items.", "docOverview": "", - "name": "getBillingItemSnapshots", - "type": "SoftLayer_Billing_Item_Chronicle", + "name": "getActiveBundledItems", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -62287,44 +72859,45 @@ "deprecated": false, "limitable": true }, - "getBusinessPartner": { - "doc": "Business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level.", + "getActiveCancellationItem": { + "doc": "A service cancellation request item that corresponds to the billing item.", "docOverview": "", - "name": "getBusinessPartner", - "type": "SoftLayer_Brand_Business_Partner", + "name": "getActiveCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getBusinessPartnerFlag": { - "doc": "Flag indicating if the brand is a business partner.", + "getActiveChildren": { + "doc": "A Billing Item's active child billing items.", "docOverview": "", - "name": "getBusinessPartnerFlag", - "type": "boolean", - "typeArray": null, + "name": "getActiveChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": false, + "limitable": true }, - "getCatalog": { - "doc": "The Product Catalog for the Brand", + "getActiveFlag": { + "doc": "", "docOverview": "", - "name": "getCatalog", - "type": "SoftLayer_Product_Catalog", + "name": "getActiveFlag", + "type": "boolean", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getContacts": { - "doc": "The contacts for the brand.", + "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "doc": "", "docOverview": "", - "name": "getContacts", - "type": "SoftLayer_Brand_Contact", + "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -62332,11 +72905,11 @@ "deprecated": false, "limitable": true }, - "getCustomerCountryLocationRestrictions": { - "doc": "This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain.", + "getActiveSparePoolBundledItems": { + "doc": "A Billing Item's spare pool bundled billing items.", "docOverview": "", - "name": "getCustomerCountryLocationRestrictions", - "type": "SoftLayer_Brand_Restriction_Location_CustomerCountry", + "name": "getActiveSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -62344,44 +72917,46 @@ "deprecated": false, "limitable": true }, - "getDistributor": { - "doc": "", + "getAssociatedBillingItem": { + "doc": "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.", "docOverview": "", - "name": "getDistributor", - "type": "SoftLayer_Brand", + "name": "getAssociatedBillingItem", + "type": "SoftLayer_Billing_Item", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getDistributorChildFlag": { - "doc": "", + "getAssociatedBillingItemHistory": { + "doc": "A history of billing items which a billing item has been associated with.", "docOverview": "", - "name": "getDistributorChildFlag", - "type": "boolean", - "typeArray": null, + "name": "getAssociatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "typeArray": true, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": false, + "limitable": true }, - "getDistributorFlag": { - "doc": "", + "getAssociatedChildren": { + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item.", "docOverview": "", - "name": "getDistributorFlag", - "type": "string", - "typeArray": null, + "name": "getAssociatedChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": false, + "limitable": true }, - "getHardware": { - "doc": "An account's associated hardware objects.", + "getAssociatedParent": { + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.", "docOverview": "", - "name": "getHardware", - "type": "SoftLayer_Hardware", + "name": "getAssociatedParent", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -62389,33 +72964,34 @@ "deprecated": false, "limitable": true }, - "getHasAgentAdvancedSupportFlag": { + "getAvailableMatchingVlans": { "doc": "", "docOverview": "", - "name": "getHasAgentAdvancedSupportFlag", - "type": "boolean", - "typeArray": null, + "name": "getAvailableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "typeArray": true, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": false, + "limitable": true }, - "getHasAgentSupportFlag": { - "doc": "", + "getBandwidthAllocation": { + "doc": "The bandwidth allocation for a billing item.", "docOverview": "", - "name": "getHasAgentSupportFlag", - "type": "boolean", + "name": "getBandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getOpenTickets": { - "doc": "", + "getBillableChildren": { + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.", "docOverview": "", - "name": "getOpenTickets", - "type": "SoftLayer_Ticket", + "name": "getBillableChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -62423,11 +72999,11 @@ "deprecated": false, "limitable": true }, - "getOwnedAccounts": { - "doc": "Active accounts owned by the brand.", + "getBundledItems": { + "doc": "A Billing Item's bundled billing items.", "docOverview": "", - "name": "getOwnedAccounts", - "type": "SoftLayer_Account", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -62435,22 +73011,34 @@ "deprecated": false, "limitable": true }, - "getSecurityLevel": { - "doc": "", + "getCanceledChildren": { + "doc": "A Billing Item's active child billing items.", "docOverview": "", - "name": "getSecurityLevel", - "type": "SoftLayer_Security_Level", + "name": "getCanceledChildren", + "type": "SoftLayer_Billing_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCancellationReason": { + "doc": "The billing item's cancellation reason.", + "docOverview": "", + "name": "getCancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getTicketGroups": { - "doc": "", + "getCancellationRequests": { + "doc": "This will return any cancellation requests that are associated with this billing item.", "docOverview": "", - "name": "getTicketGroups", - "type": "SoftLayer_Ticket_Group", + "name": "getCancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", "typeArray": true, "ormMethod": true, "maskable": true, @@ -62458,11 +73046,22 @@ "deprecated": false, "limitable": true }, - "getTickets": { - "doc": "", + "getCategory": { + "doc": "The item category to which the billing item's item belongs. ", "docOverview": "", - "name": "getTickets", - "type": "SoftLayer_Ticket", + "name": "getCategory", + "type": "SoftLayer_Product_Item_Category", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChildren": { + "doc": "A Billing Item's child billing items'", + "docOverview": "", + "name": "getChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -62470,11 +73069,11 @@ "deprecated": false, "limitable": true }, - "getUsers": { - "doc": "", + "getChildrenWithActiveAgreement": { + "doc": "A Billing Item's active child billing items.", "docOverview": "", - "name": "getUsers", - "type": "SoftLayer_User_Customer", + "name": "getChildrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -62482,1549 +73081,1159 @@ "deprecated": false, "limitable": true }, - "getVirtualGuests": { - "doc": "An account's associated virtual guest objects.", + "getDowngradeItems": { + "doc": "For product items which have a downgrade path defined, this will return those product items.", "docOverview": "", - "name": "getVirtualGuests", - "type": "SoftLayer_Virtual_Guest", + "name": "getDowngradeItems", + "type": "SoftLayer_Product_Item", "typeArray": true, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false, "limitable": true - } - }, - "typeDoc": "The SoftLayer_Brand data type contains brand information relating to the single SoftLayer customer account. \n\nIBM Cloud Infrastructure customers are unable to change their brand information in the portal or the API. ", - "properties": { - "account": { - "name": "account", - "type": "SoftLayer_Account", - "form": "relational" }, - "allOwnedAccounts": { - "name": "allOwnedAccounts", - "type": "SoftLayer_Account", - "form": "relational", + "getFilteredNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getFilteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, - "doc": "All accounts owned by the brand." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "allowAccountCreationFlag": { - "name": "allowAccountCreationFlag", + "getHourlyFlag": { + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "docOverview": "", + "name": "getHourlyFlag", "type": "boolean", - "form": "relational", - "doc": "This flag indicates if creation of accounts is allowed." + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "billingItemSnapshots": { - "name": "billingItemSnapshots", - "type": "SoftLayer_Billing_Item_Chronicle", - "form": "relational", - "typeArray": true, - "doc": "Returns snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. The downside is, they are not real time, and do not share relational parity with the original billing item." + "getInvoiceItem": { + "doc": "Invoice items associated with this billing item", + "docOverview": "", + "name": "getInvoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "businessPartner": { - "name": "businessPartner", - "type": "SoftLayer_Brand_Business_Partner", - "form": "relational", - "doc": "Business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level." + "getInvoiceItems": { + "doc": "All invoice items associated with the billing item", + "docOverview": "", + "name": "getInvoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "businessPartnerFlag": { - "name": "businessPartnerFlag", - "type": "boolean", - "form": "relational", - "doc": "Flag indicating if the brand is a business partner." + "getItem": { + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "docOverview": "", + "name": "getItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "catalog": { - "name": "catalog", - "type": "SoftLayer_Product_Catalog", - "form": "relational", - "doc": "The Product Catalog for the Brand" + "getLocation": { + "doc": "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.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "contacts": { - "name": "contacts", - "type": "SoftLayer_Brand_Contact", - "form": "relational", + "getNextInvoiceChildren": { + "doc": "A Billing Item's child billing items and associated items'", + "docOverview": "", + "name": "getNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, - "doc": "The contacts for the brand." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "customerCountryLocationRestrictions": { - "name": "customerCountryLocationRestrictions", - "type": "SoftLayer_Brand_Restriction_Location_CustomerCountry", - "form": "relational", - "typeArray": true, - "doc": "This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain." + "getNextInvoiceTotalOneTimeAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "distributor": { - "name": "distributor", - "type": "SoftLayer_Brand", - "form": "relational" + "getNextInvoiceTotalOneTimeTaxAmount": { + "doc": "A Billing Item's total, including any child billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalOneTimeTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "distributorChildFlag": { - "name": "distributorChildFlag", - "type": "boolean", - "form": "relational" + "getNextInvoiceTotalRecurringAmount": { + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "distributorFlag": { - "name": "distributorFlag", - "type": "string", - "form": "relational" + "getNextInvoiceTotalRecurringTaxAmount": { + "doc": "This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.", + "docOverview": "", + "name": "getNextInvoiceTotalRecurringTaxAmount", + "type": "float", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "hardware": { - "name": "hardware", - "type": "SoftLayer_Hardware", - "form": "relational", + "getNonZeroNextInvoiceChildren": { + "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", + "docOverview": "", + "name": "getNonZeroNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", "typeArray": true, - "doc": "An account's associated hardware objects." + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true }, - "hasAgentAdvancedSupportFlag": { - "name": "hasAgentAdvancedSupportFlag", - "type": "boolean", - "form": "relational" + "getOrderItem": { + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created.", + "docOverview": "", + "name": "getOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "hasAgentSupportFlag": { - "name": "hasAgentSupportFlag", + "getOriginalLocation": { + "doc": "The original physical location for this billing item--may differ from current.", + "docOverview": "", + "name": "getOriginalLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPackage": { + "doc": "The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.", + "docOverview": "", + "name": "getPackage", + "type": "SoftLayer_Product_Package", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParent": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParent", + "type": "SoftLayer_Billing_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getParentVirtualGuestBillingItem": { + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", + "docOverview": "", + "name": "getParentVirtualGuestBillingItem", + "type": "SoftLayer_Billing_Item_Virtual_Guest", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getPendingCancellationFlag": { + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", + "docOverview": "", + "name": "getPendingCancellationFlag", "type": "boolean", - "form": "relational" + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "openTickets": { - "name": "openTickets", - "type": "SoftLayer_Ticket", - "form": "relational", - "typeArray": true + "getPendingOrderItem": { + "doc": "The new order item that will replace this billing item.", + "docOverview": "", + "name": "getPendingOrderItem", + "type": "SoftLayer_Billing_Order_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false }, - "ownedAccounts": { - "name": "ownedAccounts", - "type": "SoftLayer_Account", + "getProvisionTransaction": { + "doc": "Provisioning transaction for this billing item", + "docOverview": "", + "name": "getProvisionTransaction", + "type": "SoftLayer_Provisioning_Version1_Transaction", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSoftwareDescription": { + "doc": "A friendly description of software component", + "docOverview": "", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItem": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItem", + "type": "SoftLayer_Product_Item", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getUpgradeItems": { + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.", + "docOverview": "", + "name": "getUpgradeItems", + "type": "SoftLayer_Product_Item", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + } + }, + "SoftLayer_Billing_Item_Virtual_Dedicated_Rack": { + "name": "SoftLayer_Billing_Item_Virtual_Dedicated_Rack", + "base": "SoftLayer_Billing_Item", + "noservice": true, + "typeDoc": "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. ", + "properties": { + "billingCycleBandwidthUsage": { + "name": "billingCycleBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", "form": "relational", "typeArray": true, - "doc": "Active accounts owned by the brand." + "doc": "The raw bandwidth usage data for the current billing cycle. One object is returned for each network a virtual rack is attached to." }, - "securityLevel": { - "name": "securityLevel", - "type": "SoftLayer_Security_Level", - "form": "relational" + "billingCyclePrivateBandwidthUsage": { + "name": "billingCyclePrivateBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw private bandwidth usage data for the current billing cycle." }, - "ticketGroups": { - "name": "ticketGroups", - "type": "SoftLayer_Ticket_Group", + "billingCyclePrivateUsageIn": { + "name": "billingCyclePrivateUsageIn", + "type": "decimal", "form": "relational", - "typeArray": true + "doc": "The total private network inbound bandwidth for this virtual rack for the current billing cycle." }, - "tickets": { - "name": "tickets", - "type": "SoftLayer_Ticket", + "billingCyclePrivateUsageOut": { + "name": "billingCyclePrivateUsageOut", + "type": "decimal", "form": "relational", - "typeArray": true + "doc": "The total private network outbound bandwidth for this virtual rack for the current billing cycle." }, - "users": { - "name": "users", - "type": "SoftLayer_User_Customer", + "billingCyclePrivateUsageTotal": { + "name": "billingCyclePrivateUsageTotal", + "type": "unsignedInt", "form": "relational", - "typeArray": true + "doc": "The total private network bandwidth for this virtual rack for the current billing cycle." }, - "virtualGuests": { - "name": "virtualGuests", - "type": "SoftLayer_Virtual_Guest", + "billingCyclePublicBandwidthUsage": { + "name": "billingCyclePublicBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", "form": "relational", "typeArray": true, - "doc": "An account's associated virtual guest objects." - }, - "catalogId": { - "name": "catalogId", - "type": "int", - "form": "local", - "doc": "ID of the Catalog used by this Brand" + "doc": "The raw public bandwidth usage data for the current billing cycle." }, - "id": { - "name": "id", - "type": "int", - "form": "local" + "billingCyclePublicUsageIn": { + "name": "billingCyclePublicUsageIn", + "type": "decimal", + "form": "relational", + "doc": "The total public inbound bandwidth for this virtual rack for the current billing cycle." }, - "keyName": { - "name": "keyName", - "type": "string", - "form": "local", - "doc": "The brand key name." + "billingCyclePublicUsageOut": { + "name": "billingCyclePublicUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total public outbound bandwidth for this virtual rack for the current billing cycle." }, - "longName": { - "name": "longName", - "type": "string", - "form": "local", - "doc": "The brand long name." + "billingCyclePublicUsageTotal": { + "name": "billingCyclePublicUsageTotal", + "type": "unsignedInt", + "form": "relational", + "doc": "The total public bandwidth for this virtual rack for the current billing cycle." }, - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "The brand name." + "resource": { + "name": "resource", + "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", + "form": "relational", + "doc": "The virtual rack that a virtual rack billing item is associated with." }, - "allOwnedAccountCount": { - "name": "allOwnedAccountCount", + "billingCycleBandwidthUsageCount": { + "name": "billingCycleBandwidthUsageCount", "type": "unsignedLong", "form": "count", - "doc": "A count of all accounts owned by the brand." + "doc": "A count of the raw bandwidth usage data for the current billing cycle. One object is returned for each network a virtual rack is attached to." }, - "billingItemSnapshotCount": { - "name": "billingItemSnapshotCount", + "billingCyclePrivateBandwidthUsageCount": { + "name": "billingCyclePrivateBandwidthUsageCount", "type": "unsignedLong", "form": "count", - "doc": "A count of returns snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. The downside is, they are not real time, and do not share relational parity with the original billing item." + "doc": "A count of the raw private bandwidth usage data for the current billing cycle." }, - "contactCount": { - "name": "contactCount", + "billingCyclePublicBandwidthUsageCount": { + "name": "billingCyclePublicBandwidthUsageCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the contacts for the brand." + "doc": "A count of the raw public bandwidth usage data for the current billing cycle." }, - "customerCountryLocationRestrictionCount": { - "name": "customerCountryLocationRestrictionCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of this references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain." - }, - "hardwareCount": { - "name": "hardwareCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of an account's associated hardware objects." - }, - "openTicketCount": { - "name": "openTicketCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "ownedAccountCount": { - "name": "ownedAccountCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of active accounts owned by the brand." - }, - "ticketCount": { - "name": "ticketCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "ticketGroupCount": { - "name": "ticketGroupCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " - }, - "userCount": { - "name": "userCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "virtualGuestCount": { - "name": "virtualGuestCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of an account's associated virtual guest objects." - } - } - }, - "SoftLayer_Brand_Attribute": { - "name": "SoftLayer_Brand_Attribute", - "base": "SoftLayer_Entity", - "noservice": true, - "properties": { - "brand": { - "name": "brand", - "type": "SoftLayer_Brand", + "activeAgreement": { + "name": "activeAgreement", + "type": "SoftLayer_Account_Agreement", "form": "relational" - } - }, - "methods": {} - }, - "SoftLayer_Brand_Business_Partner": { - "name": "SoftLayer_Brand_Business_Partner", - "base": "SoftLayer_Entity", - "methods": { - "getObject": { - "name": "getObject", - "type": "SoftLayer_Brand_Business_Partner", - "docOverview": "Retrieve a SoftLayer_Brand_Business_Partner record.", - "filterable": true, - "maskable": true - }, - "getBrand": { - "doc": "Brand associated with the business partner data", - "docOverview": "", - "name": "getBrand", - "type": "SoftLayer_Brand", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false - }, - "getChannel": { - "doc": "Channel indicator used to categorize business partner revenue.", - "docOverview": "", - "name": "getChannel", - "type": "SoftLayer_Business_Partner_Channel", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false }, - "getSegment": { - "doc": "Segment indicator used to categorize business partner revenue.", - "docOverview": "", - "name": "getSegment", - "type": "SoftLayer_Business_Partner_Segment", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false - } - }, - "typeDoc": "Contains business partner details associated with a brand. Country Enterprise Identifier (CEID), Channel ID, Segment ID and Reseller Level. ", - "properties": { - "brand": { - "name": "brand", - "type": "SoftLayer_Brand", + "activeAgreementFlag": { + "name": "activeAgreementFlag", + "type": "SoftLayer_Account_Agreement", "form": "relational", - "doc": "Brand associated with the business partner data" + "doc": "A flag indicating that the billing item is under an active agreement." }, - "channel": { - "name": "channel", - "type": "SoftLayer_Business_Partner_Channel", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", + "type": "SoftLayer_Billing_Item", "form": "relational", - "doc": "Channel indicator used to categorize business partner revenue." + "typeArray": true, + "doc": "A billing item's active associated child billing items. This includes \"floating\" items that are not necessarily child items of this billing item." }, - "segment": { - "name": "segment", - "type": "SoftLayer_Business_Partner_Segment", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", "form": "relational", - "doc": "Segment indicator used to categorize business partner revenue." + "typeArray": true }, - "channelId": { - "name": "channelId", - "type": "int", - "form": "local", - "doc": "Brand business partner channel identifier " + "activeBundledItems": { + "name": "activeBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active bundled billing items." }, - "countryEnterpriseCode": { - "name": "countryEnterpriseCode", - "type": "string", - "form": "local", - "doc": "Brand business partner country enterprise code " + "activeCancellationItem": { + "name": "activeCancellationItem", + "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "resellerLevel": { - "name": "resellerLevel", - "type": "int", - "form": "local", - "doc": "Reseller level of a brand business partner " + "activeChildren": { + "name": "activeChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." }, - "segmentId": { - "name": "segmentId", - "type": "int", - "form": "local", - "doc": "Brand business partner segment identifier " - } - } - }, - "SoftLayer_Brand_Contact": { - "name": "SoftLayer_Brand_Contact", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "SoftLayer_Brand_Contact contains the contact information for the brand such as Corporate or Support contact information ", - "properties": { - "brand": { - "name": "brand", - "type": "SoftLayer_Brand", + "activeFlag": { + "name": "activeFlag", + "type": "boolean", "form": "relational" }, - "brandContactType": { - "name": "brandContactType", - "type": "SoftLayer_Brand_Contact_Type", - "form": "relational" + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true }, - "address1": { - "name": "address1", - "type": "string", - "form": "local", - "doc": "The contact's address 1." + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's spare pool bundled billing items." }, - "address2": { - "name": "address2", - "type": "string", - "form": "local", - "doc": "The contact's address 2." + "associatedBillingItem": { + "name": "associatedBillingItem", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "doc": "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." }, - "alternatePhone": { - "name": "alternatePhone", - "type": "string", - "form": "local", - "doc": "The contact's alternate phone number." + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", + "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", + "typeArray": true, + "doc": "A history of billing items which a billing item has been associated with." }, - "brandContactTypeId": { - "name": "brandContactTypeId", - "type": "int", - "form": "local", - "doc": "The contact's type identifier." + "associatedChildren": { + "name": "associatedChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items. This includes \"floating\" items that are not necessarily child billing items of this billing item." }, - "city": { - "name": "city", - "type": "string", - "form": "local", - "doc": "The contact's city." + "associatedParent": { + "name": "associatedParent", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set." }, - "country": { - "name": "country", - "type": "string", - "form": "local", - "doc": "The contact's country." + "availableMatchingVlans": { + "name": "availableMatchingVlans", + "type": "SoftLayer_Network_Vlan", + "form": "relational", + "typeArray": true }, - "email": { - "name": "email", - "type": "string", - "form": "local", - "doc": "The contact's email address." + "bandwidthAllocation": { + "name": "bandwidthAllocation", + "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", + "form": "relational", + "doc": "The bandwidth allocation for a billing item." }, - "faxPhone": { - "name": "faxPhone", - "type": "string", - "form": "local", - "doc": "The contact's fax number." + "billableChildren": { + "name": "billableChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "firstName": { - "name": "firstName", - "type": "string", - "form": "local", - "doc": "The contact's first name." + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's bundled billing items." }, - "lastName": { - "name": "lastName", - "type": "string", - "form": "local", - "doc": "The contact's last name." + "canceledChildren": { + "name": "canceledChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." }, - "officePhone": { - "name": "officePhone", - "type": "string", - "form": "local", - "doc": "The contact's phone number." + "cancellationReason": { + "name": "cancellationReason", + "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "postalCode": { - "name": "postalCode", - "type": "string", - "form": "local", - "doc": "The contact's postal code." + "cancellationRequests": { + "name": "cancellationRequests", + "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", + "typeArray": true, + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "state": { - "name": "state", - "type": "string", - "form": "local", - "doc": "The contact's state." - } - }, - "methods": {} - }, - "SoftLayer_Brand_Contact_Type": { - "name": "SoftLayer_Brand_Contact_Type", - "base": "SoftLayer_Entity", - "noservice": true, - "typeDoc": "SoftLayer_Brand_Contact_Type contains the contact type information for the brand contacts such as Corporate or Support contact type ", - "properties": { - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "Contact type description." + "category": { + "name": "category", + "type": "SoftLayer_Product_Item_Category", + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "keyName": { - "name": "keyName", - "type": "string", - "form": "local", - "doc": "Contact type key name." + "children": { + "name": "children", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's child billing items'" }, - "name": { - "name": "name", - "type": "string", - "form": "local", - "doc": "Contact type name." - } - }, - "methods": {} - }, - "SoftLayer_Brand_Payment_Processor": { - "name": "SoftLayer_Brand_Payment_Processor", - "base": "SoftLayer_Entity", - "noservice": true, - "properties": { - "brand": { - "name": "brand", - "type": "SoftLayer_Brand", - "form": "relational" + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's active child billing items." }, - "paymentProcessor": { - "name": "paymentProcessor", - "type": "SoftLayer_Billing_Payment_Processor", - "form": "relational" - } - }, - "methods": {} - }, - "SoftLayer_Brand_Restriction_Location_CustomerCountry": { - "name": "SoftLayer_Brand_Restriction_Location_CustomerCountry", - "base": "SoftLayer_Entity", - "serviceDoc": "The [SoftLayer_Brand_Restriction_Location_CustomerCountry](/reference/datatypes/SoftLayer_Brand_Restriction_Location_CustomerCountry) service defines the relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on the SoftLayer US brand for customers that live in Great Britain. ", - "methods": { - "getAllObjects": { - "name": "getAllObjects", - "type": "SoftLayer_Brand_Restriction_Location_CustomerCountry", + "downgradeItems": { + "name": "downgradeItems", + "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "static": true, - "limitable": true, - "filterable": true, - "maskable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getObject": { - "name": "getObject", - "type": "SoftLayer_Brand_Restriction_Location_CustomerCountry", - "docOverview": "Retrieve a SoftLayer_Brand_Restriction_Location_CustomerCountry record.", - "filterable": true, - "maskable": true + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true, + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getBrand": { - "doc": "This references the brand that has a brand-location-country restriction setup.", - "docOverview": "", - "name": "getBrand", - "type": "SoftLayer_Brand", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "hourlyFlag": { + "name": "hourlyFlag", + "type": "boolean", + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getLocation": { - "doc": "This references the datacenter that has a brand-location-country restriction setup. For example, if a datacenter is listed with a restriction for Canada, a Canadian customer may not be eligible to order services at that location.", - "docOverview": "", - "name": "getLocation", - "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false - } - }, - "typeDoc": "The [SoftLayer_Brand_Restriction_Location_CustomerCountry](/reference/datatypes/SoftLayer_Brand_Restriction_Location_CustomerCountry) data type defines the relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on the SoftLayer US brand for customers that live in Great Britain. ", - "properties": { - "brand": { - "name": "brand", - "type": "SoftLayer_Brand", + "invoiceItem": { + "name": "invoiceItem", + "type": "SoftLayer_Billing_Invoice_Item", "form": "relational", - "doc": "This references the brand that has a brand-location-country restriction setup." + "doc": "Invoice items associated with this billing item" + }, + "invoiceItems": { + "name": "invoiceItems", + "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", + "typeArray": true, + "doc": "All invoice items associated with the billing item" + }, + "item": { + "name": "item", + "type": "SoftLayer_Product_Item", + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, "location": { "name": "location", "type": "SoftLayer_Location", "form": "relational", - "doc": "This references the datacenter that has a brand-location-country restriction setup. For example, if a datacenter is listed with a restriction for Canada, a Canadian customer may not be eligible to order services at that location." - }, - "brandId": { - "name": "brandId", - "type": "int", - "form": "local", - "doc": "The brand associated with customer's account." - }, - "customerCountryCode": { - "name": "customerCountryCode", - "type": "string", - "form": "local", - "doc": "country code associated with customer's account." - }, - "locationId": { - "name": "locationId", - "type": "int", - "form": "local", - "doc": "The id for datacenter location." - } - } - }, - "SoftLayer_Business_Partner_Channel": { - "name": "SoftLayer_Business_Partner_Channel", - "base": "SoftLayer_Entity", - "methods": { - "getObject": { - "name": "getObject", - "type": "SoftLayer_Business_Partner_Channel", - "docOverview": "Retrieve a SoftLayer_Business_Partner_Channel record.", - "filterable": true, - "maskable": true - } - }, - "typeDoc": "Contains business partner channel information ", - "properties": { - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "Business partner channel description " - }, - "keyName": { - "name": "keyName", - "type": "string", - "form": "local", - "doc": "Business partner channel name " - } - } - }, - "SoftLayer_Business_Partner_Segment": { - "name": "SoftLayer_Business_Partner_Segment", - "base": "SoftLayer_Entity", - "methods": { - "getObject": { - "name": "getObject", - "type": "SoftLayer_Business_Partner_Segment", - "docOverview": "Retrieve a SoftLayer_Business_Partner_Segment record.", - "filterable": true, - "maskable": true - } - }, - "typeDoc": "Contains business partner segment information ", - "properties": { - "description": { - "name": "description", - "type": "string", - "form": "local", - "doc": "Business partner segment description " - }, - "keyName": { - "name": "keyName", - "type": "string", - "form": "local", - "doc": "Business partner segment name " - } - } - }, - "SoftLayer_Catalyst_Affiliate": { - "name": "SoftLayer_Catalyst_Affiliate", - "base": "SoftLayer_Entity", - "noservice": true, - "properties": { - "id": { - "name": "id", - "type": "int", - "form": "local" - }, - "name": { - "name": "name", - "type": "string", - "form": "local" + "doc": "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." }, - "skipCreditCardVerificationFlag": { - "name": "skipCreditCardVerificationFlag", - "type": "boolean", - "form": "local" - } - }, - "methods": {} - }, - "SoftLayer_Catalyst_Company_Type": { - "name": "SoftLayer_Catalyst_Company_Type", - "base": "SoftLayer_Entity", - "methods": { - "getAllObjects": { - "name": "getAllObjects", - "type": "SoftLayer_Catalyst_Company_Type", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", + "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "doc": "<<id) of the ordered item." + }, + "laborAfterTaxAmount": { + "name": "laborAfterTaxAmount", + "type": "decimal", + "form": "local", + "doc": "An order item's labor fee total after taxes. This does not include any child invoice items." + }, + "laborFee": { + "name": "laborFee", + "type": "decimal", + "form": "local", + "doc": "The labor fee, if any. This is a one time charge." + }, + "laborFeeTaxRate": { + "name": "laborFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which labor fees are taxed if you are a taxable customer." + }, + "laborTaxAmount": { + "name": "laborTaxAmount", + "type": "decimal", + "form": "local", + "doc": "An order item's labor tax amount. This does not include any child invoice items." + }, + "oneTimeAfterTaxAmount": { + "name": "oneTimeAfterTaxAmount", + "type": "decimal", + "form": "local", + "doc": "An order item's one-time fee total after taxes. This does not include any child invoice items." + }, + "oneTimeFee": { + "name": "oneTimeFee", + "type": "decimal", + "form": "local", + "doc": "The amount of money charged as a one-time charge for an order item, if applicable. oneTimeFee is measured in US Dollars ($USD). " + }, + "oneTimeFeeTaxRate": { + "name": "oneTimeFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which one time fees are taxed if you are a taxable customer." + }, + "oneTimeTaxAmount": { + "name": "oneTimeTaxAmount", + "type": "decimal", + "form": "local", + "doc": "An order item's one-time tax amount. This does not include any child invoice items." + }, + "parentId": { + "name": "parentId", + "type": "int", + "form": "local" + }, + "presetId": { + "name": "presetId", + "type": "int", + "form": "local", + "doc": "The id for the preset configuration ordered." + }, + "promoCodeId": { + "name": "promoCodeId", + "type": "int", + "form": "local" + }, + "quantity": { + "name": "quantity", + "type": "int", + "form": "local", + "doc": "the quantity of the ordered item in a quote." + }, + "recurringAfterTaxAmount": { + "name": "recurringAfterTaxAmount", + "type": "decimal", + "form": "local", + "doc": "An order item's recurring fee total after taxes. This does not include any child invoice items." + }, + "recurringFee": { + "name": "recurringFee", + "type": "decimal", + "form": "local", + "doc": "The amount of money charged per month for an order item, if applicable. recurringFee is measured in US Dollars ($USD). " + }, + "recurringTaxAmount": { + "name": "recurringTaxAmount", + "type": "decimal", + "form": "local", + "doc": "An order item's recurring tax amount. This does not include any child invoice items." + }, + "setupAfterTaxAmount": { + "name": "setupAfterTaxAmount", + "type": "decimal", + "form": "local", + "doc": "An order item's setup fee total after taxes. This does not include any child invoice items." + }, + "setupFee": { + "name": "setupFee", + "type": "decimal", + "form": "local", + "doc": "The setup fee, if any. This is a one time charge." + }, + "setupFeeDeferralMonths": { + "name": "setupFeeDeferralMonths", + "type": "int", + "form": "local", + "doc": "The month set up fee deferral." + }, + "setupFeeTaxRate": { + "name": "setupFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which setup fees are taxed if you are a taxable customer." + }, + "setupTaxAmount": { + "name": "setupTaxAmount", + "type": "decimal", + "form": "local", + "doc": "An order item's setup tax amount. This does not include any child invoice items." + }, + "bundledItemCount": { + "name": "bundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the other items included with an ordered item." + }, + "childrenCount": { + "name": "childrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the child order items for an order item. All server order items should have children. These children are considered a part of the server." + }, + "itemCategoryAnswerCount": { + "name": "itemCategoryAnswerCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of this is an item's category answers." + }, + "nextOrderChildrenCount": { + "name": "nextOrderChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "storageGroupCount": { + "name": "storageGroupCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the drive storage groups that are attached to this billing order item." + } + } + }, + "SoftLayer_Billing_Order_Item_Category_Answer": { + "name": "SoftLayer_Billing_Order_Item_Category_Answer", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Order_Item_Category_Answer data type represents a single answer to an item category question. ", + "properties": { + "orderItem": { + "name": "orderItem", + "type": "SoftLayer_Billing_Order_Item", + "form": "relational", + "doc": "The billing order item that the answer is for." + }, + "question": { + "name": "question", + "type": "SoftLayer_Product_Item_Category_Question", + "form": "relational", + "doc": "The question that is being answered." + }, + "answer": { + "name": "answer", + "type": "string", + "form": "local", + "doc": "The answer to the question." + }, + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date that the answer was created." + }, + "questionId": { + "name": "questionId", + "type": "int", + "form": "local", + "doc": "The identifier for the question that the answer belongs to." + } + }, + "deprecated": true, + "methods": {} + }, + "SoftLayer_Billing_Order_Quote": { + "name": "SoftLayer_Billing_Order_Quote", + "base": "SoftLayer_Entity", + "serviceDoc": "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: \n*'''PENDING''': Quotes which have not been paid yet. Quotes pending approval from a Softlayer customer.\n\n\nOnce 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. \n\nQuotes 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. \n\nQuery the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service to get a list of quotes for your account. ", + "methods": { + "claim": { + "name": "claim", + "type": "SoftLayer_Billing_Order_Quote", + "doc": "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. \n\nTo claim a quote, both the quote id and the quote key (the 32-character random string) must be provided. ", + "docOverview": "Claim an anonymous quote", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "quoteKey", + "type": "string", + "doc": "The 32-character random string generated when the quote was created" + }, + { + "name": "quoteId", + "type": "int", + "doc": "The quote's unique identifier (id) property" + } + ] + }, + "deleteQuote": { + "name": "deleteQuote", + "type": "SoftLayer_Billing_Order_Quote", + "doc": "Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order. ", + "docOverview": "Delete the quote of an order", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception 'You cannot delete a deleted quote.'" + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Order_Quote", + "method": "deleteQuote" + }, + { + "service": "SoftLayer_Billing_Order_Quote", + "method": "saveQuote" + } + ], + "maskable": true + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Billing_Order_Quote", + "doc": "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. ", + "docOverview": "Retrieve a SoftLayer_Billing_Order_Quote record.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_ObjectNotFound", + "description": "Throw the error \"Unable to find object with id of {id}.\" if the given initialization parameter has an invalid id field." + } + ], + "filterable": true, + "maskable": true + }, + "getPdf": { + "name": "getPdf", + "type": "base64Binary", + "doc": "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. ", + "docOverview": "Retrieve a PDF copy of a quote.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception 'PDF does not exist: Order has not yet been created.'" + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception 'PDF does not exist: file not found.'" + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception 'PDF does not exist: Unable to load the quote PDF.'" + } + ] + }, + "getQuoteByQuoteKey": { + "name": "getQuoteByQuoteKey", + "type": "SoftLayer_Billing_Order_Quote", + "doc": "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. ", + "docOverview": "Retrieve a [SoftLayer_Billing_Order_Quote](/reference/datatypes/SoftLayer_Billing_Order_Quote) by the quote key specified.", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception \"No quote found\"" + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception \"Quote is no longer valid.\"" + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception \"Quote expired.\"" + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception \"Quote has been removed from the system.\"" + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception \"Quote is unavailable.\"" + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception \"Could not authenticate quote.\"" + } + ], + "static": true, + "maskable": true, + "parameters": [ + { + "name": "quoteKey", + "type": "string", + "doc": "Key required to retrieve a quote." + } + ] + }, + "getRecalculatedOrderContainer": { + "name": "getRecalculatedOrderContainer", + "type": "SoftLayer_Container_Product_Order", + "doc": "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. ", + "docOverview": "Generate an [SoftLayer_Container_Product_Order](/reference/datatypes/SoftLayer_Container_Product_Order) from the previously-created quote. ", + "parameters": [ + { + "name": "userOrderData", + "type": "SoftLayer_Container_Product_Order", + "doc": "User supplied order data", + "defaultValue": null + }, + { + "name": "orderBeingPlacedFlag", + "type": "boolean", + "doc": "This flag is set and used internally", + "defaultValue": false + } + ] + }, + "placeOrder": { + "name": "placeOrder", + "type": "SoftLayer_Container_Product_Order_Receipt", + "doc": "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. ", + "docOverview": "Place an order", + "parameters": [ + { + "name": "orderData", + "type": "SoftLayer_Container_Product_Order", + "doc": "Details required to order." + } + ] + }, + "placeQuote": { + "name": "placeQuote", + "type": "SoftLayer_Container_Product_Order", + "doc": "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. ", + "docOverview": "Saves changes to a quote", + "parameters": [ + { + "name": "orderData", + "type": "SoftLayer_Container_Product_Order", + "doc": "Details required to order." + } + ] + }, + "saveQuote": { + "name": "saveQuote", + "type": "SoftLayer_Billing_Order_Quote", + "doc": "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. ", + "docOverview": "Save the quote of an order", + "docErrorHandling": [ + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception 'You cannot save a saved quote.'" + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception 'You cannot save a deleted quote.'" + }, + { + "exception": "SoftLayer_Exception_Public", + "description": "Throws the exception 'You cannot save an invalid quote.'" + } + ], + "docAssociatedMethods": [ + { + "service": "SoftLayer_Billing_Order_Quote", + "method": "saveQuote" + }, + { + "service": "SoftLayer_Billing_Order_Quote", + "method": "deleteQuote" + } + ], + "maskable": true + }, + "verifyOrder": { + "name": "verifyOrder", + "type": "SoftLayer_Container_Product_Order", + "doc": "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. ", + "docOverview": "Verify an order", + "parameters": [ + { + "name": "orderData", + "type": "SoftLayer_Container_Product_Order", + "doc": "Details required to order." + } + ] + }, + "withdrawGdprAcceptance": { + "name": "withdrawGdprAcceptance", + "type": "void", + "doc": "Withdraws the users acceptance of the GDPR terms. ", + "docOverview": "Withdraws the users acceptance of the GDPR terms." + }, + "getAccount": { + "doc": "A quote's corresponding account.", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getDoNotContactFlag": { + "doc": "Indicates whether the owner of the quote chosen to no longer be contacted.", + "docOverview": "", + "name": "getDoNotContactFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOrder": { + "doc": "This order contains the records for which products were selected for this quote.", + "docOverview": "", + "name": "getOrder", + "type": "SoftLayer_Billing_Order", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOrdersFromQuote": { + "doc": "These are all the orders that were created from this quote.", + "docOverview": "", + "name": "getOrdersFromQuote", + "type": "SoftLayer_Billing_Order", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "typeDoc": "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. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "A quote's corresponding account." + }, + "doNotContactFlag": { + "name": "doNotContactFlag", + "type": "boolean", + "form": "relational", + "doc": "Indicates whether the owner of the quote chosen to no longer be contacted." + }, + "order": { + "name": "order", + "type": "SoftLayer_Billing_Order", + "form": "relational", + "doc": "This order contains the records for which products were selected for this quote." + }, + "ordersFromQuote": { + "name": "ordersFromQuote", + "type": "SoftLayer_Billing_Order", + "form": "relational", + "typeArray": true, + "doc": "These are all the orders that were created from this quote." + }, + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "Identification Number of the account record tied to the quote" + }, + "completedPurchaseDataId": { + "name": "completedPurchaseDataId", + "type": "int", + "form": "local", + "doc": "Identification Number of the order record tied to the quote." + }, + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "Holds the date the quote record was created" + }, + "expirationDate": { + "name": "expirationDate", + "type": "dateTime", + "form": "local", + "doc": "This property holds the date of expiration of a quote, after that date the quote would be deem expired" + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The id use to identify a quote." + }, + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", + "form": "local", + "doc": "Holds the date when the quote record was modified with reference to its creation date" + }, + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The name given to quote by the initiator" + }, + "publicNote": { + "name": "publicNote", + "type": "string", + "form": "local", + "doc": "This property Holds system generated notes. In our case if a quote is tied to an order where one of the order item has an inactive promotion code, the quote will be considered invalid." + }, + "quoteKey": { + "name": "quoteKey", + "type": "string", + "form": "local", + "doc": "Holds system generated hash password for the Quote" + }, + "status": { + "name": "status", + "type": "string", + "form": "local", + "doc": "This property Holds the current status of a Quote: pending,expired, saved or deleted" + }, + "ordersFromQuoteCount": { + "name": "ordersFromQuoteCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of these are all the orders that were created from this quote." + } + } + }, + "SoftLayer_Billing_Order_Type": { + "name": "SoftLayer_Billing_Order_Type", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "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. ", + "properties": { + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "A brief description of where a SoftLayer order originated from. " + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "A SoftLayer order type's internal identifier. " + }, + "type": { + "name": "type", + "type": "string", + "form": "local", + "doc": "A simple keyname stating where a SoftLayer order originated from. " + } + }, + "methods": {} + }, + "SoftLayer_Billing_Payment_Card_ChangeRequest": { + "name": "SoftLayer_Billing_Payment_Card_ChangeRequest", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "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. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational" + }, + "authorizedCreditCardTransaction": { + "name": "authorizedCreditCardTransaction", + "type": "SoftLayer_Billing_Payment_Card_Transaction", + "form": "relational", + "doc": "The SoftLayer_Billing_Payment_Card_Transaction tied to the authorization performed as part of this change request." + }, + "captureCreditCardTransaction": { + "name": "captureCreditCardTransaction", + "type": "SoftLayer_Billing_Payment_Card_Transaction", + "form": "relational", + "doc": "The SoftLayer_Billing_Payment_Card_Transaction tied to the capture of funds performed as part of this change request." + }, + "ticketAttachmentReferences": { + "name": "ticketAttachmentReferences", + "type": "SoftLayer_Ticket_Attachment", + "form": "relational", + "typeArray": true, + "doc": "These are tickets tied to a credit card change request." + }, + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "The account ID to which the credit card and billing information is associated with." + }, + "amount": { + "name": "amount", + "type": "decimal", + "form": "local", + "doc": "The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD)." + }, + "billingAddressLine1": { + "name": "billingAddressLine1", + "type": "string", + "form": "local", + "doc": "The physical street address. Reserve information such as \"apartment #123\" or \"Suite 2\" for line 1." + }, + "billingAddressLine2": { + "name": "billingAddressLine2", + "type": "string", + "form": "local", + "doc": "The second line in the address. Information such as suite number goes here." + }, + "billingCity": { + "name": "billingCity", + "type": "string", + "form": "local", + "doc": "The city in which a customer's account resides." + }, + "billingCountryCode": { + "name": "billingCountryCode", + "type": "string", + "form": "local", + "doc": "The 2-character Country code for an account's address. (i.e. US)" + }, + "billingEmail": { + "name": "billingEmail", + "type": "string", + "form": "local", + "doc": "The email address associated with a customer account." + }, + "billingNameCompany": { + "name": "billingNameCompany", + "type": "string", + "form": "local", + "doc": "the company name for an account." + }, + "billingNameFirst": { + "name": "billingNameFirst", + "type": "string", + "form": "local", + "doc": "The first name of the customer account owner." + }, + "billingNameLast": { + "name": "billingNameLast", + "type": "string", + "form": "local", + "doc": "The last name of the customer account owner" + }, + "billingPhoneFax": { + "name": "billingPhoneFax", + "type": "string", + "form": "local", + "doc": "The fax number associated with a customer account." + }, + "billingPhoneVoice": { + "name": "billingPhoneVoice", + "type": "string", + "form": "local", + "doc": "The phone number associated with a customer account." + }, + "billingPostalCode": { + "name": "billingPostalCode", + "type": "string", + "form": "local", + "doc": "The Zip or Postal Code for the billing address on an account." + }, + "billingState": { + "name": "billingState", + "type": "string", + "form": "local", + "doc": "The State for the account." + }, + "browserScreenHeight": { + "name": "browserScreenHeight", + "type": "string", + "form": "local", + "doc": "Total height of browser screen in pixels. " + }, + "browserScreenWidth": { + "name": "browserScreenWidth", + "type": "string", + "form": "local", + "doc": "Total width of browser screen in pixels. " + }, + "cardAccountLast4": { + "name": "cardAccountLast4", + "type": "string", + "form": "local", + "doc": "The last 4 digits of a customer's credit card." + }, + "cardAccountNumber": { + "name": "cardAccountNumber", + "type": "string", + "form": "local", + "doc": "The card number submitted in the change request." + }, + "cardExpirationMonth": { + "name": "cardExpirationMonth", + "type": "string", + "form": "local", + "doc": "The month (MM) in which a customer's payment card will expire." + }, + "cardExpirationYear": { + "name": "cardExpirationYear", + "type": "string", + "form": "local", + "doc": "The year (YYYY) in which a customer's payment card will expire." + }, + "cardNickname": { + "name": "cardNickname", + "type": "string", + "form": "local" + }, + "cardType": { + "name": "cardType", + "type": "string", + "form": "local", + "doc": "The type of payment card a customer has. (i.e. Visa, MasterCard, American Express)." + }, + "creditCardVerificationNumber": { + "name": "creditCardVerificationNumber", + "type": "string", + "form": "local", + "doc": "The credit card verification number submitted in the change request." + }, + "currencyShortName": { + "name": "currencyShortName", + "type": "string", + "form": "local", + "doc": "Describes the currency selected for payment" + }, + "deviceFingerprintId": { + "name": "deviceFingerprintId", + "type": "string", + "form": "local", + "doc": "Device Fingerprint Identifier - Used internally and can safely be ignored." + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The unique identifier for a single change request." + }, + "notes": { + "name": "notes", + "type": "string", + "form": "local", + "doc": "the notes stored about a customer's payment card." + }, + "payerAuthenticationEnrollmentReferenceId": { + "name": "payerAuthenticationEnrollmentReferenceId", + "type": "string", + "form": "local", + "doc": "The purpose of this property is to allow enablement of 3D Secure (3DS). This is the Reference ID that corresponds to the device data for Payer Authentication. In order to properly enable 3DS, this will require implementation of Cardinal Cruise Hybrid. \n\nPlease refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under \"DFReferenceId / ReferenceId\" to populate this property accordingly. " + }, + "payerAuthenticationEnrollmentReturnUrl": { + "name": "payerAuthenticationEnrollmentReturnUrl", + "type": "string", + "form": "local", + "doc": "The URL where the issuing bank will redirect. " + }, + "payerAuthenticationWebToken": { + "name": "payerAuthenticationWebToken", + "type": "string", + "form": "local", + "doc": "\"Continue with Consumer Authentication\" decoded response JWT (JSON Web Token) after successful authentication. The response is part of the implementation of Cardinal Cruise Hybrid. \n\nPlease refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under \"Continue with Consumer Authentication\" to populate this property accordingly based on the CCA response. " + }, + "paymentRoleId": { + "name": "paymentRoleId", + "type": "int", + "form": "local" + }, + "paymentType": { + "name": "paymentType", + "type": "string", + "form": "local", + "doc": "The description of the type of payment sent in a change transaction." + }, + "ticketId": { + "name": "ticketId", + "type": "int", + "form": "local", + "doc": "Unique identifier for a ticket discussing the switch between payment methods." + }, + "ticketAttachmentReferenceCount": { + "name": "ticketAttachmentReferenceCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of these are tickets tied to a credit card change request." + } + }, + "methods": {} + }, + "SoftLayer_Billing_Payment_Card_ManualPayment": { + "name": "SoftLayer_Billing_Payment_Card_ManualPayment", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "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. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational" + }, + "authorizedCreditCardTransaction": { + "name": "authorizedCreditCardTransaction", + "type": "SoftLayer_Billing_Payment_Card_Transaction", + "form": "relational", + "doc": "This is the credit card transaction data tied to a credit card manual payment." + }, + "authorizedPayPalTransaction": { + "name": "authorizedPayPalTransaction", + "type": "SoftLayer_Billing_Payment_PayPal_Transaction", + "form": "relational", + "doc": "This is the PayPal transaction data tied to a PayPal manual payment." + }, + "captureCreditCardTransaction": { + "name": "captureCreditCardTransaction", + "type": "SoftLayer_Billing_Payment_Card_Transaction", + "form": "relational", + "doc": "The SoftLayer_Billing_Payment_Card_Transaction tied to the capture performed as part of this manual payment. This will only exist if the manual payment was performed with a credit card." + }, + "capturePayPalTransaction": { + "name": "capturePayPalTransaction", + "type": "SoftLayer_Billing_Payment_PayPal_Transaction", + "form": "relational", + "doc": "The SoftLayer_Billing_Payment_PayPal_Transaction tied to the capture performed as part of this manual payment. This will only exist if the manual payment was performed via PayPal." + }, + "ticketAttachmentReferences": { + "name": "ticketAttachmentReferences", + "type": "SoftLayer_Ticket_Attachment", + "form": "relational", + "typeArray": true, + "doc": "These are tickets tied to a credit card manual payment." + }, + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "The account ID to which the credit card and billing information is associated with." + }, + "amount": { + "name": "amount", + "type": "decimal", + "form": "local", + "doc": "The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD)." + }, + "authorizedCreditCardTransactionId": { + "name": "authorizedCreditCardTransactionId", + "type": "int", + "form": "local", + "doc": "The unique identifier of an attempted credit card transaction." + }, + "authorizedPayPalTransactionId": { + "name": "authorizedPayPalTransactionId", + "type": "int", + "form": "local", + "doc": "The unique identifier of an attempted PayPal transaction." + }, + "billingAddressLine1": { + "name": "billingAddressLine1", + "type": "string", + "form": "local", + "doc": "The physical street address. Reserve information such as \"apartment #123\" or \"Suite 2\" for line 1." + }, + "billingAddressLine2": { + "name": "billingAddressLine2", + "type": "string", + "form": "local", + "doc": "The second line in the address. Information such as suite number goes here." + }, + "billingCity": { + "name": "billingCity", + "type": "string", + "form": "local", + "doc": "The city in which a customer's account resides." + }, + "billingCountryCode": { + "name": "billingCountryCode", + "type": "string", + "form": "local", + "doc": "The 2-character Country code for an account's address. (i.e. US)" + }, + "billingEmail": { + "name": "billingEmail", + "type": "string", + "form": "local", + "doc": "The email address associated with a customer account." + }, + "billingNameCompany": { + "name": "billingNameCompany", + "type": "string", + "form": "local", + "doc": "the company name for an account." + }, + "billingNameFirst": { + "name": "billingNameFirst", + "type": "string", + "form": "local", + "doc": "The first name of the customer account owner." + }, + "billingNameLast": { + "name": "billingNameLast", + "type": "string", + "form": "local", + "doc": "The last name of the customer account owner." + }, + "billingPhoneFax": { + "name": "billingPhoneFax", + "type": "string", + "form": "local", + "doc": "The fax number associated with a customer account." + }, + "billingPhoneVoice": { + "name": "billingPhoneVoice", + "type": "string", + "form": "local", + "doc": "The phone number associated with a customer account." + }, + "billingPostalCode": { + "name": "billingPostalCode", + "type": "string", + "form": "local", + "doc": "The Zip or Postal Code for the billing address on an account." + }, + "billingState": { + "name": "billingState", + "type": "string", + "form": "local", + "doc": "The State for the account." + }, + "browserScreenHeight": { + "name": "browserScreenHeight", + "type": "string", + "form": "local", + "doc": "Total height of browser screen in pixels. " + }, + "browserScreenWidth": { + "name": "browserScreenWidth", + "type": "string", + "form": "local", + "doc": "Total width of browser screen in pixels. " + }, + "cancelUrl": { + "name": "cancelUrl", + "type": "string", + "form": "local", + "doc": "The cancel URL is the page to which PayPal redirects if payment is not approved." + }, + "cardAccountHash": { + "name": "cardAccountHash", + "type": "string", + "form": "local", + "doc": "A hash value of the credit card number." + }, + "cardAccountLast4": { + "name": "cardAccountLast4", + "type": "string", + "form": "local", + "doc": "The last 4 digits of a customer's credit card." + }, + "cardAccountNumber": { + "name": "cardAccountNumber", + "type": "string", + "form": "local", + "doc": "The card number submitted in the change request." + }, + "cardExpirationMonth": { + "name": "cardExpirationMonth", + "type": "string", + "form": "local", + "doc": "The month (MM) in which a customer's payment card will expire." + }, + "cardExpirationYear": { + "name": "cardExpirationYear", + "type": "string", + "form": "local", + "doc": "The year (YYYY) in which a customer's payment card will expire." + }, + "cardType": { + "name": "cardType", + "type": "string", + "form": "local", + "doc": "The method key of the type payment issued (Visa - 001, Mastercard - 002, American Express - 003, Discover - 004, PayPal - paypal)." + }, + "creditCardVerificationNumber": { + "name": "creditCardVerificationNumber", + "type": "string", + "form": "local", + "doc": "The credit card verification number submitted in the change request." + }, + "currencyShortName": { + "name": "currencyShortName", + "type": "string", + "form": "local", + "doc": "Describes the currency selected for payment" + }, + "deviceFingerprintId": { + "name": "deviceFingerprintId", + "type": "string", + "form": "local", + "doc": "Device Fingerprint Identifier - Used internally and can safely be ignored." + }, + "fromIpAddress": { + "name": "fromIpAddress", + "type": "string", + "form": "local", + "doc": "The IP address from which the transaction originates." + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The unique identifier for a single manual payment request." + }, + "notes": { + "name": "notes", + "type": "string", + "form": "local", + "doc": "Notes generated as a result of the payment request." + }, + "payerAuthenticationEnrollmentReferenceId": { + "name": "payerAuthenticationEnrollmentReferenceId", + "type": "string", + "form": "local", + "doc": "The purpose of this property is to allow enablement of 3D Secure (3DS). This is the Reference ID that corresponds to the device data for Payer Authentication. In order to properly enable 3DS, this will require implementation of Cardinal Cruise Hybrid. \n\nPlease refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under \"DFReferenceId / ReferenceId\" to populate this property accordingly. " + }, + "payerAuthenticationEnrollmentReturnUrl": { + "name": "payerAuthenticationEnrollmentReturnUrl", + "type": "string", + "form": "local", + "doc": "The URL where the issuing bank will redirect. " + }, + "payerAuthenticationWebToken": { + "name": "payerAuthenticationWebToken", + "type": "string", + "form": "local", + "doc": "\"Continue with Consumer Authentication\" decoded response JWT (JSON Web Token) after successful authentication. The response is part of the implementation of Cardinal Cruise Hybrid. \n\nPlease refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under \"Continue with Consumer Authentication\" to populate this property accordingly based on the CCA response. " + }, + "paymentType": { + "name": "paymentType", + "type": "string", + "form": "local", + "doc": "The description of the type of payment sent in a change transaction." + }, + "returnUrl": { + "name": "returnUrl", + "type": "string", + "form": "local", + "doc": "The return URL is the page to which PayPal redirects after payment is approved." + }, + "type": { + "name": "type", + "type": "string", + "form": "local", + "doc": "Describes the type of manual payment (PAYPAL or CREDIT_CARD)." + }, + "ticketAttachmentReferenceCount": { + "name": "ticketAttachmentReferenceCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of these are tickets tied to a credit card manual payment." + } + }, + "methods": {} + }, + "SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup": { + "name": "SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "This datatype payer authentication setup ", + "properties": { + "accessToken": { + "name": "accessToken", + "type": "string", + "form": "local", + "doc": "This is used to authenticate the customer with the authentication provider." + }, + "deviceDataCollectionUrl": { + "name": "deviceDataCollectionUrl", + "type": "string", + "form": "local", + "doc": "Location to send the authentication when you invoke device data collection." + }, + "referenceId": { + "name": "referenceId", + "type": "string", + "form": "local", + "doc": "This identifier indicates that the device data collection" + } + }, + "methods": {} + }, + "SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup_Information": { + "name": "SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup_Information", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "This is the datatype that needs to be populated and sent to SoftLayer_Account::initiatePayerAuthentication. ", + "properties": { + "billingAddressLine1": { + "name": "billingAddressLine1", + "type": "string", + "form": "local", + "doc": "The physical street address. Reserve information such as \"apartment #123\" or \"Suite 2\" for line 1." + }, + "billingAddressLine2": { + "name": "billingAddressLine2", + "type": "string", + "form": "local", + "doc": "The second line in the address. Information such as suite number goes here." + }, + "billingCity": { + "name": "billingCity", + "type": "string", + "form": "local", + "doc": "The city in which a customer's account resides." + }, + "billingCountryCode": { + "name": "billingCountryCode", + "type": "string", + "form": "local", + "doc": "The 2-character Country code for an account's address. (i.e. US)" + }, + "billingEmail": { + "name": "billingEmail", + "type": "string", + "form": "local", + "doc": "The email address associated with a customer account." + }, + "billingNameFirst": { + "name": "billingNameFirst", + "type": "string", + "form": "local", + "doc": "The first name of the customer account owner." + }, + "billingNameLast": { + "name": "billingNameLast", + "type": "string", + "form": "local", + "doc": "The last name of the customer account owner" + }, + "billingPostalCode": { + "name": "billingPostalCode", + "type": "string", + "form": "local", + "doc": "The Zip or Postal Code for the billing address on an account." + }, + "billingState": { + "name": "billingState", + "type": "string", + "form": "local", + "doc": "The State for the account." + }, + "cardAccountNumber": { + "name": "cardAccountNumber", + "type": "string", + "form": "local", + "doc": "The credit card number to use." + }, + "cardExpirationMonth": { + "name": "cardExpirationMonth", + "type": "int", + "form": "local", + "doc": "The payment card expiration month" + }, + "cardExpirationYear": { + "name": "cardExpirationYear", + "type": "int", + "form": "local", + "doc": "The payment card expiration year" + }, + "cardType": { + "name": "cardType", + "type": "string", + "form": "local", + "doc": "The method key of the type payment issued" + }, + "creditCardVerificationNumber": { + "name": "creditCardVerificationNumber", + "type": "string", + "form": "local", + "doc": "The credit card verification number" + } + }, + "methods": {} + }, + "SoftLayer_Billing_Payment_Card_Transaction": { + "name": "SoftLayer_Billing_Payment_Card_Transaction", + "base": "SoftLayer_Billing_Payment_Transaction", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Payment_Card_Transaction data type contains general information relating to attempted credit card transactions. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account to which a transaction belongs." + }, + "order": { + "name": "order", + "type": "SoftLayer_Billing_Order", + "form": "relational" + }, + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "The account ID to which the credit card and billing information is associated with." + }, + "amount": { + "name": "amount", + "type": "decimal", + "form": "local", + "doc": "The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD)." + }, + "billingAddressLine1": { + "name": "billingAddressLine1", + "type": "string", + "form": "local", + "doc": "The physical street address. Reserve information such as \"apartment #123\" or \"Suite 2\" for line 1." + }, + "billingAddressLine2": { + "name": "billingAddressLine2", + "type": "string", + "form": "local", + "doc": "The second line in the address. Information such as suite number goes here." + }, + "billingCity": { + "name": "billingCity", + "type": "string", + "form": "local", + "doc": "The city in which a customer's account resides." + }, + "billingCountryCode": { + "name": "billingCountryCode", + "type": "string", + "form": "local", + "doc": "The 2-character Country code for an account's address. (i.e. US)" + }, + "billingEmail": { + "name": "billingEmail", + "type": "string", + "form": "local", + "doc": "The email address associated with a customer account." + }, + "billingNameCompany": { + "name": "billingNameCompany", + "type": "string", + "form": "local", + "doc": "the company name for an account." + }, + "billingNameFirst": { + "name": "billingNameFirst", + "type": "string", + "form": "local", + "doc": "The first name of the customer account owner." + }, + "billingNameLast": { + "name": "billingNameLast", + "type": "string", + "form": "local", + "doc": "The last name of the customer account owner." + }, + "billingPhoneFax": { + "name": "billingPhoneFax", + "type": "string", + "form": "local", + "doc": "The fax number associated with a customer account." + }, + "billingPhoneVoice": { + "name": "billingPhoneVoice", + "type": "string", + "form": "local", + "doc": "The phone number associated with a customer account." + }, + "billingPostalCode": { + "name": "billingPostalCode", + "type": "string", + "form": "local", + "doc": "The Zip or Postal Code for the billing address on an account." + }, + "billingState": { + "name": "billingState", + "type": "string", + "form": "local", + "doc": "The State for the account." + }, + "cardAccountLast4": { + "name": "cardAccountLast4", + "type": "int", + "form": "local", + "doc": "The last 4 digits of a customer's credit card." + }, + "cardExpirationMonth": { + "name": "cardExpirationMonth", + "type": "int", + "form": "local", + "doc": "The month (MM) in which a customer's payment card will expire." + }, + "cardExpirationYear": { + "name": "cardExpirationYear", + "type": "int", + "form": "local", + "doc": "The year (YYYY) in which a customer's payment card will expire." + }, + "cardType": { + "name": "cardType", + "type": "string", + "form": "local", + "doc": "The type of payment issued (i.e. Visa, MasterCard, American Express)." + }, + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date that the transaction was attempted." + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The unique identifier for a single credit card transaction request." + }, + "invoiceId": { + "name": "invoiceId", + "type": "int", + "form": "local", + "doc": "Unique identifier of the invoice to which funds will be applied." + }, + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", + "form": "local", + "doc": "The date that the transaction was modified." + }, + "orderFromIpAddress": { + "name": "orderFromIpAddress", + "type": "string", + "form": "local", + "doc": "The IP address from which the transaction originates." + }, + "referenceCode": { + "name": "referenceCode", + "type": "string", + "form": "local", + "doc": "A code used by the financial institution to refer to the requested transaction." + }, + "requestId": { + "name": "requestId", + "type": "string", + "form": "local", + "doc": "The unique identifier of the request submitted to the financial institution." + }, + "returnStatus": { + "name": "returnStatus", + "type": "int", + "form": "local", + "doc": "The status code returned from the financial institution." + }, + "serializedReply": { + "name": "serializedReply", + "type": "string", + "form": "local", + "doc": "A serialized, delimited string of the transaction request sent to the financial institution." + }, + "serializedRequest": { + "name": "serializedRequest", + "type": "string", + "form": "local", + "doc": "A serialized, delimited string of the transaction request sent to the financial institution." + } + }, + "methods": {} + }, + "SoftLayer_Billing_Payment_PayPal_Transaction": { + "name": "SoftLayer_Billing_Payment_PayPal_Transaction", + "base": "SoftLayer_Billing_Payment_Transaction", + "noservice": true, + "typeDoc": "The SoftLayer_Billing_Payment_PayPal_Transaction data type contains general information relating to attempted PayPal transactions. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational", + "doc": "The account to which a transaction belongs." + }, + "order": { + "name": "order", + "type": "SoftLayer_Billing_Order", + "form": "relational" + }, + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "The account ID to which the PayPal and billing information is associated with." + }, + "addressCityName": { + "name": "addressCityName", + "type": "string", + "form": "local", + "doc": "City given in the address of the PayPal user." + }, + "addressCountry": { + "name": "addressCountry", + "type": "string", + "form": "local", + "doc": "Country given in the named address of the PayPal user." + }, + "addressName": { + "name": "addressName", + "type": "string", + "form": "local", + "doc": "Name given to the address provided for the PayPal user." + }, + "addressPostalCode": { + "name": "addressPostalCode", + "type": "string", + "form": "local", + "doc": "Postal Code of the address of the PayPal user." + }, + "addressStateProvence": { + "name": "addressStateProvence", + "type": "string", + "form": "local", + "doc": "State or Province in the address of the PayPal user." + }, + "addressStatus": { + "name": "addressStatus", + "type": "string", + "form": "local", + "doc": "PayPal defined status of the address of the PayPal user." + }, + "addressStreet1": { + "name": "addressStreet1", + "type": "string", + "form": "local", + "doc": "First line of the street address of the PayPal user." + }, + "addressStreet2": { + "name": "addressStreet2", + "type": "string", + "form": "local", + "doc": "Second line of the street address of the PayPal user." + }, + "contactPhone": { + "name": "contactPhone", + "type": "string", + "form": "local", + "doc": "Phone number provided for the PayPal user." + }, + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date that the transaction was attempted." + }, + "exchangeRate": { + "name": "exchangeRate", + "type": "string", + "form": "local", + "doc": "Exchange rate imposed on the payment amount." + }, + "feeAmount": { + "name": "feeAmount", + "type": "decimal", + "form": "local", + "doc": "PayPal fee applied to the payment." + }, + "grossAmount": { + "name": "grossAmount", + "type": "decimal", + "form": "local", + "doc": "The total amount of the payment executed by PayPal, represented in decimal format as US Dollars ($USD)." + }, + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The unique identifier for a single PayPal transaction request." + }, + "invoiceId": { + "name": "invoiceId", + "type": "int", + "form": "local", + "doc": "Unique identifier of the invoice to which funds will be applied." + }, + "lastPaypalCommand": { + "name": "lastPaypalCommand", + "type": "string", + "form": "local", + "doc": "The name of the command issued to PayPal with regards to the attempted transaction." + }, + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", + "form": "local", + "doc": "The date that the transaction was modified." + }, + "orderFromIpAddress": { + "name": "orderFromIpAddress", + "type": "string", + "form": "local", + "doc": "The IP address from where the PayPal payment request originated." + }, + "orderTotal": { + "name": "orderTotal", + "type": "decimal", + "form": "local", + "doc": "The amount of the payment submitted through the SoftLayer interface, represented in decimal format as US Dollars ($USD)." + }, + "payer": { + "name": "payer", + "type": "string", + "form": "local", + "doc": "The PayPal user account name (email address) associated with the customer account." + }, + "payerBusiness": { + "name": "payerBusiness", + "type": "string", + "form": "local", + "doc": "The name of the business associated with the PayPal user." + }, + "payerCountry": { + "name": "payerCountry", + "type": "string", + "form": "local", + "doc": "Country given in the address of the PayPal user." + }, + "payerFirstName": { + "name": "payerFirstName", + "type": "string", + "form": "local", + "doc": "First name of the PayPal user." + }, + "payerId": { + "name": "payerId", + "type": "string", + "form": "local", + "doc": "Unique PayPal user account identifier." + }, + "payerLastName": { + "name": "payerLastName", + "type": "string", + "form": "local", + "doc": "Last name of the PayPal user." + }, + "payerStatus": { + "name": "payerStatus", + "type": "string", + "form": "local", + "doc": "Current PayPal status associated with the user account." + }, + "paymentDate": { + "name": "paymentDate", + "type": "dateTime", + "form": "local", + "doc": "Date that the payment was confirmed in PayPal by the user." + }, + "paymentStatus": { + "name": "paymentStatus", + "type": "string", + "form": "local", + "doc": "PayPal defined status of the attempted payment." + }, + "paymentType": { + "name": "paymentType", + "type": "string", + "form": "local", + "doc": "PayPal defined code used to identify the type of payment. Provided in a PayPal response." + }, + "pendingReason": { + "name": "pendingReason", + "type": "string", + "form": "local", + "doc": "Reason provided by PayPal for a payment given a pending status." + }, + "serializedReply": { + "name": "serializedReply", + "type": "string", + "form": "local", + "doc": "A serialized, delimited string of the reply received from PayPal." + }, + "serializedRequest": { + "name": "serializedRequest", + "type": "string", + "form": "local", + "doc": "A serialized, delimited string of the request submitted to PayPal." + }, + "settleAmount": { + "name": "settleAmount", + "type": "decimal", + "form": "local", + "doc": "PayPal defined fee." + }, + "taxAmount": { + "name": "taxAmount", + "type": "decimal", + "form": "local", + "doc": "Tax applied by PayPal to the payment amount." + }, + "token": { + "name": "token", + "type": "string", + "form": "local", + "doc": "Value issued by PayPal for referencing the attempted transaction." + }, + "transactionId": { + "name": "transactionId", + "type": "string", + "form": "local", + "doc": "Unique transaction ID provided in a PayPal response." + }, + "transactionType": { + "name": "transactionType", + "type": "string", + "form": "local", + "doc": "PayPal defined code used to identify the type of transaction. Provided in a PayPal response." + } + }, + "methods": {} + }, + "SoftLayer_Billing_Payment_Processor": { + "name": "SoftLayer_Billing_Payment_Processor", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "brandAssignments": { + "name": "brandAssignments", + "type": "SoftLayer_Brand_Payment_Processor", + "form": "relational", + "typeArray": true + }, + "ownerAccount": { + "name": "ownerAccount", + "type": "SoftLayer_Account", + "form": "relational" + }, + "paymentMethods": { + "name": "paymentMethods", + "type": "SoftLayer_Billing_Payment_Processor_Method", + "form": "relational", + "typeArray": true + }, + "type": { + "name": "type", + "type": "SoftLayer_Billing_Payment_Processor_Type", + "form": "relational" + }, + "description": { + "name": "description", + "type": "string", + "form": "local" + }, + "name": { + "name": "name", + "type": "string", + "form": "local" + }, + "brandAssignmentCount": { + "name": "brandAssignmentCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "paymentMethodCount": { + "name": "paymentMethodCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + } + }, + "methods": {} + }, + "SoftLayer_Billing_Payment_Processor_Method": { + "name": "SoftLayer_Billing_Payment_Processor_Method", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "paymentProcessor": { + "name": "paymentProcessor", + "type": "SoftLayer_Billing_Payment_Processor", + "form": "relational" + }, + "paymentType": { + "name": "paymentType", + "type": "SoftLayer_Billing_Payment_Type", + "form": "relational" + }, + "methodKey": { + "name": "methodKey", + "type": "string", + "form": "local" + }, + "multipleCurrencyFlag": { + "name": "multipleCurrencyFlag", + "type": "boolean", + "form": "local" + } + }, + "methods": {} + }, + "SoftLayer_Billing_Payment_Processor_Type": { + "name": "SoftLayer_Billing_Payment_Processor_Type", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "paymentProcessors": { + "name": "paymentProcessors", + "type": "SoftLayer_Billing_Payment_Processor", + "form": "relational", + "typeArray": true + }, + "description": { + "name": "description", + "type": "string", + "form": "local" + }, + "keyName": { + "name": "keyName", + "type": "string", + "form": "local" + }, + "name": { + "name": "name", + "type": "string", + "form": "local" + }, + "paymentProcessorCount": { + "name": "paymentProcessorCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + } + }, + "methods": {} + }, + "SoftLayer_Billing_Payment_Transaction": { + "name": "SoftLayer_Billing_Payment_Transaction", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "Implementation for payment transactions. ", + "methods": {}, + "properties": {} + }, + "SoftLayer_Billing_Payment_Type": { + "name": "SoftLayer_Billing_Payment_Type", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "description": { + "name": "description", + "type": "string", + "form": "local" + }, + "keyName": { + "name": "keyName", + "type": "string", + "form": "local" + }, + "name": { + "name": "name", + "type": "string", + "form": "local" + } + }, + "methods": {} + }, + "SoftLayer_Brand": { + "name": "SoftLayer_Brand", + "base": "SoftLayer_Entity", + "serviceDoc": "Every IBM Cloud Infrastructure customer account is associated to a brand. \n\nIBM Cloud Infrastructure customers are unable to change their brand information in the portal or the API. ", + "methods": { + "createCustomerAccount": { + "name": "createCustomerAccount", + "type": "SoftLayer_Account", + "doc": "Create a new customer account record. By default, the newly created account will be associated to a platform (PaaS) account. To skip the automatic creation and linking to a new platform account, set the bluemixLinkedFlag to false on the account template. ", + "docOverview": "Create a new customer account record.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "account", + "type": "SoftLayer_Account", + "doc": "The template of the account object to be created." + }, + { + "name": "bypassDuplicateAccountCheck", + "type": "boolean", + "doc": "Bypass validation for duplicate account(s).", + "defaultValue": false + } + ] + }, + "createObject": { + "name": "createObject", + "type": "SoftLayer_Brand", + "doc": "\ncreateObject() allows the creation of a new brand. This will also create an `account` \nto serve as the owner of the brand. \n\n\nIn order to create a brand, a template object must be sent in with several required values. \n\n\n### Input [SoftLayer_Brand](/reference/datatypes/SoftLayer_Brand)\n\n\n\n- `name` \n + Name of brand \n + Required \n + Type: string \n- `keyName` \n + Reference key name \n + Required \n + Type: string \n- `longName` \n + More descriptive name of brand \n + Required \n + Type: string \n- `account.firstName` \n + First Name of account contact \n + Required \n + Type: string \n- `account.lastName` \n + Last Name of account contact \n + Required \n + Type: string \n- `account.address1` \n + Street Address of company \n + Required \n + Type: string \n- `account.address2` \n + Street Address of company \n + Optional \n + Type: string \n- `account.city` \n + City of company \n + Required \n + Type: string \n- `account.state` \n + State of company (if applicable) \n + Conditionally Required \n + Type: string \n- `account.postalCode` \n + Postal Code of company \n + Required \n + Type: string \n- `account.country` \n + Country of company \n + Required \n + Type: string \n- `account.officePhone` \n + Office Phone number of Company \n + Required \n + Type: string \n- `account.alternatePhone` \n + Alternate Phone number of Company \n + Optional \n + Type: string \n- `account.companyName` \n + Name of company \n + Required \n + Type: string \n- `account.email` \n + Email address of account contact \n + Required \n + Type: string \n\n\nREST Example: \n``` \ncurl -X POST -d '{ \n \"parameters\":[{ \n \"name\": \"Brand Corp\", \n \"keyName\": \"BRAND_CORP\", \n \"longName\": \"Brand Corporation\", \n \"account\": { \n \"firstName\": \"Gloria\", \n \"lastName\": \"Brand\", \n \"address1\": \"123 Drive\", \n \"city\": \"Boston\", \n \"state\": \"MA\", \n \"postalCode\": \"02107\", \n \"country\": \"US\", \n \"companyName\": \"Brand Corp\", \n \"officePhone\": \"857-111-1111\", \n \"email\": \"noreply@example.com\" \n } \n }] \n}' https://api.softlayer.com/rest/v3.1/SoftLayer_Brand/createObject.json \n``` ", + "docOverview": "Create a new brand.", + "static": true, + "maskable": true, + "parameters": [ + { + "name": "templateObject", + "type": "SoftLayer_Brand", + "doc": "The SoftLayer_Brand object that you wish to create." + } + ] + }, + "disableAccount": { + "name": "disableAccount", + "type": "void", + "doc": "Disable an account associated with this Brand. Anything that would disqualify the account from being disabled will cause an exception to be raised. ", + "parameters": [ + { + "name": "accountId", + "type": "int" + } + ] + }, + "getAllTicketSubjects": { + "name": "getAllTicketSubjects", + "type": "SoftLayer_Ticket_Subject", + "typeArray": true, + "doc": "(DEPRECATED) Use [SoftLayer_Ticket_Subject::getAllObjects](/reference/datatypes/$1/#$2) method. ", + "maskable": true, + "deprecated": true, + "parameters": [ + { + "name": "account", + "type": "SoftLayer_Account", + "doc": "Deprecated. Account is no longer required", + "defaultValue": null + } + ] + }, + "getBillingItemSnapshotsForSingleOwnedAccount": { + "name": "getBillingItemSnapshotsForSingleOwnedAccount", + "type": "SoftLayer_Billing_Item_Chronicle", + "typeArray": true, + "doc": "This service returns the snapshots of billing items recorded periodically given an account ID. The provided account ID must be owned by the brand that calls this service. In this context, it can be interpreted that the billing items snapshots belong to both the account and that accounts brand. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. \n\nThe downside is, they are not real time, and do not share relational parity with the original billing item. ", + "docOverview": "Returns billing item snapshots on accounts owned by specific brands.", + "limitable": true, + "filterable": true, + "maskable": true, + "parameters": [ + { + "name": "accountId", + "type": "int", + "doc": "The IBM Cloud infrastructure account ID the billing items belong to." + } + ] + }, + "getBillingItemSnapshotsWithExternalAccountId": { + "name": "getBillingItemSnapshotsWithExternalAccountId", + "type": "SoftLayer_Billing_Item_Chronicle", + "typeArray": true, + "doc": "This service returns the snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. \n\nThe downside is, they are not real time, and do not share relational parity with the original billing item. ", + "docOverview": "Returns billing item snapshots on accounts owned by specific brands.", + "limitable": true, + "filterable": true, + "maskable": true, + "parameters": [ + { + "name": "externalAccountId", + "type": "string", + "doc": "The IBM Cloud account ID the billing items belong to." + } + ] + }, + "getContactInformation": { + "name": "getContactInformation", + "type": "SoftLayer_Brand_Contact", + "typeArray": true, + "doc": "Retrieve the contact information for the brand such as the corporate or support contact. This will include the contact name, telephone number, fax number, email address, and mailing address of the contact. ", + "docOverview": "Retrieve the contact information for the customer account brand.", + "maskable": true + }, + "getMerchantName": { + "name": "getMerchantName", + "type": "string", + "doc": "Get the payment processor merchant name." + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Brand", + "docOverview": "Retrieve a SoftLayer_Brand record.", + "filterable": true, + "maskable": true + }, + "getToken": { + "name": "getToken", + "type": "string", + "doc": "(DEPRECATED) Use [SoftLayer_User_Customer::getImpersonationToken](/reference/datatypes/$1/#$2) method. ", + "deprecated": true, + "parameters": [ + { + "name": "userId", + "type": "int" + } + ] + }, + "isIbmSlicBrand": { + "name": "isIbmSlicBrand", + "type": "boolean", + "doc": "Check if the brand is IBM SLIC top level brand or sub brand. ", + "docOverview": "Check if the brand is IBM SLIC top level brand or sub brand." + }, + "isPlatformServicesBrand": { + "name": "isPlatformServicesBrand", + "type": "boolean", + "doc": "Check if the alternate billing system of brand is Bluemix. ", + "docOverview": "Check if the alternate billing system of brand is Bluemix." + }, + "migrateExternalAccount": { + "name": "migrateExternalAccount", + "type": "SoftLayer_Account_Brand_Migration_Request", + "doc": "Will attempt to migrate an external account to the brand in context. ", + "docOverview": "Migrates an account from an external brand to this brand.", + "maskable": true, + "parameters": [ + { + "name": "accountId", + "type": "int" + } + ] + }, + "reactivateAccount": { + "name": "reactivateAccount", + "type": "void", + "doc": "Reactivate an account associated with this Brand. Anything that would disqualify the account from being reactivated will cause an exception to be raised. ", + "parameters": [ + { + "name": "accountId", + "type": "int" + } + ] + }, + "refreshBillingItemSnapshot": { + "name": "refreshBillingItemSnapshot", + "type": "boolean", + "doc": "When this service is called given an IBM Cloud infrastructure account ID owned by the calling brand, the process is started to refresh the billing item snapshots belonging to that account. This refresh is async and can take an undetermined amount of time. Even if this endpoint returns an OK, it doesn't guarantee that refresh did not fail or encounter issues. \n\n", + "docOverview": "Begins the process for refreshing the billing item snapshots", + "parameters": [ + { + "name": "accountId", + "type": "int" + } + ] + }, + "verifyCanDisableAccount": { + "name": "verifyCanDisableAccount", + "type": "void", + "doc": "Verify that an account may be disabled by a Brand Agent. Anything that would disqualify the account from being disabled will cause an exception to be raised. ", + "parameters": [ + { + "name": "accountId", + "type": "int" + } + ] + }, + "verifyCanReactivateAccount": { + "name": "verifyCanReactivateAccount", + "type": "void", + "doc": "Verify that an account may be reactivated by a Brand Agent. Anything that would disqualify the account from being reactivated will cause an exception to be raised. ", + "parameters": [ + { + "name": "accountId", + "type": "int" + } + ] + }, + "getAccount": { + "doc": "", + "docOverview": "", + "name": "getAccount", + "type": "SoftLayer_Account", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getAllOwnedAccounts": { + "doc": "All accounts owned by the brand.", + "docOverview": "", + "name": "getAllOwnedAccounts", + "type": "SoftLayer_Account", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getAllowAccountCreationFlag": { + "doc": "This flag indicates if creation of accounts is allowed.", + "docOverview": "", + "name": "getAllowAccountCreationFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBillingItemSnapshots": { + "doc": "Returns snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. The downside is, they are not real time, and do not share relational parity with the original billing item.", + "docOverview": "", + "name": "getBillingItemSnapshots", + "type": "SoftLayer_Billing_Item_Chronicle", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getBusinessPartner": { + "doc": "Business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level.", + "docOverview": "", + "name": "getBusinessPartner", + "type": "SoftLayer_Brand_Business_Partner", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getBusinessPartnerFlag": { + "doc": "Flag indicating if the brand is a business partner.", + "docOverview": "", + "name": "getBusinessPartnerFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getCatalog": { + "doc": "The Product Catalog for the Brand", + "docOverview": "", + "name": "getCatalog", + "type": "SoftLayer_Product_Catalog", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getContacts": { + "doc": "The contacts for the brand.", + "docOverview": "", + "name": "getContacts", + "type": "SoftLayer_Brand_Contact", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getCustomerCountryLocationRestrictions": { + "doc": "This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain.", + "docOverview": "", + "name": "getCustomerCountryLocationRestrictions", + "type": "SoftLayer_Brand_Restriction_Location_CustomerCountry", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getDistributor": { + "doc": "", + "docOverview": "", + "name": "getDistributor", + "type": "SoftLayer_Brand", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getDistributorChildFlag": { + "doc": "", + "docOverview": "", + "name": "getDistributorChildFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getDistributorFlag": { + "doc": "", + "docOverview": "", + "name": "getDistributorFlag", + "type": "string", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getHardware": { + "doc": "An account's associated hardware objects.", + "docOverview": "", + "name": "getHardware", + "type": "SoftLayer_Hardware", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getHasAgentAdvancedSupportFlag": { + "doc": "", + "docOverview": "", + "name": "getHasAgentAdvancedSupportFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getHasAgentSupportFlag": { + "doc": "", + "docOverview": "", + "name": "getHasAgentSupportFlag", + "type": "boolean", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getOpenTickets": { + "doc": "", + "docOverview": "", + "name": "getOpenTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getOwnedAccounts": { + "doc": "Active accounts owned by the brand.", + "docOverview": "", + "name": "getOwnedAccounts", + "type": "SoftLayer_Account", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getSecurityLevel": { + "doc": "", + "docOverview": "", + "name": "getSecurityLevel", + "type": "SoftLayer_Security_Level", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getTicketGroups": { + "doc": "", + "docOverview": "", + "name": "getTicketGroups", + "type": "SoftLayer_Ticket_Group", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getTickets": { + "doc": "", + "docOverview": "", + "name": "getTickets", + "type": "SoftLayer_Ticket", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getUsers": { + "doc": "", + "docOverview": "", + "name": "getUsers", + "type": "SoftLayer_User_Customer", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + }, + "getVirtualGuests": { + "doc": "An account's associated virtual guest objects.", + "docOverview": "", + "name": "getVirtualGuests", + "type": "SoftLayer_Virtual_Guest", + "typeArray": true, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false, + "limitable": true + } + }, + "typeDoc": "The SoftLayer_Brand data type contains brand information relating to the single SoftLayer customer account. \n\nIBM Cloud Infrastructure customers are unable to change their brand information in the portal or the API. ", + "properties": { + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational" + }, + "allOwnedAccounts": { + "name": "allOwnedAccounts", + "type": "SoftLayer_Account", + "form": "relational", + "typeArray": true, + "doc": "All accounts owned by the brand." + }, + "allowAccountCreationFlag": { + "name": "allowAccountCreationFlag", + "type": "boolean", + "form": "relational", + "doc": "This flag indicates if creation of accounts is allowed." + }, + "billingItemSnapshots": { + "name": "billingItemSnapshots", + "type": "SoftLayer_Billing_Item_Chronicle", + "form": "relational", + "typeArray": true, + "doc": "Returns snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. The downside is, they are not real time, and do not share relational parity with the original billing item." + }, + "businessPartner": { + "name": "businessPartner", + "type": "SoftLayer_Brand_Business_Partner", + "form": "relational", + "doc": "Business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level." + }, + "businessPartnerFlag": { + "name": "businessPartnerFlag", + "type": "boolean", + "form": "relational", + "doc": "Flag indicating if the brand is a business partner." + }, + "catalog": { + "name": "catalog", + "type": "SoftLayer_Product_Catalog", + "form": "relational", + "doc": "The Product Catalog for the Brand" + }, + "contacts": { + "name": "contacts", + "type": "SoftLayer_Brand_Contact", + "form": "relational", + "typeArray": true, + "doc": "The contacts for the brand." + }, + "customerCountryLocationRestrictions": { + "name": "customerCountryLocationRestrictions", + "type": "SoftLayer_Brand_Restriction_Location_CustomerCountry", + "form": "relational", + "typeArray": true, + "doc": "This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain." + }, + "distributor": { + "name": "distributor", + "type": "SoftLayer_Brand", + "form": "relational" + }, + "distributorChildFlag": { + "name": "distributorChildFlag", + "type": "boolean", + "form": "relational" + }, + "distributorFlag": { + "name": "distributorFlag", + "type": "string", + "form": "relational" + }, + "hardware": { + "name": "hardware", + "type": "SoftLayer_Hardware", + "form": "relational", + "typeArray": true, + "doc": "An account's associated hardware objects." + }, + "hasAgentAdvancedSupportFlag": { + "name": "hasAgentAdvancedSupportFlag", + "type": "boolean", + "form": "relational" + }, + "hasAgentSupportFlag": { + "name": "hasAgentSupportFlag", + "type": "boolean", + "form": "relational" + }, + "openTickets": { + "name": "openTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true + }, + "ownedAccounts": { + "name": "ownedAccounts", + "type": "SoftLayer_Account", + "form": "relational", + "typeArray": true, + "doc": "Active accounts owned by the brand." + }, + "securityLevel": { + "name": "securityLevel", + "type": "SoftLayer_Security_Level", + "form": "relational" + }, + "ticketGroups": { + "name": "ticketGroups", + "type": "SoftLayer_Ticket_Group", + "form": "relational", + "typeArray": true + }, + "tickets": { + "name": "tickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true + }, + "users": { + "name": "users", + "type": "SoftLayer_User_Customer", + "form": "relational", + "typeArray": true + }, + "virtualGuests": { + "name": "virtualGuests", + "type": "SoftLayer_Virtual_Guest", + "form": "relational", + "typeArray": true, + "doc": "An account's associated virtual guest objects." + }, + "catalogId": { + "name": "catalogId", + "type": "int", + "form": "local", + "doc": "ID of the Catalog used by this Brand" + }, + "id": { + "name": "id", + "type": "int", + "form": "local" + }, + "keyName": { + "name": "keyName", + "type": "string", + "form": "local", + "doc": "The brand key name." + }, + "longName": { + "name": "longName", + "type": "string", + "form": "local", + "doc": "The brand long name." + }, + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The brand name." + }, + "allOwnedAccountCount": { + "name": "allOwnedAccountCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all accounts owned by the brand." + }, + "billingItemSnapshotCount": { + "name": "billingItemSnapshotCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of returns snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. The downside is, they are not real time, and do not share relational parity with the original billing item." + }, + "contactCount": { + "name": "contactCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the contacts for the brand." + }, + "customerCountryLocationRestrictionCount": { + "name": "customerCountryLocationRestrictionCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of this references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain." + }, + "hardwareCount": { + "name": "hardwareCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated hardware objects." + }, + "openTicketCount": { + "name": "openTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "ownedAccountCount": { + "name": "ownedAccountCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of active accounts owned by the brand." + }, + "ticketCount": { + "name": "ticketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "ticketGroupCount": { + "name": "ticketGroupCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "userCount": { + "name": "userCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " + }, + "virtualGuestCount": { + "name": "virtualGuestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated virtual guest objects." + } + } + }, + "SoftLayer_Brand_Attribute": { + "name": "SoftLayer_Brand_Attribute", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "brand": { + "name": "brand", + "type": "SoftLayer_Brand", + "form": "relational" + } + }, + "methods": {} + }, + "SoftLayer_Brand_Business_Partner": { + "name": "SoftLayer_Brand_Business_Partner", + "base": "SoftLayer_Entity", + "methods": { + "getObject": { + "name": "getObject", + "type": "SoftLayer_Brand_Business_Partner", + "docOverview": "Retrieve a SoftLayer_Brand_Business_Partner record.", + "filterable": true, + "maskable": true + }, + "getBrand": { + "doc": "Brand associated with the business partner data", + "docOverview": "", + "name": "getBrand", + "type": "SoftLayer_Brand", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getChannel": { + "doc": "Channel indicator used to categorize business partner revenue.", + "docOverview": "", + "name": "getChannel", + "type": "SoftLayer_Business_Partner_Channel", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getSegment": { + "doc": "Segment indicator used to categorize business partner revenue.", + "docOverview": "", + "name": "getSegment", + "type": "SoftLayer_Business_Partner_Segment", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + } + }, + "typeDoc": "Contains business partner details associated with a brand. Country Enterprise Identifier (CEID), Channel ID, Segment ID and Reseller Level. ", + "properties": { + "brand": { + "name": "brand", + "type": "SoftLayer_Brand", + "form": "relational", + "doc": "Brand associated with the business partner data" + }, + "channel": { + "name": "channel", + "type": "SoftLayer_Business_Partner_Channel", + "form": "relational", + "doc": "Channel indicator used to categorize business partner revenue." + }, + "segment": { + "name": "segment", + "type": "SoftLayer_Business_Partner_Segment", + "form": "relational", + "doc": "Segment indicator used to categorize business partner revenue." + }, + "channelId": { + "name": "channelId", + "type": "int", + "form": "local", + "doc": "Brand business partner channel identifier " + }, + "countryEnterpriseCode": { + "name": "countryEnterpriseCode", + "type": "string", + "form": "local", + "doc": "Brand business partner country enterprise code " + }, + "resellerLevel": { + "name": "resellerLevel", + "type": "int", + "form": "local", + "doc": "Reseller level of a brand business partner " + }, + "segmentId": { + "name": "segmentId", + "type": "int", + "form": "local", + "doc": "Brand business partner segment identifier " + } + } + }, + "SoftLayer_Brand_Contact": { + "name": "SoftLayer_Brand_Contact", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "SoftLayer_Brand_Contact contains the contact information for the brand such as Corporate or Support contact information ", + "properties": { + "brand": { + "name": "brand", + "type": "SoftLayer_Brand", + "form": "relational" + }, + "brandContactType": { + "name": "brandContactType", + "type": "SoftLayer_Brand_Contact_Type", + "form": "relational" + }, + "address1": { + "name": "address1", + "type": "string", + "form": "local", + "doc": "The contact's address 1." + }, + "address2": { + "name": "address2", + "type": "string", + "form": "local", + "doc": "The contact's address 2." + }, + "alternatePhone": { + "name": "alternatePhone", + "type": "string", + "form": "local", + "doc": "The contact's alternate phone number." + }, + "brandContactTypeId": { + "name": "brandContactTypeId", + "type": "int", + "form": "local", + "doc": "The contact's type identifier." + }, + "city": { + "name": "city", + "type": "string", + "form": "local", + "doc": "The contact's city." + }, + "country": { + "name": "country", + "type": "string", + "form": "local", + "doc": "The contact's country." + }, + "email": { + "name": "email", + "type": "string", + "form": "local", + "doc": "The contact's email address." + }, + "faxPhone": { + "name": "faxPhone", + "type": "string", + "form": "local", + "doc": "The contact's fax number." + }, + "firstName": { + "name": "firstName", + "type": "string", + "form": "local", + "doc": "The contact's first name." + }, + "lastName": { + "name": "lastName", + "type": "string", + "form": "local", + "doc": "The contact's last name." + }, + "officePhone": { + "name": "officePhone", + "type": "string", + "form": "local", + "doc": "The contact's phone number." + }, + "postalCode": { + "name": "postalCode", + "type": "string", + "form": "local", + "doc": "The contact's postal code." + }, + "state": { + "name": "state", + "type": "string", + "form": "local", + "doc": "The contact's state." + } + }, + "methods": {} + }, + "SoftLayer_Brand_Contact_Type": { + "name": "SoftLayer_Brand_Contact_Type", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "SoftLayer_Brand_Contact_Type contains the contact type information for the brand contacts such as Corporate or Support contact type ", + "properties": { + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "Contact type description." + }, + "keyName": { + "name": "keyName", + "type": "string", + "form": "local", + "doc": "Contact type key name." + }, + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "Contact type name." + } + }, + "methods": {} + }, + "SoftLayer_Brand_Payment_Processor": { + "name": "SoftLayer_Brand_Payment_Processor", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "brand": { + "name": "brand", + "type": "SoftLayer_Brand", + "form": "relational" + }, + "paymentProcessor": { + "name": "paymentProcessor", + "type": "SoftLayer_Billing_Payment_Processor", + "form": "relational" + } + }, + "methods": {} + }, + "SoftLayer_Brand_Restriction_Location_CustomerCountry": { + "name": "SoftLayer_Brand_Restriction_Location_CustomerCountry", + "base": "SoftLayer_Entity", + "serviceDoc": "The [SoftLayer_Brand_Restriction_Location_CustomerCountry](/reference/datatypes/SoftLayer_Brand_Restriction_Location_CustomerCountry) service defines the relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on the SoftLayer US brand for customers that live in Great Britain. ", + "methods": { + "getAllObjects": { + "name": "getAllObjects", + "type": "SoftLayer_Brand_Restriction_Location_CustomerCountry", + "typeArray": true, + "static": true, + "limitable": true, + "filterable": true, + "maskable": true + }, + "getObject": { + "name": "getObject", + "type": "SoftLayer_Brand_Restriction_Location_CustomerCountry", + "docOverview": "Retrieve a SoftLayer_Brand_Restriction_Location_CustomerCountry record.", + "filterable": true, + "maskable": true + }, + "getBrand": { + "doc": "This references the brand that has a brand-location-country restriction setup.", + "docOverview": "", + "name": "getBrand", + "type": "SoftLayer_Brand", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + }, + "getLocation": { + "doc": "This references the datacenter that has a brand-location-country restriction setup. For example, if a datacenter is listed with a restriction for Canada, a Canadian customer may not be eligible to order services at that location.", + "docOverview": "", + "name": "getLocation", + "type": "SoftLayer_Location", + "typeArray": null, + "ormMethod": true, + "maskable": true, + "filterable": true, + "deprecated": false + } + }, + "typeDoc": "The [SoftLayer_Brand_Restriction_Location_CustomerCountry](/reference/datatypes/SoftLayer_Brand_Restriction_Location_CustomerCountry) data type defines the relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on the SoftLayer US brand for customers that live in Great Britain. ", + "properties": { + "brand": { + "name": "brand", + "type": "SoftLayer_Brand", + "form": "relational", + "doc": "This references the brand that has a brand-location-country restriction setup." + }, + "location": { + "name": "location", + "type": "SoftLayer_Location", + "form": "relational", + "doc": "This references the datacenter that has a brand-location-country restriction setup. For example, if a datacenter is listed with a restriction for Canada, a Canadian customer may not be eligible to order services at that location." + }, + "brandId": { + "name": "brandId", + "type": "int", + "form": "local", + "doc": "The brand associated with customer's account." + }, + "customerCountryCode": { + "name": "customerCountryCode", + "type": "string", + "form": "local", + "doc": "country code associated with customer's account." + }, + "locationId": { + "name": "locationId", + "type": "int", + "form": "local", + "doc": "The id for datacenter location." + } + } + }, + "SoftLayer_Business_Partner_Channel": { + "name": "SoftLayer_Business_Partner_Channel", + "base": "SoftLayer_Entity", + "methods": { + "getObject": { + "name": "getObject", + "type": "SoftLayer_Business_Partner_Channel", + "docOverview": "Retrieve a SoftLayer_Business_Partner_Channel record.", + "filterable": true, + "maskable": true + } + }, + "typeDoc": "Contains business partner channel information ", + "properties": { + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "Business partner channel description " + }, + "keyName": { + "name": "keyName", + "type": "string", + "form": "local", + "doc": "Business partner channel name " + } + } + }, + "SoftLayer_Business_Partner_Segment": { + "name": "SoftLayer_Business_Partner_Segment", + "base": "SoftLayer_Entity", + "methods": { + "getObject": { + "name": "getObject", + "type": "SoftLayer_Business_Partner_Segment", + "docOverview": "Retrieve a SoftLayer_Business_Partner_Segment record.", + "filterable": true, + "maskable": true + } + }, + "typeDoc": "Contains business partner segment information ", + "properties": { + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "Business partner segment description " + }, + "keyName": { + "name": "keyName", + "type": "string", + "form": "local", + "doc": "Business partner segment name " + } + } + }, + "SoftLayer_Catalyst_Affiliate": { + "name": "SoftLayer_Catalyst_Affiliate", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "id": { + "name": "id", + "type": "int", + "form": "local" + }, + "name": { + "name": "name", + "type": "string", + "form": "local" + }, + "skipCreditCardVerificationFlag": { + "name": "skipCreditCardVerificationFlag", + "type": "boolean", + "form": "local" + } + }, + "methods": {} + }, + "SoftLayer_Catalyst_Company_Type": { + "name": "SoftLayer_Catalyst_Company_Type", + "base": "SoftLayer_Entity", + "methods": { + "getAllObjects": { + "name": "getAllObjects", + "type": "SoftLayer_Catalyst_Company_Type", + "typeArray": true, + "doc": "<<, , (comma), ; (semicolon), , (comma and space), or ; (semicolon and space). " + }, + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "The description of modify response header. " + }, + "headers": { + "name": "headers", + "type": "string", + "form": "local", + "typeArray": true, + "doc": "A collection of key value pairs that specify the headers and associated values to be modified. The header name and header value must be separated by colon (:). Example: ['header1:value1','header2:Value2'] " + }, + "modResHeaderUniqueId": { + "name": "modResHeaderUniqueId", + "type": "string", + "form": "local", + "doc": "The uniqueId of the modify response header to which the existing behavior belongs. " + }, + "path": { + "name": "path", + "type": "string", + "form": "local", + "doc": "The path, relative to the domain that is accessed via modify response header. " + }, + "type": { + "name": "type", + "type": "string", + "form": "local", + "doc": "The type of the modify response header, could be append/modify/delete. Set this to append to add a given header value to a header name set in the headerList. Set this to delete to remove a given header value from a header name set in the headerList. Set this to overwrite to match on a specified header name and replace its existing header value with a new one you specify. " + }, + "uniqueId": { + "name": "uniqueId", + "type": "string", + "form": "local", + "doc": "The uniqueId of the mapping to which the existing behavior belongs. " + } + }, + "methods": {} + }, + "SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth": { + "name": "SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth data type contains information for specific responses from the Token Authentication API. ", + "properties": { + "aclDelimiter": { + "name": "aclDelimiter", + "type": "string", + "form": "local", + "doc": "Specifies a single character to separate access control list (ACL) fields. The default value is '!'. " + }, + "escapeTokenInputs": { + "name": "escapeTokenInputs", + "type": "string", + "form": "local", + "doc": "Possible values '0' and '1'. If set to '1', input values are escaped before adding them to the token. Default value is '1'. " + }, + "hmacAlgorithm": { + "name": "hmacAlgorithm", + "type": "string", + "form": "local", + "doc": "Specifies the algorithm to use for the token's hash-based message authentication code (HMAC) field. Valid entries are 'SHA256', 'SHA1', or 'MD5'. The default value is 'SHA256'. " + }, + "ignoreQueryString": { + "name": "ignoreQueryString", + "type": "string", + "form": "local", + "doc": "Possible values '0' and '1'. If set to '1', query strings are removed from a URL when computing the token's HMAC algorithm. Default value is '0'. " + }, + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The token name. If this value is empty, then it is set to the default value '__token__'. " + }, + "path": { + "name": "path", + "type": "string", + "form": "local", + "doc": "The path, relative to the domain that is accessed via token authentication. " + }, + "tokenDelimiter": { + "name": "tokenDelimiter", + "type": "string", + "form": "local", + "doc": "Specifies a single character to separate the individual token fields. The default value is '~'. " + }, + "tokenKey": { + "name": "tokenKey", + "type": "string", + "form": "local", + "doc": "The token encryption key, which specifies an even number of hex digits for the token key. An entry can be up to 64 characters in length. " + }, + "transitionKey": { + "name": "transitionKey", + "type": "string", + "form": "local", + "doc": "The token transition key, which specifies an even number of hex digits for the token transition key. An entry can be up to 64 characters in length. " + }, + "uniqueId": { + "name": "uniqueId", + "type": "string", + "form": "local", + "doc": "The uniqueId of the mapping to which the existing behavior belongs. " + } + }, + "methods": {} + }, + "SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge": { + "name": "SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "date": { + "name": "date", + "type": "string", + "form": "local" + }, + "path": { + "name": "path", + "type": "string", + "form": "local" + }, + "saved": { + "name": "saved", + "type": "string", + "form": "local" + }, + "status": { + "name": "status", + "type": "string", + "form": "local" + } + }, + "methods": {} + }, + "SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup": { + "name": "SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup data type contains information for specific responses from the Purge Group API. Each of the Purge Group APIs returns a collection of this type ", + "properties": { + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "Date in which record is created " + }, + "groupUniqueId": { + "name": "groupUniqueId", + "type": "string", + "form": "local", + "doc": "A identifier that is unique to purge group. " + }, + "lastPurgeDate": { + "name": "lastPurgeDate", + "type": "dateTime", + "form": "local", + "doc": "The Unix timestamp of the last purge. " + }, + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "Purge Group name. The favorite group name must be unique, but non-favorite groups do not have this limitation " + }, + "option": { + "name": "option", + "type": "int", + "form": "local", + "doc": "The following options are available to create a Purge Group: option 1: only purge the paths in the group, but don't save as favorite. option 2: only save the purge group as favorite, but don't purge paths. option 3: save the purge group as favorite and also purge paths. " + }, + "pathCount": { + "name": "pathCount", + "type": "int", + "form": "local", + "doc": "Total number of purge paths. " + }, + "paths": { + "name": "paths", + "type": "string", + "form": "local", + "typeArray": true, + "doc": "A collection of purge paths. " + }, + "purgeStatus": { + "name": "purgeStatus", + "type": "string", + "form": "local", + "doc": "The purge's status when the input option field is 1 or 3. Status can be SUCCESS, FAILED, or IN_PROGRESS. " + }, + "saved": { + "name": "saved", + "type": "string", + "form": "local", + "doc": "Type of the Purge Group, currently SAVED or UNSAVED. " + }, + "uniqueId": { + "name": "uniqueId", + "type": "string", + "form": "local", + "doc": "A identifier that is unique to domain mapping. " + } + }, + "methods": {} + }, + "SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory": { + "name": "SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory", + "base": "SoftLayer_Entity", + "noservice": true, + "typeDoc": "The SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory data type contains information for specific responses from the Purge Group API and Purge History API. ", + "properties": { + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "Date in which record is created " + }, + "groupName": { + "name": "groupName", + "type": "string", + "form": "local", + "doc": "Purge Group name. The favorite group name must be unique, but un-favorite groups do not have this limitation " + }, + "groupUniqueId": { + "name": "groupUniqueId", + "type": "string", + "form": "local", + "doc": "Purge group unique ID " + }, + "status": { + "name": "status", + "type": "string", + "form": "local", + "doc": "The purge's status. Status can be SUCCESS, FAILED, or IN_PROGRESS. " + }, + "uniqueId": { + "name": "uniqueId", + "type": "string", + "form": "local", + "doc": "Domain mapping unique ID. " + } + }, + "methods": {} + }, + "SoftLayer_Container_Network_CdnMarketplace_Configuration_Input": { + "name": "SoftLayer_Container_Network_CdnMarketplace_Configuration_Input", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "bucketName": { + "name": "bucketName", + "type": "string", + "form": "local" + }, + "cacheKeyQueryRule": { + "name": "cacheKeyQueryRule", + "type": "string", + "form": "local" + }, + "certificateType": { + "name": "certificateType", + "type": "string", + "form": "local" + }, + "cname": { + "name": "cname", + "type": "string", + "form": "local" + }, + "domain": { + "name": "domain", + "type": "string", + "form": "local" + }, + "dynamicContentAcceleration": { + "name": "dynamicContentAcceleration", + "type": "SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration", + "form": "local" + }, + "fileExtension": { + "name": "fileExtension", + "type": "string", + "form": "local" + }, + "geoblockingRule": { + "name": "geoblockingRule", + "type": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking", + "form": "local" + }, + "header": { + "name": "header", + "type": "string", + "form": "local" + }, + "hotlinkProtection": { + "name": "hotlinkProtection", + "type": "SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection", + "form": "local" + }, + "httpPort": { + "name": "httpPort", + "type": "int", + "form": "local" + }, + "httpsPort": { + "name": "httpsPort", + "type": "int", + "form": "local" + }, + "oldPath": { + "name": "oldPath", + "type": "string", + "form": "local", + "doc": "Used by the following method: updateOriginPath(). This property will store the path of the path record to be saved. The $path attribute stores the new path. " + }, + "origin": { + "name": "origin", + "type": "string", + "form": "local" + }, + "originType": { + "name": "originType", + "type": "string", + "form": "local" + }, + "path": { + "name": "path", + "type": "string", + "form": "local" + }, + "performanceConfiguration": { + "name": "performanceConfiguration", + "type": "string", + "form": "local" + }, + "protocol": { + "name": "protocol", + "type": "string", + "form": "local" + }, + "respectHeaders": { + "name": "respectHeaders", + "type": "string", + "form": "local" + }, + "serveStale": { + "name": "serveStale", + "type": "string", + "form": "local" + }, + "status": { + "name": "status", + "type": "string", + "form": "local" + }, + "uniqueId": { + "name": "uniqueId", + "type": "string", + "form": "local" + }, + "vendorName": { + "name": "vendorName", + "type": "string", + "form": "local" + } + }, + "methods": {} + }, + "SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping": { + "name": "SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "akamaiCname": { + "name": "akamaiCname", + "type": "string", + "form": "local" + }, + "bucketName": { + "name": "bucketName", + "type": "string", + "form": "local" + }, + "cacheKeyQueryRule": { + "name": "cacheKeyQueryRule", + "type": "string", + "form": "local" + }, + "certificateType": { + "name": "certificateType", + "type": "string", + "form": "local" + }, + "cname": { + "name": "cname", + "type": "string", + "form": "local" + }, + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local" + }, + "domain": { + "name": "domain", + "type": "string", + "form": "local" + }, + "dynamicContentAcceleration": { + "name": "dynamicContentAcceleration", + "type": "SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration", + "form": "local" + }, + "fileExtension": { + "name": "fileExtension", + "type": "string", + "form": "local" + }, + "header": { + "name": "header", + "type": "string", + "form": "local" + }, + "httpPort": { + "name": "httpPort", + "type": "int", + "form": "local" + }, + "httpsChallengeRedirectUrl": { + "name": "httpsChallengeRedirectUrl", + "type": "string", + "form": "local" + }, + "httpsChallengeResponse": { + "name": "httpsChallengeResponse", + "type": "string", + "form": "local" + }, + "httpsChallengeUrl": { + "name": "httpsChallengeUrl", + "type": "string", + "form": "local" + }, + "httpsPort": { + "name": "httpsPort", + "type": "int", + "form": "local" + }, + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", + "form": "local" + }, + "originHost": { + "name": "originHost", + "type": "string", + "form": "local" + }, + "originType": { + "name": "originType", + "type": "string", + "form": "local" + }, + "path": { + "name": "path", + "type": "string", + "form": "local" + }, + "performanceConfiguration": { + "name": "performanceConfiguration", + "type": "string", + "form": "local" + }, + "protocol": { + "name": "protocol", + "type": "string", + "form": "local" + }, + "respectHeaders": { + "name": "respectHeaders", + "type": "boolean", + "form": "local" + }, + "serveStale": { + "name": "serveStale", + "type": "boolean", + "form": "local" + }, + "status": { + "name": "status", + "type": "string", + "form": "local" + }, + "uniqueId": { + "name": "uniqueId", + "type": "string", + "form": "local" + }, + "vendorName": { + "name": "vendorName", + "type": "string", + "form": "local" + } + }, + "methods": {} + }, + "SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path": { + "name": "SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "bucketName": { + "name": "bucketName", + "type": "string", + "form": "local" + }, + "cacheKeyQueryRule": { + "name": "cacheKeyQueryRule", + "type": "string", + "form": "local" + }, + "dynamicContentAcceleration": { + "name": "dynamicContentAcceleration", + "type": "SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration", + "form": "local" + }, + "fileExtension": { + "name": "fileExtension", + "type": "string", + "form": "local" + }, + "header": { + "name": "header", + "type": "string", + "form": "local" + }, + "httpPort": { + "name": "httpPort", + "type": "int", + "form": "local" + }, + "httpsPort": { + "name": "httpsPort", + "type": "int", + "form": "local" + }, + "mappingUniqueId": { + "name": "mappingUniqueId", + "type": "string", + "form": "local" + }, + "origin": { + "name": "origin", + "type": "string", + "form": "local" + }, + "originType": { + "name": "originType", + "type": "string", + "form": "local" + }, + "path": { + "name": "path", + "type": "string", + "form": "local" + }, + "performanceConfiguration": { + "name": "performanceConfiguration", + "type": "string", + "form": "local" + }, + "status": { + "name": "status", + "type": "string", + "form": "local" + } + }, + "methods": {} + }, + "SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration": { + "name": "SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration", + "base": "SoftLayer_Entity", + "noservice": true, + "properties": { + "detectionPath": { + "name": "detectionPath", + "type": "string", + "form": "local", + "doc": "The detectionPath is used by CDN edge servers to find the best optimized route from edge to the origin server. The Akamai edge servers fetch the test object from the origin to know the network condition to your origin server, and then calculate the best optimized route with the network condition. The best path to origin must be known at the time a user\u2019s request arrives at an edge server, since any in-line analysis or probing would defeat the purpose of speeding things up. " + }, + "mobileImageCompressionEnabled": { + "name": "mobileImageCompressionEnabled", + "type": "boolean", + "form": "local", + "doc": "Serving compressed images reduces the amount of content required to load a page. This feature helps offset less robust connections, such as those formed with mobile devices. Basically, if your site visitors have slow network speeds, MobileImageCompression technology can automatically increase compression of JPEG images to speed up loading. On the other hand, this feature results in lossy compression or irreversible compression, and may affect the quality of the images on your site. \n\nJPG supported file extensions: .jpg, .jpeg, .jpe, .jig, .jgig, .jgi The default is enabled. " + }, + "prefetchEnabled": { + "name": "prefetchEnabled", + "type": "boolean", + "form": "local", + "doc": "Inspects HTML responses and prefetches embedded objects in HTML files. Prefetching works on any page that includes ,