From 20e3aac17db1fe79b0c06c68359eb67e033e4939 Mon Sep 17 00:00:00 2001 From: Christopher Gallo Date: Fri, 18 Jul 2025 11:42:08 -0500 Subject: [PATCH] 20250718 release notes --- ...iguration_Behavior_ModifyResponseHeader.md | 2 +- ...tplace_Configuration_Behavior_TokenAuth.md | 2 +- ...dnMarketplace_Configuration_Cache_Purge.md | 2 +- ...ketplace_Configuration_Cache_PurgeGroup.md | 2 +- ...e_Configuration_Cache_PurgeGroupHistory.md | 2 +- ...nMarketplace_Configuration_Mapping_Path.md | 2 +- .../getDetailsForDateRange.md | 20 - .../getSummary.md | 20 - .../verifyCdnAccountExists.md | 2 +- .../createModifyResponseHeader.md | 2 +- .../deleteModifyResponseHeader.md | 2 +- .../listModifyResponseHeader.md | 2 +- .../updateModifyResponseHeader.md | 2 +- .../createTokenAuthPath.md | 2 +- .../deleteTokenAuthPath.md | 2 +- .../listTokenAuthPath.md | 2 +- .../updateTokenAuthPath.md | 2 +- .../createPurge.md | 2 +- .../getPurgeHistoryPerMapping.md | 2 +- .../getPurgeStatus.md | 2 +- .../saveOrUnsavePurgePath.md | 2 +- .../createPurgeGroup.md | 2 +- .../getPurgeGroupByGroupId.md | 2 +- .../getPurgeGroupQuota.md | 2 +- .../listFavoriteGroup.md | 2 +- .../listUnfavoriteGroup.md | 2 +- .../purgeByGroupIds.md | 2 +- .../removePurgeGroupFromFavorite.md | 2 +- .../savePurgeGroupAsFavorite.md | 2 +- .../listPurgeGroupHistory.md | 2 +- .../createTimeToLive.md | 2 +- .../updateTimeToLive.md | 2 +- .../createDomainMapping.md | 2 +- .../deleteDomainMapping.md | 2 +- .../listDomainMappingByUniqueId.md | 2 +- .../listDomainMappings.md | 2 +- .../retryHttpsActionRequest.md | 2 +- .../startDomainMapping.md | 2 +- .../stopDomainMapping.md | 2 +- .../updateDomainMapping.md | 4 +- .../verifyCname.md | 2 +- .../verifyDomainMapping.md | 2 +- .../createOriginPath.md | 2 +- .../deleteOriginPath.md | 2 +- .../listOriginPath.md | 2 +- .../updateOriginPath.md | 6 +- .../getCustomerInvoicingMetrics.md | 2 +- .../getCustomerRealTimeMetrics.md | 2 +- .../getCustomerUsageMetrics.md | 2 +- .../getMappingBandwidthByRegionMetrics.md | 2 +- .../getMappingBandwidthMetrics.md | 2 +- .../getMappingHitsByTypeMetrics.md | 2 +- .../getMappingHitsMetrics.md | 2 +- .../getMappingIntegratedMetrics.md | 2 +- .../getMappingRealTimeMetrics.md | 2 +- .../getMappingUsageMetrics.md | 2 +- .../listVendors.md | 2 +- content/release_notes/2025/20250718.md | 16 + data/sldn_metadata.json | 119280 +++++---------- 59 files changed, 35310 insertions(+), 84142 deletions(-) delete mode 100644 content/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange.md delete mode 100644 content/reference/services/SoftLayer_Metric_Tracking_Object/getSummary.md create mode 100644 content/release_notes/2025/20250718.md diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader.md index ffc8df5d9d..8724de0fd5 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader.md @@ -1,6 +1,6 @@ --- title: "SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader" -description: "The SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader data type contains information for specific responses from the modify response header API. " +description: "DEPRECATED " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth.md index e8e104bb89..f65c3bbfa3 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth.md @@ -1,6 +1,6 @@ --- title: "SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth" -description: "The SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth data type contains information for specific responses from the Token Authentication API. " +description: "DEPRECATED " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge.md index 27b6df673d..1e35651b01 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge.md @@ -1,6 +1,6 @@ --- title: "SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge" -description: "" +description: "DEPRECATED " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup.md index fd7c6acb46..7a50e97122 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup.md @@ -1,6 +1,6 @@ --- title: "SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup" -description: "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 " +description: "DEPRECATED " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory.md index 50a1c0b1e9..bd48b23542 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory.md @@ -1,6 +1,6 @@ --- title: "SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory" -description: "The SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory data type contains information for specific responses from the Purge Group API and Purge History API. " +description: "DEPRECATED " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path.md b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path.md index 467a4378b1..defef9eff1 100644 --- a/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path.md +++ b/content/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path.md @@ -1,6 +1,6 @@ --- title: "SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path" -description: "" +description: "DEPRECATED " date: "2018-02-12" tags: - "datatype" diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange.md deleted file mode 100644 index 2699928dda..0000000000 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getDetailsForDateRange" -description: "Retrieve a collection of detailed metric data over a date range. Ideal if you want to employ your own graphing systems. Note not all metrics support this method. Those that do not return null. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Metric" -classes: - - "SoftLayer_Metric_Tracking_Object" -type: "reference" -layout: "method" -mainService : "SoftLayer_Metric_Tracking_Object" ---- - -### [REST Example](#getDetailsForDateRange-example) {#getDetailsForDateRange-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime, string]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getDetailsForDateRange' -``` diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getSummary.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getSummary.md deleted file mode 100644 index 6fb6d3b42a..0000000000 --- a/content/reference/services/SoftLayer_Metric_Tracking_Object/getSummary.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "getSummary" -description: "Retrieve a metric summary. Ideal if you want to employ your own graphing systems. Note not all metric types contain a summary. These return null. " -date: "2018-02-12" -tags: - - "method" - - "sldn" - - "Metric" -classes: - - "SoftLayer_Metric_Tracking_Object" -type: "reference" -layout: "method" -mainService : "SoftLayer_Metric_Tracking_Object" ---- - -### [REST Example](#getSummary-example) {#getSummary-example .anchor-link} -```bash -curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \ -'https://api.softlayer.com/rest/v3.1/SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getSummary' -``` diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists.md index fae24e8c9c..62b4c66440 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists.md @@ -1,6 +1,6 @@ --- title: "verifyCdnAccountExists" -description: "Wrapper for UI to verify whether or not an account exists for user under specified vendor. Returns true if account exists, else false. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader.md index 22b2d4c9ac..7a3adffc64 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader.md @@ -1,6 +1,6 @@ --- title: "createModifyResponseHeader" -description: "SOAP API will create modify response header for an existing CDN mapping and for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader.md index 87e1ee44ca..e0eca12306 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader.md @@ -1,6 +1,6 @@ --- title: "deleteModifyResponseHeader" -description: "SOAP API will delete modify response header for an existing mapping and for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader.md index 363e0436f0..b8bba42a19 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader.md @@ -1,6 +1,6 @@ --- title: "listModifyResponseHeader" -description: "SOAP API will list modify response headers for an existing mapping and for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader.md index fc3d3bf8da..08bd3efe6f 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader.md @@ -1,6 +1,6 @@ --- title: "updateModifyResponseHeader" -description: "SOAP API will update modify response header for an existing mapping and for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath.md index f9b4cd6cfb..d270ce8dec 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath.md @@ -1,6 +1,6 @@ --- title: "createTokenAuthPath" -description: "SOAP API will create Token authentication Path for an existing CDN mapping and for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath.md index 7e5e56a093..43e2fef62d 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath.md @@ -1,6 +1,6 @@ --- title: "deleteTokenAuthPath" -description: "SOAP API will delete token authentication Path for an existing mapping and for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath.md index a1f23be42b..39538f1108 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath.md @@ -1,6 +1,6 @@ --- title: "listTokenAuthPath" -description: "SOAP API will list token authentication paths for an existing mapping and for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath.md index 477ffeb32c..ceb1dcf413 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath.md @@ -1,6 +1,6 @@ --- title: "updateTokenAuthPath" -description: "SOAP API will update Token authentication Path for an existing mapping and for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge.md index 063d6a5e5b..bb3a97d8d8 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge.md @@ -1,6 +1,6 @@ --- title: "createPurge" -description: "This method creates a purge record in the purge table, and also initiates the create purge call. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping.md index e3374ffa93..9a7d19c1b1 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping.md @@ -1,6 +1,6 @@ --- title: "getPurgeHistoryPerMapping" -description: "This method returns the purge history for a given domain and CDN account. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus.md index 5bb98e62bd..6883adcf6c 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus.md @@ -1,6 +1,6 @@ --- title: "getPurgeStatus" -description: "This method gets the status of a given purge path. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath.md index 42b4df1d61..2368dafa9c 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath.md @@ -1,6 +1,6 @@ --- title: "saveOrUnsavePurgePath" -description: "Creates a new saved purge if a purge path is saved. Deletes a saved purge record if the path is unsaved. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup.md index be3577bd35..bcd724fcce 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup.md @@ -1,6 +1,6 @@ --- title: "createPurgeGroup" -description: "This method creates a purge group record in the table, and also initiates the purge action based on the input option value. The unsaved groups will be deleted after 15 days if no purge actions executed. The possible input option value can be: 1: (Default) Only purge the paths in the group, don't save the group as favorite. 2: Only save the group as favorite, don't purge the paths. 3: Save the group as favorite and also purge the paths in the group. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId.md index f844dbab00..01d06b7872 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId.md @@ -1,6 +1,6 @@ --- title: "getPurgeGroupByGroupId" -description: "This method returns the purge group for a given domain and group ID. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota.md index 54777f663a..2a9770d6a2 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota.md @@ -1,6 +1,6 @@ --- title: "getPurgeGroupQuota" -description: "This method gets a purge group quota. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup.md index 52f965edab..3e4613492b 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup.md @@ -1,6 +1,6 @@ --- title: "listFavoriteGroup" -description: "This method returns the list of favorite purge groups. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup.md index 0b69c5fa0e..bf43862521 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup.md @@ -1,6 +1,6 @@ --- title: "listUnfavoriteGroup" -description: "This method returns the list of unsaved purge groups. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds.md index 7447b3d9eb..cb52b3fb69 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds.md @@ -1,6 +1,6 @@ --- title: "purgeByGroupIds" -description: "This method purges the content from purge groups. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite.md index 860b9b098e..f27e417bc0 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite.md @@ -1,6 +1,6 @@ --- title: "removePurgeGroupFromFavorite" -description: "This method removes a purge group from favorite. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite.md index 5ca6accd91..556530105f 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite.md @@ -1,6 +1,6 @@ --- title: "savePurgeGroupAsFavorite" -description: "This method saves a purge group as favorite. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory.md index 7e190c970a..31521a968e 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory.md @@ -1,6 +1,6 @@ --- title: "listPurgeGroupHistory" -description: "This method returns the list of purge group histories " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive.md index b36fc13d03..adfc95f76c 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive.md @@ -1,6 +1,6 @@ --- title: "createTimeToLive" -description: "Creates a Time To Live object and inserts it into the database " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive.md index 2e33021261..10e060a324 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive.md @@ -1,6 +1,6 @@ --- title: "updateTimeToLive" -description: "Updates an existing Time To Live object. If the old and new inputs are equal, exits early. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping.md index 7cebeec032..d04eade2fe 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping.md @@ -1,6 +1,6 @@ --- title: "createDomainMapping" -description: "SOAP API will create a new CDN domain mapping for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping.md index bd1c22d421..b7613549a4 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping.md @@ -1,6 +1,6 @@ --- title: "deleteDomainMapping" -description: "SOAP API will delete CDN domain mapping for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId.md index 4bfb3a8eda..4ff7075b13 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId.md @@ -1,6 +1,6 @@ --- title: "listDomainMappingByUniqueId" -description: "SOAP API will return the domain mapping based on the uniqueId. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings.md index d476128ade..f7aef292a9 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings.md @@ -1,6 +1,6 @@ --- title: "listDomainMappings" -description: "SOAP API will return all domains for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest.md index 28bcd1f9e3..603dc8547d 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest.md @@ -1,6 +1,6 @@ --- title: "retryHttpsActionRequest" -description: "For specific mappings in HTTPS-related error states, this SOAP API will determine whether it needs to re-attempt an enable or disable HTTPS. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping.md index 993fa673ac..3d5e16308f 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping.md @@ -1,6 +1,6 @@ --- title: "startDomainMapping" -description: "SOAP API will start CDN domain mapping for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping.md index 61aa1ba00a..77d6753420 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping.md @@ -1,6 +1,6 @@ --- title: "stopDomainMapping" -description: "SOAP API will stop CDN mapping for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping.md index 67f3f3c92d..4650d26b0b 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping.md @@ -1,8 +1,6 @@ --- title: "updateDomainMapping" -description: "SOAP API will update the Domain Mapping identified by the Unique Id. Following fields are allowed to be changed: originHost, HttpPort/HttpsPort, RespectHeaders, ServeStale - -Additionally, bucketName and fileExtension if OriginType is Object Store " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname.md index 70df0aa481..32446477e3 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname.md @@ -1,6 +1,6 @@ --- title: "verifyCname" -description: "Verifies the CNAME is Unique in the domain. The method will return true if CNAME is unique else returns false " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping.md index 7331a17517..70c91875c1 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping.md @@ -1,6 +1,6 @@ --- title: "verifyDomainMapping" -description: "Verifies the status of the domain mapping by calling the rest api; will update the status, cname, and vendorCName if necessary and will return the updated values. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath.md index 936098a651..18cbf69997 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath.md @@ -1,6 +1,6 @@ --- title: "createOriginPath" -description: "SOAP API will create Origin Path for an existing CDN mapping and for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath.md index 75e91e9b83..f17fc177ec 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath.md @@ -1,6 +1,6 @@ --- title: "deleteOriginPath" -description: "SOAP API will delete Origin Path for an existing mapping and for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath.md index fec697c395..01b9ac2a2b 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath.md @@ -1,6 +1,6 @@ --- title: "listOriginPath" -description: "SOAP API will list origin path for an existing mapping and for a particular customer. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath.md index 95f439761e..e749dec877 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath.md @@ -1,10 +1,6 @@ --- title: "updateOriginPath" -description: "SOAP API will update Origin Path for an existing mapping and for a particular customer. - -When passing the $input object as a parameter, it will expect the following properties to be set: $oldPath $uniqueId $originType, $path, $origin, $httpPort, $httpsPort, and if the path's origin type is object storage, the $bucketName and the $fileExtension. - -Out of the properties listed above only the following path properties are allowed to be changed: $path, $origin, $httpPort, $httpsPort These properties may not be changed: $originType " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics.md index 5dfc052fc5..efab8d54f3 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics.md @@ -1,6 +1,6 @@ --- title: "getCustomerInvoicingMetrics" -description: "Get the static & dynamic bandwidth and mapping hits of predetermined statistics for direct display (no graph) for a customer's account over a given period of time. Frequency can be 'day', 'aggregate'. If the value 'day' is specified for Frequency, return data will be ordered based on startDate to endDate, and if the value 'aggregate' is specified for Frequency, aggregated data from startDate to endDate will be returned. There is a delay within 3 days(including today) for fetching the metrics data. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics.md index a9983f5869..e6c412ea4c 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics.md @@ -1,6 +1,6 @@ --- title: "getCustomerRealTimeMetrics" -description: "Get the realtime metrics data for the current account. Takes the startTime and endTime and returns the total metrics data and line graph metrics data divided by the timeInterval. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics.md index 85e9a58006..d5465c46e1 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics.md @@ -1,6 +1,6 @@ --- title: "getCustomerUsageMetrics" -description: "Get the total number of predetermined statistics for direct display (no graph) for a customer's account over a given period of time " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics.md index 968c5d8e22..484f15930d 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics.md @@ -1,6 +1,6 @@ --- title: "getMappingBandwidthByRegionMetrics" -description: "Get the total number of predetermined statistics for direct display (no graph) for a customer's account over a given period of time " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics.md index f5447d10ea..95c200388e 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics.md @@ -1,6 +1,6 @@ --- title: "getMappingBandwidthMetrics" -description: "Get the amount of edge hits for an individual mapping. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics.md index 18d70f2d6b..1c826de054 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics.md @@ -1,6 +1,6 @@ --- title: "getMappingHitsByTypeMetrics" -description: "Get the total number of hits at a certain frequency over a given range of time. Frequency can be day, week, and month where each interval is one plot point for a graph. Return Data must be ordered based on startDate, endDate and frequency " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics.md index 77f9b4fadc..d71b7b8c41 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics.md @@ -1,6 +1,6 @@ --- title: "getMappingHitsMetrics" -description: "Get the total number of hits at a certain frequency over a given range of time per domain mapping. Frequency can be day, week, and month where each interval is one plot point for a graph. Return Data will be ordered based on startDate, endDate and frequency. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics.md index 6cb65b5c2d..af40f4cb83 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics.md @@ -1,6 +1,6 @@ --- title: "getMappingIntegratedMetrics" -description: "Get the integrated metrics data for the given mapping. You can get the the hits, bandwidth, hits by type and bandwidth by region. It will return both the total data and the detail data. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics.md index 7ce82a1156..80626844cf 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics.md @@ -1,6 +1,6 @@ --- title: "getMappingRealTimeMetrics" -description: "Get the real time metrics data for the given mapping " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics.md index 4a7c440ec8..03598108c5 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics.md @@ -1,6 +1,6 @@ --- title: "getMappingUsageMetrics" -description: "Get the total number of predetermined statistics for direct display for the given mapping " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors.md b/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors.md index e59936ec4f..b32a595d37 100644 --- a/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors.md +++ b/content/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors.md @@ -1,6 +1,6 @@ --- title: "listVendors" -description: "SOAP API will return all CDN vendors available. " +description: "DEPRECATED " date: "2018-02-12" tags: - "method" diff --git a/content/release_notes/2025/20250718.md b/content/release_notes/2025/20250718.md new file mode 100644 index 0000000000..4c57bf6724 --- /dev/null +++ b/content/release_notes/2025/20250718.md @@ -0,0 +1,16 @@ +--- +title: "Release notes: July 18, 2025" +date: "2025-07-18" +tags: + - "release notes" +--- + +#### API + +- Fix issue that prevented ordering from quotes that contained virtual router appliances.. Fix check for disallowing custom disk partitions SALES-14583 +- Deprecate Content Delivery Network. Drop Akamai CDN tables NETWORK-15023 +- Deprecate CDN Marketplace product. Deprecate CDN Marketplace product SALES-14587 +- Deprecate Content Delivery Network. Deprecate Content Delivery Network products NETWORK-15008 +- Update disk image label and description. Add better label to metadata and secondary disks VIRT-13255 +- Remove unused SLDN methods SoftLayer_Metric_Tracking_Object::getDetailsForDateRange and SoftLayer_Metric_Tracking_Object::getSummary. Remove unused virtual +host MTO method calls NETWORK-15010 \ No newline at end of file diff --git a/data/sldn_metadata.json b/data/sldn_metadata.json index e2c01ec368..8d53d887e9 100644 --- a/data/sldn_metadata.json +++ b/data/sldn_metadata.json @@ -15500,230 +15500,6 @@ "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 } } }, @@ -18309,567 +18085,6 @@ "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 } } }, @@ -19829,567 +19044,6 @@ "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": { @@ -21190,794 +19844,233 @@ "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", + } + }, + "properties": { + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalOneTimeTaxAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "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." - }, - "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.'" + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, "nextInvoiceTotalRecurringAmount": { "name": "nextInvoiceTotalRecurringAmount", @@ -23181,567 +21274,6 @@ "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 } } }, @@ -24647,1380 +22179,926 @@ "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 + } + ] }, - "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 + "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." + } + ] }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", - "type": "SoftLayer_Account_Agreement", - "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." + } + ] }, - "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, + "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, - "deprecated": false + "maskable": true }, - "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", + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", "type": "SoftLayer_Billing_Item", "typeArray": true, - "ormMethod": 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, - "filterable": true, - "deprecated": false, - "limitable": 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 + } + ] }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "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", + "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, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalOneTimeTaxAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalRecurringAmount": { - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalRecurringAmount", + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" }, - "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", + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding ALL 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", + "orderItem": { + "name": "orderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." }, - "getOriginalLocation": { - "doc": "The original physical location for this billing item--may differ from current.", - "docOverview": "", - "name": "getOriginalLocation", + "originalLocation": { + "name": "originalLocation", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." }, - "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", + "package": { + "name": "package", "type": "SoftLayer_Product_Package", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getParent": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParent", + "parent": { + "name": "parent", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getParentVirtualGuestBillingItem": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParentVirtualGuestBillingItem", + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." }, - "getPendingOrderItem": { - "doc": "The new order item that will replace this billing item.", - "docOverview": "", - "name": "getPendingOrderItem", + "pendingOrderItem": { + "name": "pendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The new order item that will replace this billing item." }, - "getProvisionTransaction": { - "doc": "Provisioning transaction for this billing item", - "docOverview": "", - "name": "getProvisionTransaction", + "provisionTransaction": { + "name": "provisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Provisioning transaction for this billing item" }, - "getSoftwareDescription": { - "doc": "A friendly description of software component", - "docOverview": "", - "name": "getSoftwareDescription", + "softwareDescription": { + "name": "softwareDescription", "type": "SoftLayer_Software_Description", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A friendly description of software component" }, - "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", + "upgradeItem": { + "name": "upgradeItem", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "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", + "upgradeItems": { + "name": "upgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "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 - } - ] + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." }, - "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." - } - ] + "allowCancellationFlag": { + "name": "allowCancellationFlag", + "type": "int", + "form": "local", + "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " }, - "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." - } - ] + "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. " }, - "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 + "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. " }, - "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 - } - ] + "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." }, - "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" - } - ] + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date the billing item was created. You can see this date on the invoice." }, - "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" - } - ] + "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. " }, - "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" - } - ] + "cycleStartDate": { + "name": "cycleStartDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." }, - "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 + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "A brief description of a billing item." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", - "type": "SoftLayer_Account_Agreement", - "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." }, - "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 + "hostName": { + "name": "hostName", + "type": "string", + "form": "local", + "doc": "The hostname is provided for server billing items" }, - "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 + "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). " }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", - "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. " }, - "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 + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The unique identifier for this billing item." }, - "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 + "laborFee": { + "name": "laborFee", + "type": "decimal", + "form": "local", + "doc": "The labor fee, if any. This is a one time charge." }, - "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 + "laborFeeTaxRate": { + "name": "laborFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which labor fees are taxed if you are a taxable customer." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", - "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "lastBillDate": { + "name": "lastBillDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", - "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." }, - "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 + "nextBillDate": { + "name": "nextBillDate", + "type": "dateTime", + "form": "local", + "doc": "The date on which your account will be charged for this billing item. " }, - "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 + "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." }, - "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 + "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). " }, - "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 + "oneTimeFeeTaxRate": { + "name": "oneTimeFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which one time fees are taxed if you are a taxable customer." }, - "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 + "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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", - "type": "SoftLayer_Network_Vlan", - "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." }, - "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 + "parentId": { + "name": "parentId", + "type": "int", + "form": "local", + "doc": "The unique identifier of the parent of 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 + "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). " }, - "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 + "recurringFeeTaxRate": { + "name": "recurringFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which recurring 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 + "recurringMonths": { + "name": "recurringMonths", + "type": "int", + "form": "local", + "doc": "The number of months in which the recurring fees will be incurred." }, - "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 + "serviceProviderId": { + "name": "serviceProviderId", + "type": "int", + "form": "local", + "doc": "This is the service provider for 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 + "setupFee": { + "name": "setupFee", + "type": "decimal", + "form": "local", + "doc": "The setup fee, if any. This is a one time charge." }, - "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 + "setupFeeTaxRate": { + "name": "setupFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which setup fees are taxed if you are a taxable customer." }, - "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 + "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." }, - "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 + "activeAssociatedGuestDiskBillingItemCount": { + "name": "activeAssociatedGuestDiskBillingItemCount", + "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 + "activeBundledItemCount": { + "name": "activeBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active bundled billing items." }, - "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 + "activeChildrenCount": { + "name": "activeChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child 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 + "activeSparePoolAssociatedGuestDiskBillingItemCount": { + "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", + "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 + "activeSparePoolBundledItemCount": { + "name": "activeSparePoolBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's spare pool bundled 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 + "associatedBillingItemHistoryCount": { + "name": "associatedBillingItemHistoryCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a history of billing items which a billing item has been associated with." }, - "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 + "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." }, - "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 + "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." }, - "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 + "availableMatchingVlanCount": { + "name": "availableMatchingVlanCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "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 + "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." }, - "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 + "bundledItemCount": { + "name": "bundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's bundled billing 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 + "canceledChildrenCount": { + "name": "canceledChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing 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 + "cancellationRequestCount": { + "name": "cancellationRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of this will return any cancellation requests that are associated with this 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 + "childrenCount": { + "name": "childrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing 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 + "childrenWithActiveAgreementCount": { + "name": "childrenWithActiveAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." }, - "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 + "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." }, - "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 + "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." }, - "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 + "invoiceItemCount": { + "name": "invoiceItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all invoice items associated with the billing item" }, - "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 + "nextInvoiceChildrenCount": { + "name": "nextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing items and associated items'" }, - "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 + "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." }, - "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 + "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_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_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", @@ -26028,29 +23106,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", @@ -26675,20 +23735,426 @@ "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_Component": { - "name": "SoftLayer_Billing_Item_Hardware_Component", - "base": "SoftLayer_Billing_Item", + "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 data type contains general information relating to a single SoftLayer billing item for hardware components. ", + "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" + } + ] + } + }, "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", @@ -26696,11 +24162,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", @@ -27325,7 +24809,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", @@ -27493,1410 +24983,756 @@ "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." }, - "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 + "billingCyclePrivateBandwidthUsage": { + "name": "billingCyclePrivateBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", + "typeArray": true, + "doc": "The raw private bandwidth usage data for the current billing cycle." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", - "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "billingCyclePrivateUsageIn": { + "name": "billingCyclePrivateUsageIn", + "type": "decimal", + "form": "relational", + "doc": "The total private inbound 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 + "billingCyclePrivateUsageOut": { + "name": "billingCyclePrivateUsageOut", + "type": "decimal", + "form": "relational", + "doc": "The total private outbound bandwidth for this hardware for the current billing cycle." }, - "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 + "billingCyclePrivateUsageTotal": { + "name": "billingCyclePrivateUsageTotal", + "type": "unsignedInt", + "form": "relational", + "doc": "The total private bandwidth for this hardware for the current billing cycle." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", - "type": "SoftLayer_Billing_Item", + "billingCyclePublicBandwidthUsage": { + "name": "billingCyclePublicBandwidthUsage", + "type": "SoftLayer_Network_Bandwidth_Usage", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "The raw public bandwidth usage data for the current billing cycle." }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "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, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "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", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalOneTimeTaxAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalRecurringAmount": { - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalRecurringAmount", + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" }, - "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", + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding ALL 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", + "orderItem": { + "name": "orderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." }, - "getOriginalLocation": { - "doc": "The original physical location for this billing item--may differ from current.", - "docOverview": "", - "name": "getOriginalLocation", + "originalLocation": { + "name": "originalLocation", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." }, - "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", + "package": { + "name": "package", "type": "SoftLayer_Product_Package", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getParent": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParent", + "parent": { + "name": "parent", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getParentVirtualGuestBillingItem": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParentVirtualGuestBillingItem", + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." }, - "getPendingOrderItem": { - "doc": "The new order item that will replace this billing item.", - "docOverview": "", - "name": "getPendingOrderItem", + "pendingOrderItem": { + "name": "pendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The new order item that will replace this billing item." }, - "getProvisionTransaction": { - "doc": "Provisioning transaction for this billing item", - "docOverview": "", - "name": "getProvisionTransaction", + "provisionTransaction": { + "name": "provisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Provisioning transaction for this billing item" }, - "getSoftwareDescription": { - "doc": "A friendly description of software component", - "docOverview": "", - "name": "getSoftwareDescription", + "softwareDescription": { + "name": "softwareDescription", "type": "SoftLayer_Software_Description", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A friendly description of software component" }, - "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", + "upgradeItem": { + "name": "upgradeItem", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "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", + "upgradeItems": { + "name": "upgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "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 - } - ] + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." }, - "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." - } - ] + "allowCancellationFlag": { + "name": "allowCancellationFlag", + "type": "int", + "form": "local", + "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " }, - "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." - } - ] + "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. " }, - "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 + "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. " }, - "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 - } - ] + "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." }, - "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" - } - ] + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date the billing item was created. You can see this date on the invoice." }, - "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" - } - ] + "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. " }, - "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" - } - ] + "cycleStartDate": { + "name": "cycleStartDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." }, - "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 + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "A brief description of a billing item." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", - "type": "SoftLayer_Account_Agreement", - "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." }, - "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 + "hostName": { + "name": "hostName", + "type": "string", + "form": "local", + "doc": "The hostname is provided for server billing items" }, - "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 + "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). " }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", - "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. " }, - "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 + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The unique identifier for this billing item." }, - "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 + "laborFee": { + "name": "laborFee", + "type": "decimal", + "form": "local", + "doc": "The labor fee, if any. This is a one time charge." }, - "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 + "laborFeeTaxRate": { + "name": "laborFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which labor fees are taxed if you are a taxable customer." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", - "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "lastBillDate": { + "name": "lastBillDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", - "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." }, - "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 + "nextBillDate": { + "name": "nextBillDate", + "type": "dateTime", + "form": "local", + "doc": "The date on which your account will be charged for this billing item. " }, - "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 + "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." }, - "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 + "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). " }, - "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 + "oneTimeFeeTaxRate": { + "name": "oneTimeFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which one time fees are taxed if you are a taxable customer." }, - "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 + "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." }, - "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 + "packageId": { + "name": "packageId", + "type": "int", + "form": "local", + "doc": "This is the package id for 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 + "parentId": { + "name": "parentId", + "type": "int", + "form": "local", + "doc": "The unique identifier of the parent of this billing item." }, - "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 + "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). " }, - "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 + "recurringFeeTaxRate": { + "name": "recurringFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which recurring fees are taxed if you are a taxable customer." }, - "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 + "recurringMonths": { + "name": "recurringMonths", + "type": "int", + "form": "local", + "doc": "The number of months in which the recurring fees will be incurred." }, - "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 + "serviceProviderId": { + "name": "serviceProviderId", + "type": "int", + "form": "local", + "doc": "This is the service provider for this 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 + "setupFee": { + "name": "setupFee", + "type": "decimal", + "form": "local", + "doc": "The setup fee, if any. This is a one time charge." }, - "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 + "setupFeeTaxRate": { + "name": "setupFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which setup fees are taxed if you are a taxable customer." }, - "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 + "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." }, - "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 + "activeAssociatedGuestDiskBillingItemCount": { + "name": "activeAssociatedGuestDiskBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "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 + "activeBundledItemCount": { + "name": "activeBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active bundled billing items." }, - "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 + "activeChildrenCount": { + "name": "activeChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." }, - "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 + "activeSparePoolAssociatedGuestDiskBillingItemCount": { + "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "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." + "activeSparePoolBundledItemCount": { + "name": "activeSparePoolBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's spare pool bundled billing items." }, - "billingCyclePrivateBandwidthUsage": { - "name": "billingCyclePrivateBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw private bandwidth usage data for the current billing cycle." + "associatedBillingItemHistoryCount": { + "name": "associatedBillingItemHistoryCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a history of billing items which a billing item has been associated with." }, - "billingCyclePrivateUsageIn": { - "name": "billingCyclePrivateUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total private inbound bandwidth for this hardware for the current billing cycle." + "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." }, - "billingCyclePrivateUsageOut": { - "name": "billingCyclePrivateUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total private outbound bandwidth for this hardware for the current billing cycle." + "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." }, - "billingCyclePrivateUsageTotal": { - "name": "billingCyclePrivateUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total private bandwidth for this hardware for the current billing cycle." + "availableMatchingVlanCount": { + "name": "availableMatchingVlanCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "billingCyclePublicBandwidthUsage": { - "name": "billingCyclePublicBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", - "form": "relational", - "typeArray": true, - "doc": "The raw public bandwidth usage data for the current billing cycle." + "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." }, - "billingCyclePublicUsageIn": { - "name": "billingCyclePublicUsageIn", - "type": "decimal", - "form": "relational", - "doc": "The total public inbound bandwidth for this hardware for the current billing cycle." + "bundledItemCount": { + "name": "bundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's bundled billing items." }, - "billingCyclePublicUsageOut": { - "name": "billingCyclePublicUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total public outbound bandwidth for this hardware for the current billing cycle." + "canceledChildrenCount": { + "name": "canceledChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." }, - "billingCyclePublicUsageTotal": { - "name": "billingCyclePublicUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total public bandwidth for this hardware for the current billing cycle." + "cancellationRequestCount": { + "name": "cancellationRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of this will return any cancellation requests that are associated with this billing item." }, - "lockboxNetworkStorage": { - "name": "lockboxNetworkStorage", - "type": "SoftLayer_Billing_Item_Network_Storage", - "form": "relational", - "doc": "A lockbox account associated with a server." + "childrenCount": { + "name": "childrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing items'" }, - "monitoringBillingItems": { - "name": "monitoringBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "childrenWithActiveAgreementCount": { + "name": "childrenWithActiveAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." }, - "resource": { - "name": "resource", - "type": "SoftLayer_Hardware_Server", - "form": "relational", - "doc": "The resource for a server billing item." + "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." }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a server billing item." + "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." }, - "billingCycleBandwidthUsageCount": { - "name": "billingCycleBandwidthUsageCount", + "invoiceItemCount": { + "name": "invoiceItemCount", "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." + "doc": "A count of all invoice items associated with the billing item" }, - "billingCyclePrivateBandwidthUsageCount": { - "name": "billingCyclePrivateBandwidthUsageCount", + "nextInvoiceChildrenCount": { + "name": "nextInvoiceChildrenCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the raw private bandwidth usage data for the current billing cycle." + "doc": "A count of a Billing Item's child billing items and associated items'" }, - "billingCyclePublicBandwidthUsageCount": { - "name": "billingCyclePublicBandwidthUsageCount", + "nonZeroNextInvoiceChildrenCount": { + "name": "nonZeroNextInvoiceChildrenCount", "type": "unsignedLong", "form": "count", - "doc": "A count of the raw public bandwidth usage data for the current billing cycle." + "doc": "A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee." }, - "monitoringBillingItemCount": { - "name": "monitoringBillingItemCount", + "upgradeItemCount": { + "name": "upgradeItemCount", "type": "unsignedLong", "form": "count", - "doc": "A count of " + "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." }, "account": { "name": "account", @@ -29521,13 +26357,182 @@ "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_Server": { - "name": "SoftLayer_Billing_Item_Hardware_Server", - "base": "SoftLayer_Billing_Item_Hardware", + "SoftLayer_Billing_Item_Network_Bandwidth": { + "name": "SoftLayer_Billing_Item_Network_Bandwidth", + "base": "SoftLayer_Billing_Item", "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. ", + "typeDoc": "The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -29695,742 +26700,76 @@ "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", + } + }, + "properties": { + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "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": { - "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." + "doc": "A Billing Item's spare pool bundled billing items." }, "associatedBillingItem": { "name": "associatedBillingItem", @@ -30989,23 +27328,17 @@ } } }, - "SoftLayer_Billing_Item_Network_Application_Delivery_Controller": { - "name": "SoftLayer_Billing_Item_Network_Application_Delivery_Controller", + "SoftLayer_Billing_Item_Network_Firewall": { + "name": "SoftLayer_Billing_Item_Network_Firewall", "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 ", + "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": { - "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", + "type": "SoftLayer_Network_Component_Firewall", "form": "relational", - "doc": "The network application controller that a billing item is associated with." + "doc": "The VLAN firewall that a VLAN firewall billing item is associated with." }, "account": { "name": "account", @@ -31798,575 +28131,645 @@ "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." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalOneTimeTaxAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalRecurringAmount": { - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalRecurringAmount", + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" }, - "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", + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding ALL 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", + "orderItem": { + "name": "orderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." }, - "getOriginalLocation": { - "doc": "The original physical location for this billing item--may differ from current.", - "docOverview": "", - "name": "getOriginalLocation", + "originalLocation": { + "name": "originalLocation", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." }, - "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", + "package": { + "name": "package", "type": "SoftLayer_Product_Package", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getParent": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParent", + "parent": { + "name": "parent", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getParentVirtualGuestBillingItem": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParentVirtualGuestBillingItem", + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." }, - "getPendingOrderItem": { - "doc": "The new order item that will replace this billing item.", - "docOverview": "", - "name": "getPendingOrderItem", + "pendingOrderItem": { + "name": "pendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The new order item that will replace this billing item." }, - "getProvisionTransaction": { - "doc": "Provisioning transaction for this billing item", - "docOverview": "", - "name": "getProvisionTransaction", + "provisionTransaction": { + "name": "provisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Provisioning transaction for this billing item" }, - "getSoftwareDescription": { - "doc": "A friendly description of software component", - "docOverview": "", - "name": "getSoftwareDescription", + "softwareDescription": { + "name": "softwareDescription", "type": "SoftLayer_Software_Description", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A friendly description of software component" }, - "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", + "upgradeItem": { + "name": "upgradeItem", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "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", + "upgradeItems": { + "name": "upgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." } - } - }, - "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", @@ -32534,586 +28937,37 @@ "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." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "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": { - "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." + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, "activeAssociatedChildren": { "name": "activeAssociatedChildren", @@ -33721,19 +29575,188 @@ "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_Firewall": { - "name": "SoftLayer_Billing_Item_Network_Firewall", + "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_Firewall data type contains general information relating to a single SoftLayer billing item whose item category code is 'firewall' ", + "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_Component_Firewall", + "type": "SoftLayer_Network_Interconnect_Tenant", "form": "relational", - "doc": "The VLAN firewall that a VLAN firewall billing item is associated with." + "doc": "The interconnect tenant that the billing item is associated with." }, "account": { "name": "account", @@ -34526,582 +30549,184 @@ "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", + } + } + }, + "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", - "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 + "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 + } + ] }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "cancelService": { + "name": "cancelService", "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 + "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." + } + ] }, - "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 + "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." + } + ] }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "getObject": { + "name": "getObject", "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, + "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, - "deprecated": false + "maskable": true }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", "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, + "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, - "filterable": true, - "deprecated": false + "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 + } + ] }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "removeAssociationId": { + "name": "removeAssociationId", "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 + "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" + } + ] }, - "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 + "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" + } + ] }, - "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 + "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_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", @@ -35725,807 +31350,77 @@ "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_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." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "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", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", "form": "relational", "typeArray": true @@ -37260,735 +32155,343 @@ "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" } ] + } + } + }, + "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 + } + ] }, - "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 + "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." + } + ] }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", - "type": "SoftLayer_Account_Agreement", - "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." + } + ] }, - "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, + "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, - "deprecated": false + "maskable": true }, - "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", + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", "type": "SoftLayer_Billing_Item", "typeArray": true, - "ormMethod": 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, - "filterable": true, - "deprecated": false, - "limitable": 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 + } + ] }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "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": { + "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, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", + "type": "SoftLayer_Billing_Item", + "form": "relational", + "typeArray": true + }, + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "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_Routing": { - "name": "SoftLayer_Billing_Item_Network_Interconnect_Routing", - "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. ", - "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", - "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'" + "doc": "A Billing Item's child billing items'" }, "childrenWithActiveAgreement": { "name": "childrenWithActiveAgreement", @@ -38459,7 +32962,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_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", @@ -38627,1530 +33136,876 @@ "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." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalOneTimeTaxAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalRecurringAmount": { - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalRecurringAmount", + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" }, - "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", + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding ALL 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", + "orderItem": { + "name": "orderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." }, - "getOriginalLocation": { - "doc": "The original physical location for this billing item--may differ from current.", - "docOverview": "", - "name": "getOriginalLocation", + "originalLocation": { + "name": "originalLocation", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." }, - "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", + "package": { + "name": "package", "type": "SoftLayer_Product_Package", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getParent": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParent", + "parent": { + "name": "parent", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getParentVirtualGuestBillingItem": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParentVirtualGuestBillingItem", + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." }, - "getPendingOrderItem": { - "doc": "The new order item that will replace this billing item.", - "docOverview": "", - "name": "getPendingOrderItem", + "pendingOrderItem": { + "name": "pendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The new order item that will replace this billing item." }, - "getProvisionTransaction": { - "doc": "Provisioning transaction for this billing item", - "docOverview": "", - "name": "getProvisionTransaction", + "provisionTransaction": { + "name": "provisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Provisioning transaction for this billing item" }, - "getSoftwareDescription": { - "doc": "A friendly description of software component", - "docOverview": "", - "name": "getSoftwareDescription", + "softwareDescription": { + "name": "softwareDescription", "type": "SoftLayer_Software_Description", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A friendly description of software component" }, - "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", + "upgradeItem": { + "name": "upgradeItem", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "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", + "upgradeItems": { + "name": "upgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "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 - } - ] + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." }, - "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." - } - ] + "allowCancellationFlag": { + "name": "allowCancellationFlag", + "type": "int", + "form": "local", + "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " }, - "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." - } - ] + "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. " }, - "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 + "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. " }, - "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 - } - ] + "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." }, - "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" - } - ] + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date the billing item was created. You can see this date on the invoice." }, - "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" - } - ] + "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. " }, - "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" - } - ] + "cycleStartDate": { + "name": "cycleStartDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "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." + } + } + }, + "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", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalOneTimeTaxAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "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." - }, - "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.'" + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, "nextInvoiceTotalRecurringAmount": { "name": "nextInvoiceTotalRecurringAmount", @@ -40550,19 +34405,357 @@ "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_Message_Delivery": { - "name": "SoftLayer_Billing_Item_Network_Message_Delivery", - "base": "SoftLayer_Billing_Item", + "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_Message_Delivery data describes the related billing item. ", + "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" + } + ] + } + }, "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Network_Message_Delivery", + "type": "SoftLayer_Network_Storage", "form": "relational", - "doc": "The object this billing item is associated with." + "doc": "The StorageLayer account that a network storage billing item is associated with." }, "account": { "name": "account", @@ -41187,7 +35380,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_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", @@ -41355,1311 +35554,663 @@ "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." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalOneTimeTaxAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalRecurringAmount": { - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalRecurringAmount", + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" }, - "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", + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding ALL 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", + "orderItem": { + "name": "orderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." }, - "getOriginalLocation": { - "doc": "The original physical location for this billing item--may differ from current.", - "docOverview": "", - "name": "getOriginalLocation", + "originalLocation": { + "name": "originalLocation", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." }, - "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", + "package": { + "name": "package", "type": "SoftLayer_Product_Package", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getParent": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParent", + "parent": { + "name": "parent", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getParentVirtualGuestBillingItem": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParentVirtualGuestBillingItem", + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." }, - "getPendingOrderItem": { - "doc": "The new order item that will replace this billing item.", - "docOverview": "", - "name": "getPendingOrderItem", + "pendingOrderItem": { + "name": "pendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The new order item that will replace this billing item." }, - "getProvisionTransaction": { - "doc": "Provisioning transaction for this billing item", - "docOverview": "", - "name": "getProvisionTransaction", + "provisionTransaction": { + "name": "provisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Provisioning transaction for this billing item" }, - "getSoftwareDescription": { - "doc": "A friendly description of software component", - "docOverview": "", - "name": "getSoftwareDescription", + "softwareDescription": { + "name": "softwareDescription", "type": "SoftLayer_Software_Description", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A friendly description of software component" }, - "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", + "upgradeItem": { + "name": "upgradeItem", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "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", + "upgradeItems": { + "name": "upgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "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 - } - ] + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." }, - "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." - } - ] + "allowCancellationFlag": { + "name": "allowCancellationFlag", + "type": "int", + "form": "local", + "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " }, - "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." - } - ] + "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. " }, - "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 + "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. " }, - "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 - } - ] + "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." }, - "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" - } - ] + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date the billing item was created. You can see this date on the invoice." }, - "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" - } - ] + "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. " }, - "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" - } - ] + "cycleStartDate": { + "name": "cycleStartDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." }, - "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 + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "A brief description of a billing item." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", - "type": "SoftLayer_Account_Agreement", - "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." }, - "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 + "hostName": { + "name": "hostName", + "type": "string", + "form": "local", + "doc": "The hostname is provided for server billing items" }, - "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 + "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). " }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", - "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. " }, - "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 + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The unique identifier for this billing item." }, - "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 + "laborFee": { + "name": "laborFee", + "type": "decimal", + "form": "local", + "doc": "The labor fee, if any. This is a one time charge." }, - "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 + "laborFeeTaxRate": { + "name": "laborFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which labor fees are taxed if you are a taxable customer." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", - "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "lastBillDate": { + "name": "lastBillDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", - "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." }, - "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 + "nextBillDate": { + "name": "nextBillDate", + "type": "dateTime", + "form": "local", + "doc": "The date on which your account will be charged for this billing item. " }, - "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 + "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." }, - "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 + "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). " }, - "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 + "oneTimeFeeTaxRate": { + "name": "oneTimeFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which one time 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 + "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." }, - "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 + "packageId": { + "name": "packageId", + "type": "int", + "form": "local", + "doc": "This is the package id 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 + "parentId": { + "name": "parentId", + "type": "int", + "form": "local", + "doc": "The unique identifier of the parent 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 + "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). " }, - "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 + "recurringFeeTaxRate": { + "name": "recurringFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which recurring fees are taxed if you are a taxable customer." }, - "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 + "recurringMonths": { + "name": "recurringMonths", + "type": "int", + "form": "local", + "doc": "The number of months in which the recurring fees will be incurred." }, - "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 + "serviceProviderId": { + "name": "serviceProviderId", + "type": "int", + "form": "local", + "doc": "This is the service provider for this billing item. " }, - "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 + "setupFee": { + "name": "setupFee", + "type": "decimal", + "form": "local", + "doc": "The setup fee, if any. This is a one time charge." }, - "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 + "setupFeeTaxRate": { + "name": "setupFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which setup fees are taxed if you are a taxable customer." }, - "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 + "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." }, - "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 + "activeAssociatedGuestDiskBillingItemCount": { + "name": "activeAssociatedGuestDiskBillingItemCount", + "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 + "activeBundledItemCount": { + "name": "activeBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active bundled billing items." }, - "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 + "activeChildrenCount": { + "name": "activeChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child 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 + "activeSparePoolAssociatedGuestDiskBillingItemCount": { + "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", + "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 + "activeSparePoolBundledItemCount": { + "name": "activeSparePoolBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's spare pool bundled 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 + "associatedBillingItemHistoryCount": { + "name": "associatedBillingItemHistoryCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a history of billing items which a billing item has been associated with." }, - "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 + "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." }, - "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 + "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." }, - "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 + "availableMatchingVlanCount": { + "name": "availableMatchingVlanCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "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 + "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." }, - "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 + "bundledItemCount": { + "name": "bundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's bundled billing 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 + "canceledChildrenCount": { + "name": "canceledChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing 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 + "cancellationRequestCount": { + "name": "cancellationRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of this will return any cancellation requests that are associated with this 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 + "childrenCount": { + "name": "childrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing 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 + "childrenWithActiveAgreementCount": { + "name": "childrenWithActiveAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." }, - "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 + "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." }, - "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 + "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." }, - "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 + "invoiceItemCount": { + "name": "invoiceItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all invoice items associated with the billing item" }, - "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 + "nextInvoiceChildrenCount": { + "name": "nextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing items and associated items'" }, - "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 + "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." }, - "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 + "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_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_Storage", + "type": "SoftLayer_Network_Subnet", "form": "relational", - "doc": "The StorageLayer account that a network storage billing item is associated with." + "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", @@ -43284,13 +36835,182 @@ "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_PerformanceStorage_Nfs": { - "name": "SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs", - "base": "SoftLayer_Billing_Item_Network_Storage", + "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_Network_PerformanceStorage_Nfs data type contains general information relating to a single SoftLayer billing item whose item category code is 'performance_storage_nfs' ", + "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", @@ -43458,689 +37178,140 @@ "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." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "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", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "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": { - "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." + "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", @@ -44653,17 +37824,17 @@ } } }, - "SoftLayer_Billing_Item_Network_Storage": { - "name": "SoftLayer_Billing_Item_Network_Storage", + "SoftLayer_Billing_Item_Network_Tunnel": { + "name": "SoftLayer_Billing_Item_Network_Tunnel", "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", + "type": "SoftLayer_Network_Tunnel_Module_Context", "form": "relational", - "doc": "The StorageLayer account that a network storage billing item is associated with." + "doc": "The IPsec VPN that a network tunnel billing item is associated with." }, "account": { "name": "account", @@ -45456,575 +38627,645 @@ "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." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalOneTimeTaxAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalRecurringAmount": { - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalRecurringAmount", + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" }, - "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", + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding ALL 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", + "orderItem": { + "name": "orderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." }, - "getOriginalLocation": { - "doc": "The original physical location for this billing item--may differ from current.", - "docOverview": "", - "name": "getOriginalLocation", + "originalLocation": { + "name": "originalLocation", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." }, - "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", + "package": { + "name": "package", "type": "SoftLayer_Product_Package", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getParent": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParent", + "parent": { + "name": "parent", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getParentVirtualGuestBillingItem": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParentVirtualGuestBillingItem", + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." }, - "getPendingOrderItem": { - "doc": "The new order item that will replace this billing item.", - "docOverview": "", - "name": "getPendingOrderItem", + "pendingOrderItem": { + "name": "pendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The new order item that will replace this billing item." }, - "getProvisionTransaction": { - "doc": "Provisioning transaction for this billing item", - "docOverview": "", - "name": "getProvisionTransaction", + "provisionTransaction": { + "name": "provisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Provisioning transaction for this billing item" }, - "getSoftwareDescription": { - "doc": "A friendly description of software component", - "docOverview": "", - "name": "getSoftwareDescription", + "softwareDescription": { + "name": "softwareDescription", "type": "SoftLayer_Software_Description", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A friendly description of software component" }, - "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", + "upgradeItem": { + "name": "upgradeItem", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "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", + "upgradeItems": { + "name": "upgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." } - } - }, - "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", @@ -46192,576 +39433,183 @@ "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 + } + ] }, - "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", + "cancelService": { + "name": "cancelService", "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 + "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." + } + ] }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "cancelServiceOnAnniversaryDate": { + "name": "cancelServiceOnAnniversaryDate", "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 + "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." + } + ] }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "getObject": { + "name": "getObject", "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, + "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, - "deprecated": false + "maskable": true }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", "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, + "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, - "filterable": true, - "deprecated": false + "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 + } + ] }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "removeAssociationId": { + "name": "removeAssociationId", "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 + "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" + } + ] }, - "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 + "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" + } + ] }, - "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 + "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": { - "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", @@ -47387,11 +40235,11 @@ } } }, - "SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth": { - "name": "SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth", - "base": "SoftLayer_Billing_Item_Network_Storage", + "SoftLayer_Billing_Item_Private_Cloud": { + "name": "SoftLayer_Billing_Item_Private_Cloud", + "base": "SoftLayer_Billing_Item", "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. ", + "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", @@ -47559,750 +40407,183 @@ "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", + } + }, + "properties": { + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "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, - "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." + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, "hourlyFlag": { "name": "hourlyFlag", @@ -48754,29 +41035,23 @@ } } }, - "SoftLayer_Billing_Item_Network_Subnet": { - "name": "SoftLayer_Billing_Item_Network_Subnet", + "SoftLayer_Billing_Item_Software_Component": { + "name": "SoftLayer_Billing_Item_Software_Component", "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. ", + "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_Network_Subnet", + "type": "SoftLayer_Software_Component", "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." + "doc": "The software component that this billing item points to." }, "resourceTableId": { "name": "resourceTableId", "type": "int", "form": "local", - "doc": "The resource (unique identifier) for a server billing item." + "doc": "The resource (unique identifier) for a software component billing item." }, "account": { "name": "account", @@ -49569,575 +41844,14 @@ "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_Subnet_IpAddress_Global": { - "name": "SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global", - "base": "SoftLayer_Billing_Item_Network_Subnet", + "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_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_Software_Component_Analytics_Urchin data type contains general information relating to a single SoftLayer billing item for Urchin software components. ", "methods": { "cancelItem": { "name": "cancelItem", @@ -50305,809 +42019,230 @@ "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", + } + }, + "properties": { + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "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_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", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "type": "float", "form": "relational", "doc": "A Billing Item's total, including any child billing items if they exist.'" @@ -51512,18 +42647,181 @@ } } }, - "SoftLayer_Billing_Item_Network_Tunnel": { - "name": "SoftLayer_Billing_Item_Network_Tunnel", + "SoftLayer_Billing_Item_Software_Component_ControlPanel": { + "name": "SoftLayer_Billing_Item_Software_Component_ControlPanel", "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", - "form": "relational", - "doc": "The IPsec VPN that a network tunnel billing item is associated with." + "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" + } + ] + } + }, + "properties": { "account": { "name": "account", "type": "SoftLayer_Account", @@ -52147,7 +43445,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", @@ -52315,582 +43619,9 @@ "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", @@ -53514,7 +44245,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", @@ -53682,1465 +44419,806 @@ "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", + } + }, + "properties": { + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalOneTimeTaxAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalRecurringAmount": { - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalRecurringAmount", + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" }, - "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", + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding ALL 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", + "orderItem": { + "name": "orderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." }, - "getOriginalLocation": { - "doc": "The original physical location for this billing item--may differ from current.", - "docOverview": "", - "name": "getOriginalLocation", + "originalLocation": { + "name": "originalLocation", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." }, - "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", + "package": { + "name": "package", "type": "SoftLayer_Product_Package", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getParent": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParent", + "parent": { + "name": "parent", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getParentVirtualGuestBillingItem": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParentVirtualGuestBillingItem", + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." }, - "getPendingOrderItem": { - "doc": "The new order item that will replace this billing item.", - "docOverview": "", - "name": "getPendingOrderItem", + "pendingOrderItem": { + "name": "pendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The new order item that will replace this billing item." }, - "getProvisionTransaction": { - "doc": "Provisioning transaction for this billing item", - "docOverview": "", - "name": "getProvisionTransaction", + "provisionTransaction": { + "name": "provisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Provisioning transaction for this billing item" }, - "getSoftwareDescription": { - "doc": "A friendly description of software component", - "docOverview": "", - "name": "getSoftwareDescription", + "softwareDescription": { + "name": "softwareDescription", "type": "SoftLayer_Software_Description", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A friendly description of software component" }, - "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", + "upgradeItem": { + "name": "upgradeItem", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "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", + "upgradeItems": { + "name": "upgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "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 - } - ] + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." }, - "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." - } - ] + "allowCancellationFlag": { + "name": "allowCancellationFlag", + "type": "int", + "form": "local", + "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " }, - "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." - } - ] + "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. " }, - "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 + "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. " }, - "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 - } - ] + "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." }, - "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" - } - ] + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date the billing item was created. You can see this date on the invoice." }, - "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" - } - ] + "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. " }, - "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" - } - ] + "cycleStartDate": { + "name": "cycleStartDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "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." + } + } + }, + "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." + }, + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "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", - "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." + "doc": "A Billing Item's active child billing items." }, "downgradeItems": { "name": "downgradeItems", @@ -55604,13 +45682,182 @@ "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_Private_Cloud": { - "name": "SoftLayer_Billing_Item_Private_Cloud", + "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_Private_Cloud data type contains general information relating to a single billing item for a private cloud. ", + "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", @@ -55778,772 +46025,211 @@ "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", + } + }, + "properties": { + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "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." @@ -56967,23 +46653,23 @@ } } }, - "SoftLayer_Billing_Item_Software_Component": { - "name": "SoftLayer_Billing_Item_Software_Component", - "base": "SoftLayer_Billing_Item", + "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_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components. ", + "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", + "type": "SoftLayer_Software_VirtualLicense", "form": "relational", - "doc": "The software component that this billing item points to." + "doc": "The software virtual license to which this billing item points." }, "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 software virtual license billing item." }, "account": { "name": "account", @@ -57776,575 +47462,651 @@ "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." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "resourceTableId": { + "name": "resourceTableId", + "type": "int", + "form": "local", + "doc": "The resource (unique identifier) for a software component billing item." + }, + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalOneTimeTaxAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalRecurringAmount": { - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalRecurringAmount", + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" }, - "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", + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding ALL 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", + "orderItem": { + "name": "orderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." }, - "getOriginalLocation": { - "doc": "The original physical location for this billing item--may differ from current.", - "docOverview": "", - "name": "getOriginalLocation", + "originalLocation": { + "name": "originalLocation", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." }, - "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", + "package": { + "name": "package", "type": "SoftLayer_Product_Package", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getParent": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParent", + "parent": { + "name": "parent", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getParentVirtualGuestBillingItem": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParentVirtualGuestBillingItem", + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." }, - "getPendingOrderItem": { - "doc": "The new order item that will replace this billing item.", - "docOverview": "", - "name": "getPendingOrderItem", + "pendingOrderItem": { + "name": "pendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The new order item that will replace this billing item." }, - "getProvisionTransaction": { - "doc": "Provisioning transaction for this billing item", - "docOverview": "", - "name": "getProvisionTransaction", + "provisionTransaction": { + "name": "provisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Provisioning transaction for this billing item" }, - "getSoftwareDescription": { - "doc": "A friendly description of software component", - "docOverview": "", - "name": "getSoftwareDescription", + "softwareDescription": { + "name": "softwareDescription", "type": "SoftLayer_Software_Description", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A friendly description of software component" }, - "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", + "upgradeItem": { + "name": "upgradeItem", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "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", + "upgradeItems": { + "name": "upgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." } - } - }, - "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", @@ -58512,583 +48274,34 @@ "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." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "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": { - "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", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", "form": "relational", "doc": "A flag indicating that the billing item is under an active agreement." @@ -59699,13 +48912,182 @@ "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_ControlPanel": { - "name": "SoftLayer_Billing_Item_Software_Component_ControlPanel", + "SoftLayer_Billing_Item_Support": { + "name": "SoftLayer_Billing_Item_Support", "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. ", + "typeDoc": "The SoftLayer_Billing_Item_Support data type contains general information relating to a premium support offering ", "methods": { "cancelItem": { "name": "cancelItem", @@ -59873,570 +49255,646 @@ "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", + } + }, + "properties": { + "account": { + "name": "account", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalOneTimeTaxAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalRecurringAmount": { - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalRecurringAmount", + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" }, - "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", + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding ALL 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", + "orderItem": { + "name": "orderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." }, - "getOriginalLocation": { - "doc": "The original physical location for this billing item--may differ from current.", - "docOverview": "", - "name": "getOriginalLocation", + "originalLocation": { + "name": "originalLocation", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." }, - "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", + "package": { + "name": "package", "type": "SoftLayer_Product_Package", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getParent": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParent", + "parent": { + "name": "parent", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getParentVirtualGuestBillingItem": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParentVirtualGuestBillingItem", + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." }, - "getPendingOrderItem": { - "doc": "The new order item that will replace this billing item.", - "docOverview": "", - "name": "getPendingOrderItem", + "pendingOrderItem": { + "name": "pendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The new order item that will replace this billing item." }, - "getProvisionTransaction": { - "doc": "Provisioning transaction for this billing item", - "docOverview": "", - "name": "getProvisionTransaction", + "provisionTransaction": { + "name": "provisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Provisioning transaction for this billing item" }, - "getSoftwareDescription": { - "doc": "A friendly description of software component", - "docOverview": "", - "name": "getSoftwareDescription", + "softwareDescription": { + "name": "softwareDescription", "type": "SoftLayer_Software_Description", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A friendly description of software component" }, - "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", + "upgradeItem": { + "name": "upgradeItem", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "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", + "upgradeItems": { + "name": "upgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." } - }, + } + }, + "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", @@ -61060,13 +50518,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", @@ -61234,695 +50686,221 @@ "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." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "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", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "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": { - "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", + "form": "relational", "typeArray": true, "doc": "A Billing Item's active child billing items." }, @@ -62421,13 +51399,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", @@ -62595,6 +51567,189 @@ "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.", @@ -63159,6 +52314,18 @@ } }, "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", @@ -63784,17 +52951,23 @@ } } }, - "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", + "SoftLayer_Billing_Item_Virtual_Disk_Image": { + "name": "SoftLayer_Billing_Item_Virtual_Disk_Image", + "base": "SoftLayer_Billing_Item", "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. ", + "typeDoc": "The SoftLayer_Billing_Item_Virtual_Disk_Image data type contains general information relating to a single SoftLayer billing item for disk images. ", "properties": { "resource": { "name": "resource", - "type": "SoftLayer_Software_Component", + "type": "SoftLayer_Virtual_Disk_Image", "form": "relational", - "doc": "The Citrix Essentials software component that a billing item is associated with." + "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." }, "account": { "name": "account", @@ -64587,1306 +53760,926 @@ "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." }, - "getAccount": { - "doc": "The account that a billing item belongs to.", - "docOverview": "", - "name": "getAccount", + "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", "type": "SoftLayer_Account", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The account that a billing item belongs to." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", + "activeAgreement": { + "name": "activeAgreement", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", - "docOverview": "", - "name": "getActiveAgreementFlag", + "activeAgreementFlag": { + "name": "activeAgreementFlag", "type": "SoftLayer_Account_Agreement", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag indicating that the billing item is under an active agreement." }, - "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", + "activeAssociatedChildren": { + "name": "activeAssociatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", + "activeAssociatedGuestDiskBillingItems": { + "name": "activeAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", - "docOverview": "", - "name": "getActiveBundledItems", + "activeBundledItems": { + "name": "activeBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active bundled billing items." }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", - "docOverview": "", - "name": "getActiveCancellationItem", + "activeCancellationItem": { + "name": "activeCancellationItem", "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A service cancellation request item that corresponds to the billing item." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", + "activeChildren": { + "name": "activeChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", + "activeFlag": { + "name": "activeFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational" }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", + "activeSparePoolAssociatedGuestDiskBillingItems": { + "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getActiveSparePoolBundledItems": { - "doc": "A Billing Item's spare pool bundled billing items.", - "docOverview": "", - "name": "getActiveSparePoolBundledItems", + "activeSparePoolBundledItems": { + "name": "activeSparePoolBundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's spare pool bundled billing items." }, - "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", + "associatedBillingItem": { + "name": "associatedBillingItem", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getAssociatedBillingItemHistory": { - "doc": "A history of billing items which a billing item has been associated with.", - "docOverview": "", - "name": "getAssociatedBillingItemHistory", + "associatedBillingItemHistory": { + "name": "associatedBillingItemHistory", "type": "SoftLayer_Billing_Item_Association_History", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A history of billing items which a billing item has been associated with." }, - "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", + "associatedChildren": { + "name": "associatedChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "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", + "associatedParent": { + "name": "associatedParent", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": 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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", + "availableMatchingVlans": { + "name": "availableMatchingVlans", "type": "SoftLayer_Network_Vlan", - "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "form": "relational", + "typeArray": true }, - "getBandwidthAllocation": { - "doc": "The bandwidth allocation for a billing item.", - "docOverview": "", - "name": "getBandwidthAllocation", + "bandwidthAllocation": { + "name": "bandwidthAllocation", "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The bandwidth allocation for a 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", + "billableChildren": { + "name": "billableChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A billing item's recurring child items that have once been billed and are scheduled to be billed in the future." }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", + "bundledItems": { + "name": "bundledItems", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's bundled billing items." }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getCanceledChildren", + "canceledChildren": { + "name": "canceledChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", - "docOverview": "", - "name": "getCancellationReason", + "cancellationReason": { + "name": "cancellationReason", "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The billing item's cancellation reason." }, - "getCancellationRequests": { - "doc": "This will return any cancellation requests that are associated with this billing item.", - "docOverview": "", - "name": "getCancellationRequests", + "cancellationRequests": { + "name": "cancellationRequests", "type": "SoftLayer_Billing_Item_Cancellation_Request", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "This will return any cancellation requests that are associated with this billing item." }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", - "docOverview": "", - "name": "getCategory", + "category": { + "name": "category", "type": "SoftLayer_Product_Item_Category", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The item category to which the billing item's item belongs. " }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", + "children": { + "name": "children", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items'" }, - "getChildrenWithActiveAgreement": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getChildrenWithActiveAgreement", + "childrenWithActiveAgreement": { + "name": "childrenWithActiveAgreement", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's active child billing items." }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", - "docOverview": "", - "name": "getDowngradeItems", + "downgradeItems": { + "name": "downgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "For product items which have a downgrade path defined, this will return those product items." }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getFilteredNextInvoiceChildren", + "filteredNextInvoiceChildren": { + "name": "filteredNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "hourlyFlag": { + "name": "hourlyFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", - "docOverview": "", - "name": "getInvoiceItem", + "invoiceItem": { + "name": "invoiceItem", "type": "SoftLayer_Billing_Invoice_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Invoice items associated with this billing item" }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", - "docOverview": "", - "name": "getInvoiceItems", + "invoiceItems": { + "name": "invoiceItems", "type": "SoftLayer_Billing_Invoice_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "All invoice items associated with the billing item" }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", - "docOverview": "", - "name": "getItem", + "item": { + "name": "item", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." }, - "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", + "location": { + "name": "location", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "nextInvoiceChildren": { + "name": "nextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's child billing items and associated items'" }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", + "nextInvoiceTotalOneTimeAmount": { + "name": "nextInvoiceTotalOneTimeAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalOneTimeTaxAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", + "nextInvoiceTotalOneTimeTaxAmount": { + "name": "nextInvoiceTotalOneTimeTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items if they exist.'" }, - "getNextInvoiceTotalRecurringAmount": { - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'", - "docOverview": "", - "name": "getNextInvoiceTotalRecurringAmount", + "nextInvoiceTotalRecurringAmount": { + "name": "nextInvoiceTotalRecurringAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" }, - "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", + "nextInvoiceTotalRecurringTaxAmount": { + "name": "nextInvoiceTotalRecurringTaxAmount", "type": "float", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "nonZeroNextInvoiceChildren": { + "name": "nonZeroNextInvoiceChildren", "type": "SoftLayer_Billing_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "A Billing Item's associated child billing items, excluding ALL 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", + "orderItem": { + "name": "orderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's original order item. Simply a reference to the original order from which this billing item was created." }, - "getOriginalLocation": { - "doc": "The original physical location for this billing item--may differ from current.", - "docOverview": "", - "name": "getOriginalLocation", + "originalLocation": { + "name": "originalLocation", "type": "SoftLayer_Location", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The original physical location for this billing item--may differ from current." }, - "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", + "package": { + "name": "package", "type": "SoftLayer_Product_Package", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "getParent": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParent", + "parent": { + "name": "parent", "type": "SoftLayer_Billing_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getParentVirtualGuestBillingItem": { - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null.", - "docOverview": "", - "name": "getParentVirtualGuestBillingItem", + "parentVirtualGuestBillingItem": { + "name": "parentVirtualGuestBillingItem", "type": "SoftLayer_Billing_Item_Virtual_Guest", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "pendingCancellationFlag": { + "name": "pendingCancellationFlag", "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." }, - "getPendingOrderItem": { - "doc": "The new order item that will replace this billing item.", - "docOverview": "", - "name": "getPendingOrderItem", + "pendingOrderItem": { + "name": "pendingOrderItem", "type": "SoftLayer_Billing_Order_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "The new order item that will replace this billing item." }, - "getProvisionTransaction": { - "doc": "Provisioning transaction for this billing item", - "docOverview": "", - "name": "getProvisionTransaction", + "provisionTransaction": { + "name": "provisionTransaction", "type": "SoftLayer_Provisioning_Version1_Transaction", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "Provisioning transaction for this billing item" }, - "getSoftwareDescription": { - "doc": "A friendly description of software component", - "docOverview": "", - "name": "getSoftwareDescription", + "softwareDescription": { + "name": "softwareDescription", "type": "SoftLayer_Software_Description", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "form": "relational", + "doc": "A friendly description of software component" }, - "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", + "upgradeItem": { + "name": "upgradeItem", "type": "SoftLayer_Product_Item", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "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." }, - "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", + "upgradeItems": { + "name": "upgradeItems", "type": "SoftLayer_Product_Item", + "form": "relational", "typeArray": true, - "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 - } - ] + "doc": "Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path." }, - "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." - } - ] + "allowCancellationFlag": { + "name": "allowCancellationFlag", + "type": "int", + "form": "local", + "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " }, - "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." - } - ] + "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. " }, - "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 + "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. " }, - "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 - } - ] + "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." }, - "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" - } - ] + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date the billing item was created. You can see this date on the invoice." }, - "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" - } - ] + "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. " }, - "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" - } - ] + "cycleStartDate": { + "name": "cycleStartDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." }, - "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 + "description": { + "name": "description", + "type": "string", + "form": "local", + "doc": "A brief description of a billing item." }, - "getActiveAgreement": { - "doc": "", - "docOverview": "", - "name": "getActiveAgreement", - "type": "SoftLayer_Account_Agreement", - "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." }, - "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 + "hostName": { + "name": "hostName", + "type": "string", + "form": "local", + "doc": "The hostname is provided for server billing items" }, - "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 + "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). " }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", - "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. " }, - "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 + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The unique identifier for this billing item." }, - "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 + "laborFee": { + "name": "laborFee", + "type": "decimal", + "form": "local", + "doc": "The labor fee, if any. This is a one time charge." }, - "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 + "laborFeeTaxRate": { + "name": "laborFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which labor fees are taxed if you are a taxable customer." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", - "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "lastBillDate": { + "name": "lastBillDate", + "type": "dateTime", + "form": "local", + "doc": "The last time this billing item was charged." }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { - "doc": "", - "docOverview": "", - "name": "getActiveSparePoolAssociatedGuestDiskBillingItems", - "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." }, - "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 + "nextBillDate": { + "name": "nextBillDate", + "type": "dateTime", + "form": "local", + "doc": "The date on which your account will be charged for this billing item. " }, - "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 + "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." }, - "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 + "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). " }, - "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 + "oneTimeFeeTaxRate": { + "name": "oneTimeFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which one time fees are taxed if you are a taxable customer." }, - "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 + "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." }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", - "type": "SoftLayer_Network_Vlan", - "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." }, - "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 + "parentId": { + "name": "parentId", + "type": "int", + "form": "local", + "doc": "The unique identifier of the parent of 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 + "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). " }, - "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 + "recurringFeeTaxRate": { + "name": "recurringFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which recurring 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 + "recurringMonths": { + "name": "recurringMonths", + "type": "int", + "form": "local", + "doc": "The number of months in which the recurring fees will be incurred." }, - "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 + "serviceProviderId": { + "name": "serviceProviderId", + "type": "int", + "form": "local", + "doc": "This is the service provider for 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 + "setupFee": { + "name": "setupFee", + "type": "decimal", + "form": "local", + "doc": "The setup fee, if any. This is a one time charge." }, - "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 + "setupFeeTaxRate": { + "name": "setupFeeTaxRate", + "type": "decimal", + "form": "local", + "doc": "The rate at which setup fees are taxed if you are a taxable customer." }, - "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 + "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." }, - "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 + "activeAssociatedGuestDiskBillingItemCount": { + "name": "activeAssociatedGuestDiskBillingItemCount", + "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 + "activeBundledItemCount": { + "name": "activeBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active 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 + "activeChildrenCount": { + "name": "activeChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing items." }, - "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 + "activeSparePoolAssociatedGuestDiskBillingItemCount": { + "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "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 + "activeSparePoolBundledItemCount": { + "name": "activeSparePoolBundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's spare pool bundled billing items." }, - "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 + "associatedBillingItemHistoryCount": { + "name": "associatedBillingItemHistoryCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a history of billing items which a billing item has been associated with." }, - "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 + "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." }, - "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 + "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." }, - "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 + "availableMatchingVlanCount": { + "name": "availableMatchingVlanCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "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 + "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." }, - "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 + "bundledItemCount": { + "name": "bundledItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's bundled 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 + "canceledChildrenCount": { + "name": "canceledChildrenCount", + "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 + "cancellationRequestCount": { + "name": "cancellationRequestCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of this will return any cancellation requests that are associated with this billing item." }, - "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 + "childrenCount": { + "name": "childrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's 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 + "childrenWithActiveAgreementCount": { + "name": "childrenWithActiveAgreementCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's active child billing 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 + "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." }, - "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 + "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." }, - "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 + "invoiceItemCount": { + "name": "invoiceItemCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all invoice items associated with the billing item" }, - "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 + "nextInvoiceChildrenCount": { + "name": "nextInvoiceChildrenCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of a Billing Item's child billing items and associated items'" }, - "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 + "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." }, - "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 + "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 + } + ] }, - "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 + "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." + } + ] }, - "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 + "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." + } + ] }, - "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, + "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, - "deprecated": false + "maskable": true }, - "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", + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", + "type": "SoftLayer_Billing_Item", "typeArray": true, - "ormMethod": 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, - "filterable": true, - "deprecated": false, - "limitable": 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_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", @@ -66510,81 +55303,243 @@ "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_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." - }, - "resourceTableId": { - "name": "resourceTableId", - "type": "int", - "form": "local", - "doc": "The resource (unique identifier) for a software virtual license 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." + }, + "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 + } + ] }, - "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." + "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." + } + ] }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "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." + } + ] }, - "activeBundledItems": { - "name": "activeBundledItems", + "getObject": { + "name": "getObject", "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." + "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 }, - "activeChildren": { - "name": "activeChildren", + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", "type": "SoftLayer_Billing_Item", - "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child 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 + } + ] }, - "activeFlag": { - "name": "activeFlag", + "removeAssociationId": { + "name": "removeAssociationId", "type": "boolean", - "form": "relational" - }, + "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", + "type": "boolean", + "form": "relational" + }, "activeSparePoolAssociatedGuestDiskBillingItems": { "name": "activeSparePoolAssociatedGuestDiskBillingItems", "type": "SoftLayer_Billing_Item", @@ -67321,588 +56276,184 @@ "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", + } + } + }, + "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", - "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 + "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 + } + ] }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", - "docOverview": "", - "name": "getHourlyFlag", + "cancelService": { + "name": "cancelService", "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 + "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." + } + ] }, - "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 + "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." + } + ] }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", - "docOverview": "", - "name": "getNextInvoiceChildren", + "getObject": { + "name": "getObject", "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, + "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, - "deprecated": false + "maskable": true }, - "getNonZeroNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.", - "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", + "getServiceBillingItemsByCategory": { + "name": "getServiceBillingItemsByCategory", "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, + "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, - "filterable": true, - "deprecated": false + "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 + } + ] }, - "getPendingCancellationFlag": { - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not.", - "docOverview": "", - "name": "getPendingCancellationFlag", + "removeAssociationId": { + "name": "removeAssociationId", "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 + "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" + } + ] }, - "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 + "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" + } + ] }, - "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 + "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_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", @@ -68526,177 +57077,110 @@ "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": { - "cancelItem": { - "name": "cancelItem", + "approveModifiedOrder": { + "name": "approveModifiedOrder", "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.", + "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.", "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." + "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." } ], - "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 - }, + "docAssociatedMethods": [ { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null + "service": "SoftLayer_Account", + "method": "getInvoices" } - ] + ], + "filterable": true, + "maskable": 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." - } - ] + "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 }, - "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": [ + "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": [ { - "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." + "service": "SoftLayer_Billing_Order_Quote", + "method": "getPdf" } ] }, - "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 + "getPdfFilename": { + "name": "getPdfFilename", + "type": "string", + "doc": "Retrieve the default filename of an order PDF. ", + "docOverview": "Retrieve the default name of the PDF" }, - "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, + "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. ", "parameters": [ { - "name": "categoryCode", + "name": "message", "type": "string", - "doc": "The category code of billing items you wish to retrieve." + "doc": "Message to return with the verified order", + "defaultValue": null }, { - "name": "includeZeroRecurringFee", + "name": "ignoreDiscountsFlag", "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", + "doc": "This flag is set and used internally", "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" - } - ] + "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." }, - "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", + "isPendingEditApproval": { + "name": "isPendingEditApproval", "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" - } - ] + "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" }, "getAccount": { - "doc": "The account that a billing item belongs to.", + "doc": "The [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) to which an order belongs.", "docOverview": "", "name": "getAccount", "type": "SoftLayer_Account", @@ -68706,57 +57190,33 @@ "filterable": true, "deprecated": false }, - "getActiveAgreement": { + "getBrand": { "doc": "", "docOverview": "", - "name": "getActiveAgreement", - "type": "SoftLayer_Account_Agreement", + "name": "getBrand", + "type": "SoftLayer_Brand", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", + "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.", "docOverview": "", - "name": "getActiveAgreementFlag", - "type": "SoftLayer_Account_Agreement", + "name": "getCart", + "type": "SoftLayer_Billing_Order_Cart", "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.", + "getCoreRestrictedItems": { + "doc": "The [SoftLayer_Billing_Order_Item](/reference/datatypes/SoftLayer_Billing_Order_Item) that are core restricted", "docOverview": "", - "name": "getActiveBundledItems", - "type": "SoftLayer_Billing_Item", + "name": "getCoreRestrictedItems", + "type": "SoftLayer_Billing_Order_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -68764,22 +57224,11 @@ "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.", + "getCreditCardTransactions": { + "doc": "All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.", "docOverview": "", - "name": "getActiveChildren", - "type": "SoftLayer_Billing_Item", + "name": "getCreditCardTransactions", + "type": "SoftLayer_Billing_Payment_Card_Transaction", "typeArray": true, "ormMethod": true, "maskable": true, @@ -68787,81 +57236,33 @@ "deprecated": false, "limitable": true }, - "getActiveFlag": { + "getExchangeRate": { "doc": "", "docOverview": "", - "name": "getActiveFlag", - "type": "boolean", + "name": "getExchangeRate", + "type": "SoftLayer_Billing_Currency_ExchangeRate", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getActiveSparePoolAssociatedGuestDiskBillingItems": { + "getInitialInvoice": { "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", + "name": "getInitialInvoice", + "type": "SoftLayer_Billing_Invoice", "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.", + "getItems": { + "doc": "The SoftLayer_Billing_Order_items included in an order.", "docOverview": "", - "name": "getAssociatedParent", - "type": "SoftLayer_Billing_Item", + "name": "getItems", + "type": "SoftLayer_Billing_Order_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -68869,140 +57270,44 @@ "deprecated": false, "limitable": true }, - "getAvailableMatchingVlans": { + "getOrderApprovalDate": { "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", + "name": "getOrderApprovalDate", + "type": "dateTime", "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.", + "getOrderNonServerMonthlyAmount": { + "doc": "An order's non-server items total monthly fee.", "docOverview": "", - "name": "getCancellationReason", - "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "name": "getOrderNonServerMonthlyAmount", + "type": "decimal", "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. ", + "getOrderServerMonthlyAmount": { + "doc": "An order's server items total monthly fee.", "docOverview": "", - "name": "getCategory", - "type": "SoftLayer_Product_Item_Category", + "name": "getOrderServerMonthlyAmount", + "type": "decimal", "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.", + "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.", "docOverview": "", - "name": "getFilteredNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", + "name": "getOrderTopLevelItems", + "type": "SoftLayer_Billing_Order_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -69010,123 +57315,110 @@ "deprecated": false, "limitable": true }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "getOrderTotalAmount": { + "doc": "This amount represents the order's initial charge including set up fee and taxes.", "docOverview": "", - "name": "getHourlyFlag", - "type": "boolean", + "name": "getOrderTotalAmount", + "type": "decimal", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", + "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.", "docOverview": "", - "name": "getInvoiceItem", - "type": "SoftLayer_Billing_Invoice_Item", + "name": "getOrderTotalOneTime", + "type": "decimal", "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.", + "getOrderTotalOneTimeAmount": { + "doc": "An order's total one time amount. This amount represents the initial fees before tax.", "docOverview": "", - "name": "getItem", - "type": "SoftLayer_Product_Item", + "name": "getOrderTotalOneTimeAmount", + "type": "decimal", "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.", + "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.", "docOverview": "", - "name": "getLocation", - "type": "SoftLayer_Location", + "name": "getOrderTotalOneTimeTaxAmount", + "type": "decimal", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", + "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.", "docOverview": "", - "name": "getNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", - "typeArray": true, + "name": "getOrderTotalRecurring", + "type": "decimal", + "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, - "limitable": true + "deprecated": false }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", + "getOrderTotalRecurringAmount": { + "doc": "An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis.", "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", - "type": "float", + "name": "getOrderTotalRecurringAmount", + "type": "decimal", "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.'", + "getOrderTotalRecurringTaxAmount": { + "doc": "The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.", "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", - "type": "float", + "name": "getOrderTotalRecurringTaxAmount", + "type": "decimal", "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.'", + "getOrderTotalSetupAmount": { + "doc": "An order's total setup fee.", "docOverview": "", - "name": "getNextInvoiceTotalRecurringAmount", - "type": "float", + "name": "getOrderTotalSetupAmount", + "type": "decimal", "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.", + "getOrderType": { + "doc": "The type of an order. This lets you know where this order was generated from.", "docOverview": "", - "name": "getNextInvoiceTotalRecurringTaxAmount", - "type": "float", + "name": "getOrderType", + "type": "SoftLayer_Billing_Order_Type", "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.", + "getPaypalTransactions": { + "doc": "All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.", "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", + "name": "getPaypalTransactions", + "type": "SoftLayer_Billing_Payment_PayPal_Transaction", "typeArray": true, "ormMethod": true, "maskable": true, @@ -69134,65 +57426,43 @@ "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.", + "getPresaleEvent": { + "doc": "", "docOverview": "", - "name": "getPackage", - "type": "SoftLayer_Product_Package", + "name": "getPresaleEvent", + "type": "SoftLayer_Sales_Presale_Event", "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.", + "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'", "docOverview": "", - "name": "getParent", - "type": "SoftLayer_Billing_Item", + "name": "getQuote", + "type": "SoftLayer_Billing_Order_Quote", "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.", + "getReferralPartner": { + "doc": "The Referral Partner who referred this order. (Only necessary for new customer orders)", "docOverview": "", - "name": "getParentVirtualGuestBillingItem", - "type": "SoftLayer_Billing_Item_Virtual_Guest", + "name": "getReferralPartner", + "type": "SoftLayer_Account", "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.", + "getUpgradeRequestFlag": { + "doc": "This flag indicates an order is an upgrade.", "docOverview": "", - "name": "getPendingCancellationFlag", + "name": "getUpgradeRequestFlag", "type": "boolean", "typeArray": null, "ormMethod": true, @@ -69200,870 +57470,538 @@ "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.", + "getUserRecord": { + "doc": "The SoftLayer_User_Customer object tied to an order.", "docOverview": "", - "name": "getUpgradeItem", - "type": "SoftLayer_Product_Item", + "name": "getUserRecord", + "type": "SoftLayer_User_Customer", "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_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. ", + }, + "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. ", "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 account that a billing item belongs to." + "doc": "The [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) to which an order belongs." }, - "activeAgreement": { - "name": "activeAgreement", - "type": "SoftLayer_Account_Agreement", + "brand": { + "name": "brand", + "type": "SoftLayer_Brand", "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", + "cart": { + "name": "cart", + "type": "SoftLayer_Billing_Order_Cart", "form": "relational", - "typeArray": true + "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." }, - "activeBundledItems": { - "name": "activeBundledItems", - "type": "SoftLayer_Billing_Item", + "coreRestrictedItems": { + "name": "coreRestrictedItems", + "type": "SoftLayer_Billing_Order_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." + "doc": "The [SoftLayer_Billing_Order_Item](/reference/datatypes/SoftLayer_Billing_Order_Item) that are core restricted" }, - "activeChildren": { - "name": "activeChildren", - "type": "SoftLayer_Billing_Item", + "creditCardTransactions": { + "name": "creditCardTransactions", + "type": "SoftLayer_Billing_Payment_Card_Transaction", "form": "relational", "typeArray": true, - "doc": "A Billing Item's active child billing items." + "doc": "All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty." }, - "activeFlag": { - "name": "activeFlag", - "type": "boolean", + "exchangeRate": { + "name": "exchangeRate", + "type": "SoftLayer_Billing_Currency_ExchangeRate", "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." + "initialInvoice": { + "name": "initialInvoice", + "type": "SoftLayer_Billing_Invoice", + "form": "relational" }, - "cancellationRequests": { - "name": "cancellationRequests", - "type": "SoftLayer_Billing_Item_Cancellation_Request", + "items": { + "name": "items", + "type": "SoftLayer_Billing_Order_Item", "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. " + "doc": "The SoftLayer_Billing_Order_items included in an order." }, - "children": { - "name": "children", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's child billing items'" + "orderApprovalDate": { + "name": "orderApprovalDate", + "type": "dateTime", + "form": "relational" }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", - "type": "SoftLayer_Billing_Item", + "orderNonServerMonthlyAmount": { + "name": "orderNonServerMonthlyAmount", + "type": "decimal", "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active child billing items." + "doc": "An order's non-server items total monthly fee." }, - "downgradeItems": { - "name": "downgradeItems", - "type": "SoftLayer_Product_Item", + "orderServerMonthlyAmount": { + "name": "orderServerMonthlyAmount", + "type": "decimal", "form": "relational", - "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "doc": "An order's server items total monthly fee." }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", + "orderTopLevelItems": { + "name": "orderTopLevelItems", + "type": "SoftLayer_Billing_Order_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." + "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." }, - "invoiceItem": { - "name": "invoiceItem", - "type": "SoftLayer_Billing_Invoice_Item", + "orderTotalAmount": { + "name": "orderTotalAmount", + "type": "decimal", "form": "relational", - "doc": "Invoice items associated with this billing item" + "doc": "This amount represents the order's initial charge including set up fee and taxes." }, - "invoiceItems": { - "name": "invoiceItems", - "type": "SoftLayer_Billing_Invoice_Item", + "orderTotalOneTime": { + "name": "orderTotalOneTime", + "type": "decimal", "form": "relational", - "typeArray": true, - "doc": "All invoice items associated with the billing item" + "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." }, - "item": { - "name": "item", - "type": "SoftLayer_Product_Item", + "orderTotalOneTimeAmount": { + "name": "orderTotalOneTimeAmount", + "type": "decimal", "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "doc": "An order's total one time amount. This amount represents the initial fees before tax." }, - "location": { - "name": "location", - "type": "SoftLayer_Location", + "orderTotalOneTimeTaxAmount": { + "name": "orderTotalOneTimeTaxAmount", + "type": "decimal", "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." + "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." }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", - "type": "SoftLayer_Billing_Item", + "orderTotalRecurring": { + "name": "orderTotalRecurring", + "type": "decimal", "form": "relational", - "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "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." }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", - "type": "float", + "orderTotalRecurringAmount": { + "name": "orderTotalRecurringAmount", + "type": "decimal", "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "doc": "An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis." }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", - "type": "float", + "orderTotalRecurringTaxAmount": { + "name": "orderTotalRecurringTaxAmount", + "type": "decimal", "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "doc": "The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account." }, - "nextInvoiceTotalRecurringAmount": { - "name": "nextInvoiceTotalRecurringAmount", - "type": "float", + "orderTotalSetupAmount": { + "name": "orderTotalSetupAmount", + "type": "decimal", "form": "relational", - "doc": "A Billing Item's total, including any child billing items and associated billing items if they exist.'" + "doc": "An order's total setup fee." }, - "nextInvoiceTotalRecurringTaxAmount": { - "name": "nextInvoiceTotalRecurringTaxAmount", - "type": "float", + "orderType": { + "name": "orderType", + "type": "SoftLayer_Billing_Order_Type", "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." + "doc": "The type of an order. This lets you know where this order was generated from." }, - "nonZeroNextInvoiceChildren": { - "name": "nonZeroNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", + "paypalTransactions": { + "name": "paypalTransactions", + "type": "SoftLayer_Billing_Payment_PayPal_Transaction", "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." + "doc": "All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty." }, - "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." + "presaleEvent": { + "name": "presaleEvent", + "type": "SoftLayer_Sales_Presale_Event", + "form": "relational" }, - "parent": { - "name": "parent", - "type": "SoftLayer_Billing_Item", + "quote": { + "name": "quote", + "type": "SoftLayer_Billing_Order_Quote", "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "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'" }, - "parentVirtualGuestBillingItem": { - "name": "parentVirtualGuestBillingItem", - "type": "SoftLayer_Billing_Item_Virtual_Guest", + "referralPartner": { + "name": "referralPartner", + "type": "SoftLayer_Account", "form": "relational", - "doc": "A billing item's parent item. If a billing item has no parent item then this value is null." + "doc": "The Referral Partner who referred this order. (Only necessary for new customer orders)" }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", + "upgradeRequestFlag": { + "name": "upgradeRequestFlag", "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." + "doc": "This flag indicates an order is an upgrade." }, - "upgradeItems": { - "name": "upgradeItems", - "type": "SoftLayer_Product_Item", + "userRecord": { + "name": "userRecord", + "type": "SoftLayer_User_Customer", "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." + "doc": "The SoftLayer_User_Customer object tied to an order." }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", + "accountId": { + "name": "accountId", "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." + "doc": "The account ID to which an order belongs." }, "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. " + "doc": "The point in time at which a billing item was created." }, "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." + "doc": "*" }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", + "impersonatingUserRecordId": { + "name": "impersonatingUserRecordId", + "type": "int", "form": "local", - "doc": "The last time this billing item was charged." + "doc": "The SoftLayer_User_Customer id of the portal or API user who impersonated the user which submitted an order." }, "modifyDate": { "name": "modifyDate", "type": "dateTime", "form": "local", - "doc": "The date that a billing item was last modified." + "doc": "The last time an order was updated." }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", + "orderQuoteId": { + "name": "orderQuoteId", + "type": "int", "form": "local", - "doc": "The date on which your account will be charged for this billing item. " + "doc": "The SoftLayer_Billing_Order_Quote id of the quote's user who finalized an order." }, - "notes": { - "name": "notes", - "type": "string", + "orderTypeId": { + "name": "orderTypeId", + "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." + "doc": "The SoftLayer_Billing_Order_Type id of the order." }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", + "presaleEventId": { + "name": "presaleEventId", + "type": "int", + "form": "local" + }, + "privateCloudOrderFlag": { + "name": "privateCloudOrderFlag", + "type": "boolean", "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). " + "doc": "Deprecated.", + "deprecated": true }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", + "status": { + "name": "status", + "type": "string", "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." + "doc": "Purchaser current status e.i. Approved, Pending_Approval" }, - "orderItemId": { - "name": "orderItemId", + "userRecordId": { + "name": "userRecordId", "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." + "doc": "The SoftLayer_User_Customer id of the portal or API user who submitted an order." }, - "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", + "coreRestrictedItemCount": { + "name": "coreRestrictedItemCount", "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." + "doc": "A count of the [SoftLayer_Billing_Order_Item](/reference/datatypes/SoftLayer_Billing_Order_Item) that are core restricted" }, - "invoiceItemCount": { - "name": "invoiceItemCount", + "creditCardTransactionCount": { + "name": "creditCardTransactionCount", "type": "unsignedLong", "form": "count", - "doc": "A count of all invoice items associated with the billing item" + "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." }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", + "itemCount": { + "name": "itemCount", "type": "unsignedLong", "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" + "doc": "A count of the SoftLayer_Billing_Order_items included in an order." }, - "nonZeroNextInvoiceChildrenCount": { - "name": "nonZeroNextInvoiceChildrenCount", + "orderTopLevelItemCount": { + "name": "orderTopLevelItemCount", "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 an order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI." }, - "upgradeItemCount": { - "name": "upgradeItemCount", + "paypalTransactionCount": { + "name": "paypalTransactionCount", "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." + "doc": "A count of all PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty." } - }, + } + }, + "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": { - "cancelItem": { - "name": "cancelItem", + "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", "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.", + "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.", "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." + "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.\"" } ], + "static": true, + "maskable": true, "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", + "name": "cartKey", "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null + "doc": "Key required to retrieve a cart." } ] }, - "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": [ + "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": [ { - "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." + "name": "orderData", + "type": "SoftLayer_Container_Product_Order", + "doc": "Details for an order", + "defaultValue": null + }, + { + "name": "orderBeingPlacedFlag", + "type": "boolean", + "doc": "Determines if an order is actually being placed", + "defaultValue": 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": [ + "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": [ { - "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." + "name": "orderData", + "type": "SoftLayer_Container_Product_Order", + "doc": "The order data to save as a cart" } ] }, - "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.", + "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": "categoryCode", + "name": "quoteKey", "type": "string", - "doc": "The category code of billing items you wish to retrieve." + "doc": "The 32-character random string generated when the quote was created" }, { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false + "name": "quoteId", + "type": "int", + "doc": "The quote's unique identifier (id) property" } ] }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", + "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": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." + "description": "Throws the exception 'You cannot delete a deleted quote.'" } ], "docAssociatedMethods": [ { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" + "service": "SoftLayer_Billing_Order_Quote", + "method": "deleteQuote" + }, + { + "service": "SoftLayer_Billing_Order_Quote", + "method": "saveQuote" } - ] + ], + "maskable": true }, - "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.", + "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": "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." + "description": "Throws the exception \"No quote found\"" }, { "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." + "description": "Throws the exception \"Quote is no longer valid.\"" }, { "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." + "description": "Throws the exception \"Quote expired.\"" }, { "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." + "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.\"" } ], - "docAssociatedMethods": [ + "static": true, + "maskable": true, + "parameters": [ { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" + "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": [ { - "name": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" + "name": "orderData", + "type": "SoftLayer_Container_Product_Order", + "doc": "Details required to order." } ] }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", + "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": "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." + "description": "Throws the exception 'You cannot save a saved quote.'" }, { "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." + "description": "Throws the exception 'You cannot save a deleted quote.'" }, { "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": "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": "The account that a billing item belongs to.", + "doc": "A quote's corresponding account.", "docOverview": "", "name": "getAccount", "type": "SoftLayer_Account", @@ -70073,244 +58011,164 @@ "filterable": true, "deprecated": false }, - "getActiveAgreement": { - "doc": "", + "getDoNotContactFlag": { + "doc": "Indicates whether the owner of the quote chosen to no longer be contacted.", "docOverview": "", - "name": "getActiveAgreement", - "type": "SoftLayer_Account_Agreement", + "name": "getDoNotContactFlag", + "type": "boolean", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", + "getOrder": { + "doc": "This order contains the records for which products were selected for this quote.", "docOverview": "", - "name": "getActiveAgreementFlag", - "type": "SoftLayer_Account_Agreement", + "name": "getOrder", + "type": "SoftLayer_Billing_Order", "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": "", + "getOrdersFromQuote": { + "doc": "These are all the orders that were created from this quote.", "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", - "type": "SoftLayer_Billing_Item", + "name": "getOrdersFromQuote", + "type": "SoftLayer_Billing_Order", "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." }, - "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 + "doNotContactFlag": { + "name": "doNotContactFlag", + "type": "boolean", + "form": "relational", + "doc": "Indicates whether the owner of the quote chosen to no longer be contacted." }, - "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 + "order": { + "name": "order", + "type": "SoftLayer_Billing_Order", + "form": "relational", + "doc": "This order contains the records for which products were selected for this quote." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", - "type": "SoftLayer_Billing_Item", + "ordersFromQuote": { + "name": "ordersFromQuote", + "type": "SoftLayer_Billing_Order", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "These are all the orders that were created from this quote." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", - "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "Identification Number of the account 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 + "completedPurchaseDataId": { + "name": "completedPurchaseDataId", + "type": "int", + "form": "local", + "doc": "Identification Number of the order record tied to the 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 + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "Holds the date the quote record was 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 + "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" }, - "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 + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The id use to identify a quote." }, - "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 + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", + "form": "local", + "doc": "Holds the date when the quote record was modified with reference to its creation date" }, - "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 + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The name given to quote by the initiator" }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", - "type": "SoftLayer_Network_Vlan", - "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." }, - "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 + "quoteKey": { + "name": "quoteKey", + "type": "string", + "form": "local", + "doc": "Holds system generated hash password for the Quote" }, - "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 + "status": { + "name": "status", + "type": "string", + "form": "local", + "doc": "This property Holds the current status of a Quote: pending,expired, saved or deleted" }, - "getBundledItems": { - "doc": "A Billing Item's bundled billing items.", - "docOverview": "", - "name": "getBundledItems", - "type": "SoftLayer_Billing_Item", - "typeArray": true, - "ormMethod": true, - "maskable": 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.", "filterable": true, - "deprecated": false, - "limitable": true + "maskable": true }, - "getCanceledChildren": { - "doc": "A Billing Item's active child billing items.", + "getBillingItem": { + "doc": "The SoftLayer_Billing_Item tied to the order item.", "docOverview": "", - "name": "getCanceledChildren", + "name": "getBillingItem", "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.", + "getBundledItems": { + "doc": "The other items included with an ordered item.", "docOverview": "", - "name": "getCancellationRequests", - "type": "SoftLayer_Billing_Item_Cancellation_Request", + "name": "getBundledItems", + "type": "SoftLayer_Billing_Order_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -70319,7 +58177,7 @@ "limitable": true }, "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", + "doc": "The item category tied to an order item.", "docOverview": "", "name": "getCategory", "type": "SoftLayer_Product_Item_Category", @@ -70330,34 +58188,10 @@ "deprecated": false }, "getChildren": { - "doc": "A Billing Item's child billing items'", + "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.", "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", + "type": "SoftLayer_Billing_Order_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -70365,45 +58199,44 @@ "deprecated": false, "limitable": true }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "getGlobalIdentifier": { + "doc": "A hardware's universally unique identifier.", "docOverview": "", - "name": "getFilteredNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", - "typeArray": true, + "name": "getGlobalIdentifier", + "type": "string", + "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, - "limitable": true + "deprecated": false }, - "getHourlyFlag": { - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not.", + "getHardwareGenericComponent": { + "doc": "The component type tied to an order item. All hardware-specific items should have a generic hardware component.", "docOverview": "", - "name": "getHourlyFlag", - "type": "boolean", + "name": "getHardwareGenericComponent", + "type": "SoftLayer_Hardware_Component_Model_Generic", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getInvoiceItem": { - "doc": "Invoice items associated with this billing item", + "getItem": { + "doc": "The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold.", "docOverview": "", - "name": "getInvoiceItem", - "type": "SoftLayer_Billing_Invoice_Item", + "name": "getItem", + "type": "SoftLayer_Product_Item", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", + "getItemCategoryAnswers": { + "doc": "This is an item's category answers.", "docOverview": "", - "name": "getInvoiceItems", - "type": "SoftLayer_Billing_Invoice_Item", + "name": "getItemCategoryAnswers", + "type": "SoftLayer_Billing_Order_Item_Category_Answer", "typeArray": true, "ormMethod": true, "maskable": true, @@ -70411,11 +58244,11 @@ "deprecated": false, "limitable": true }, - "getItem": { - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon.", + "getItemPrice": { + "doc": "The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item.", "docOverview": "", - "name": "getItem", - "type": "SoftLayer_Product_Item", + "name": "getItemPrice", + "type": "SoftLayer_Product_Item_Price", "typeArray": null, "ormMethod": true, "maskable": true, @@ -70423,7 +58256,7 @@ "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.", + "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.", "docOverview": "", "name": "getLocation", "type": "SoftLayer_Location", @@ -70433,11 +58266,11 @@ "filterable": true, "deprecated": false }, - "getNextInvoiceChildren": { - "doc": "A Billing Item's child billing items and associated items'", + "getNextOrderChildren": { + "doc": "", "docOverview": "", - "name": "getNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", + "name": "getNextOrderChildren", + "type": "SoftLayer_Billing_Order_Item", "typeArray": true, "ormMethod": true, "maskable": true, @@ -70445,66 +58278,54 @@ "deprecated": false, "limitable": true }, - "getNextInvoiceTotalOneTimeAmount": { - "doc": "A Billing Item's total, including any child billing items if they exist.'", + "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.", "docOverview": "", - "name": "getNextInvoiceTotalOneTimeAmount", - "type": "float", + "name": "getOldBillingItem", + "type": "SoftLayer_Billing_Item", "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.'", + "getOrder": { + "doc": "The order to which this item belongs. The order contains all the information related to the items included in an order", "docOverview": "", - "name": "getNextInvoiceTotalOneTimeTaxAmount", - "type": "float", + "name": "getOrder", + "type": "SoftLayer_Billing_Order", "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.'", + "getOrderApprovalDate": { + "doc": "", "docOverview": "", - "name": "getNextInvoiceTotalRecurringAmount", - "type": "float", + "name": "getOrderApprovalDate", + "type": "dateTime", "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.", + "getPackage": { + "doc": "The SoftLayer_Product_Package an order item is a part of.", "docOverview": "", - "name": "getNextInvoiceTotalRecurringTaxAmount", - "type": "float", + "name": "getPackage", + "type": "SoftLayer_Product_Package", "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.", + "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.", "docOverview": "", - "name": "getOrderItem", + "name": "getParent", "type": "SoftLayer_Billing_Order_Item", "typeArray": null, "ormMethod": true, @@ -70512,88 +58333,67 @@ "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.", + "getPreset": { + "doc": "The SoftLayer_Product_Package_Preset related to this order item.", "docOverview": "", - "name": "getParent", - "type": "SoftLayer_Billing_Item", + "name": "getPreset", + "type": "SoftLayer_Product_Package_Preset", "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.", + "getPromoCode": { + "doc": "", "docOverview": "", - "name": "getParentVirtualGuestBillingItem", - "type": "SoftLayer_Billing_Item_Virtual_Guest", + "name": "getPromoCode", + "type": "SoftLayer_Product_Promotion", "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.", + "getRedundantPowerSupplyCount": { + "doc": "A count of power supplies contained within this SoftLayer_Billing_Order", "docOverview": "", - "name": "getPendingCancellationFlag", - "type": "boolean", + "name": "getRedundantPowerSupplyCount", + "type": "unsignedInt", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getPendingOrderItem": { - "doc": "The new order item that will replace this billing item.", + "getSoftwareDescription": { + "doc": "For ordered items that are software items, a full description of that software can be found with this property. ", "docOverview": "", - "name": "getPendingOrderItem", - "type": "SoftLayer_Billing_Order_Item", + "name": "getSoftwareDescription", + "type": "SoftLayer_Software_Description", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getProvisionTransaction": { - "doc": "Provisioning transaction for this billing item", + "getStorageGroups": { + "doc": "The drive storage groups that are attached to this billing order item.", "docOverview": "", - "name": "getProvisionTransaction", - "type": "SoftLayer_Provisioning_Version1_Transaction", - "typeArray": null, + "name": "getStorageGroups", + "type": "SoftLayer_Configuration_Storage_Group_Order", + "typeArray": true, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false + "deprecated": false, + "limitable": true }, - "getSoftwareDescription": { - "doc": "A friendly description of software component", + "getTotalRecurringAmount": { + "doc": "The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis.", "docOverview": "", - "name": "getSoftwareDescription", - "type": "SoftLayer_Software_Description", + "name": "getTotalRecurringAmount", + "type": "float", "typeArray": null, "ormMethod": true, "maskable": true, @@ -70601,7 +58401,7 @@ "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.", + "doc": "The next SoftLayer_Product_Item in the upgrade path for this order item.", "docOverview": "", "name": "getUpgradeItem", "type": "SoftLayer_Product_Item", @@ -70610,196 +58410,608 @@ "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." }, - "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", + "bundledItems": { + "name": "bundledItems", + "type": "SoftLayer_Billing_Order_Item", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true - } - } - }, - "SoftLayer_Billing_Item_Support": { - "name": "SoftLayer_Billing_Item_Support", - "base": "SoftLayer_Billing_Item", - "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Support data type contains general information relating to a premium support offering ", - "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 - }, + "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", + "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." + } + } + }, + "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": "reason", + "name": "quoteKey", "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null + "doc": "The 32-character random string generated when the quote was created" }, { - "name": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", - "defaultValue": null + "name": "quoteId", + "type": "int", + "doc": "The quote's unique identifier (id) property" } ] }, - "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. ", + "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": "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." + "description": "Throws the exception 'You cannot delete a deleted quote.'" } - ] - }, - "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": [ + ], + "docAssociatedMethods": [ { - "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." + "service": "SoftLayer_Billing_Order_Quote", + "method": "deleteQuote" + }, + { + "service": "SoftLayer_Billing_Order_Quote", + "method": "saveQuote" } - ] + ], + "maskable": true }, "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.", + "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 }, - "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": [ + "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": [ { - "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: Order has not yet been created.'" }, { - "name": "includeZeroRecurringFee", - "type": "boolean", - "doc": "Indicates whether billing item with $0 recurring fee should be included or not", - "defaultValue": false + "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.'" } ] }, - "removeAssociationId": { - "name": "removeAssociationId", - "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", + "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": "Throw the exception \"This billing item is not an orphan billing item.\" if the given billing item has a parent billing item." - } - ], - "docAssociatedMethods": [ + "description": "Throws the exception \"No quote found\"" + }, { - "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 is no longer valid.\"" + }, { "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." + "description": "Throws the exception \"Quote expired.\"" }, { "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." + "description": "Throws the exception \"Quote has been removed from the system.\"" }, { "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." + "description": "Throws the exception \"Quote is unavailable.\"" }, { "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." + "description": "Throws the exception \"Could not authenticate quote.\"" } ], - "docAssociatedMethods": [ + "static": true, + "maskable": true, + "parameters": [ { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" + "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": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" + "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 } ] }, - "voidCancelService": { - "name": "voidCancelService", - "type": "boolean", - "doc": "Void a previously made cancellation for a service ", - "docOverview": "Void a service cancellation that was previously made.", + "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": "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." + "description": "Throws the exception 'You cannot save a saved quote.'" }, { "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." + "description": "Throws the exception 'You cannot save a deleted quote.'" }, { "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": "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": "The account that a billing item belongs to.", + "doc": "A quote's corresponding account.", "docOverview": "", "name": "getAccount", "type": "SoftLayer_Account", @@ -70809,1989 +59021,1579 @@ "filterable": true, "deprecated": false }, - "getActiveAgreement": { - "doc": "", + "getDoNotContactFlag": { + "doc": "Indicates whether the owner of the quote chosen to no longer be contacted.", "docOverview": "", - "name": "getActiveAgreement", - "type": "SoftLayer_Account_Agreement", + "name": "getDoNotContactFlag", + "type": "boolean", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getActiveAgreementFlag": { - "doc": "A flag indicating that the billing item is under an active agreement.", + "getOrder": { + "doc": "This order contains the records for which products were selected for this quote.", "docOverview": "", - "name": "getActiveAgreementFlag", - "type": "SoftLayer_Account_Agreement", + "name": "getOrder", + "type": "SoftLayer_Billing_Order", "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": "", + "getOrdersFromQuote": { + "doc": "These are all the orders that were created from this quote.", "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", - "type": "SoftLayer_Billing_Item", + "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." }, - "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 + "doNotContactFlag": { + "name": "doNotContactFlag", + "type": "boolean", + "form": "relational", + "doc": "Indicates whether the owner of the quote chosen to no longer be contacted." }, - "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 + "order": { + "name": "order", + "type": "SoftLayer_Billing_Order", + "form": "relational", + "doc": "This order contains the records for which products were selected for this quote." }, - "getActiveChildren": { - "doc": "A Billing Item's active child billing items.", - "docOverview": "", - "name": "getActiveChildren", - "type": "SoftLayer_Billing_Item", + "ordersFromQuote": { + "name": "ordersFromQuote", + "type": "SoftLayer_Billing_Order", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "These are all the orders that were created from this quote." }, - "getActiveFlag": { - "doc": "", - "docOverview": "", - "name": "getActiveFlag", - "type": "boolean", - "typeArray": null, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "Identification Number of the account 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 + "completedPurchaseDataId": { + "name": "completedPurchaseDataId", + "type": "int", + "form": "local", + "doc": "Identification Number of the order record tied to the 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 + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "Holds the date the quote record was 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 + "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" }, - "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 + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The id use to identify a quote." }, - "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 + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", + "form": "local", + "doc": "Holds the date when the quote record was modified with reference to its creation date" }, - "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 + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The name given to quote by the initiator" }, - "getAvailableMatchingVlans": { - "doc": "", - "docOverview": "", - "name": "getAvailableMatchingVlans", - "type": "SoftLayer_Network_Vlan", - "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." }, - "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 + "quoteKey": { + "name": "quoteKey", + "type": "string", + "form": "local", + "doc": "Holds system generated hash password for the Quote" }, - "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 + "status": { + "name": "status", + "type": "string", + "form": "local", + "doc": "This property Holds the current status of a Quote: pending,expired, saved or deleted" }, - "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 + "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. " }, - "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 + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "A SoftLayer order type's internal identifier. " }, - "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 + "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" }, - "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 + "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." }, - "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 + "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." }, - "getChildren": { - "doc": "A Billing Item's child billing items'", - "docOverview": "", - "name": "getChildren", - "type": "SoftLayer_Billing_Item", + "ticketAttachmentReferences": { + "name": "ticketAttachmentReferences", + "type": "SoftLayer_Ticket_Attachment", + "form": "relational", "typeArray": true, - "ormMethod": true, - "maskable": true, - "filterable": true, - "deprecated": false, - "limitable": true + "doc": "These are tickets tied to a credit card change request." }, - "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 + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "The account ID to which the credit card and billing information is associated with." }, - "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 + "amount": { + "name": "amount", + "type": "decimal", + "form": "local", + "doc": "The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD)." }, - "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 + "billingAddressLine1": { + "name": "billingAddressLine1", + "type": "string", + "form": "local", + "doc": "The physical street address. Reserve information such as \"apartment #123\" or \"Suite 2\" for line 1." }, - "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 + "billingAddressLine2": { + "name": "billingAddressLine2", + "type": "string", + "form": "local", + "doc": "The second line in the address. Information such as suite number goes here." }, - "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 + "billingCity": { + "name": "billingCity", + "type": "string", + "form": "local", + "doc": "The city in which a customer's account resides." }, - "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 + "billingCountryCode": { + "name": "billingCountryCode", + "type": "string", + "form": "local", + "doc": "The 2-character Country code for an account's address. (i.e. US)" }, - "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 + "billingEmail": { + "name": "billingEmail", + "type": "string", + "form": "local", + "doc": "The email address associated with a customer account." }, - "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 + "billingNameCompany": { + "name": "billingNameCompany", + "type": "string", + "form": "local", + "doc": "the company name for an account." }, - "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 + "billingNameFirst": { + "name": "billingNameFirst", + "type": "string", + "form": "local", + "doc": "The first name of the customer account owner." }, - "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." + "billingNameLast": { + "name": "billingNameLast", + "type": "string", + "form": "local", + "doc": "The last name of the customer account owner" }, - "activeAgreement": { - "name": "activeAgreement", - "type": "SoftLayer_Account_Agreement", - "form": "relational" + "billingPhoneFax": { + "name": "billingPhoneFax", + "type": "string", + "form": "local", + "doc": "The fax number associated with a customer account." }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", - "type": "SoftLayer_Account_Agreement", - "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "billingPhoneVoice": { + "name": "billingPhoneVoice", + "type": "string", + "form": "local", + "doc": "The phone number associated with a customer account." }, - "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." + "billingPostalCode": { + "name": "billingPostalCode", + "type": "string", + "form": "local", + "doc": "The Zip or Postal Code for the billing address on an account." }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "billingState": { + "name": "billingState", + "type": "string", + "form": "local", + "doc": "The State for the account." }, - "activeBundledItems": { - "name": "activeBundledItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "browserScreenHeight": { + "name": "browserScreenHeight", + "type": "string", + "form": "local", + "doc": "Total height of browser screen in pixels. " }, - "activeCancellationItem": { - "name": "activeCancellationItem", - "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", - "form": "relational", - "doc": "A service cancellation request item that corresponds to the billing item." + "browserScreenWidth": { + "name": "browserScreenWidth", + "type": "string", + "form": "local", + "doc": "Total width of browser screen in pixels. " }, - "activeChildren": { - "name": "activeChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active child billing items." + "cardAccountLast4": { + "name": "cardAccountLast4", + "type": "string", + "form": "local", + "doc": "The last 4 digits of a customer's credit card." }, - "activeFlag": { - "name": "activeFlag", - "type": "boolean", - "form": "relational" + "cardAccountNumber": { + "name": "cardAccountNumber", + "type": "string", + "form": "local", + "doc": "The card number submitted in the change request." }, - "activeSparePoolAssociatedGuestDiskBillingItems": { - "name": "activeSparePoolAssociatedGuestDiskBillingItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true + "cardExpirationMonth": { + "name": "cardExpirationMonth", + "type": "string", + "form": "local", + "doc": "The month (MM) in which a customer's payment card will expire." }, - "activeSparePoolBundledItems": { - "name": "activeSparePoolBundledItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's spare pool bundled billing items." + "cardExpirationYear": { + "name": "cardExpirationYear", + "type": "string", + "form": "local", + "doc": "The year (YYYY) in which a customer's payment card will expire." }, - "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." + "cardNickname": { + "name": "cardNickname", + "type": "string", + "form": "local" }, - "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." + "cardType": { + "name": "cardType", + "type": "string", + "form": "local", + "doc": "The type of payment card a customer has. (i.e. Visa, MasterCard, American Express)." }, - "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." + "creditCardVerificationNumber": { + "name": "creditCardVerificationNumber", + "type": "string", + "form": "local", + "doc": "The credit card verification number submitted in the change request." }, - "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." + "currencyShortName": { + "name": "currencyShortName", + "type": "string", + "form": "local", + "doc": "Describes the currency selected for payment" }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", - "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "deviceFingerprintId": { + "name": "deviceFingerprintId", + "type": "string", + "form": "local", + "doc": "Device Fingerprint Identifier - Used internally and can safely be ignored." }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", - "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing item." + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The unique identifier for a single change request." }, - "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." + "notes": { + "name": "notes", + "type": "string", + "form": "local", + "doc": "the notes stored about a customer's payment card." }, - "bundledItems": { - "name": "bundledItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "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. " }, - "canceledChildren": { - "name": "canceledChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active child billing items." + "payerAuthenticationEnrollmentReturnUrl": { + "name": "payerAuthenticationEnrollmentReturnUrl", + "type": "string", + "form": "local", + "doc": "The URL where the issuing bank will redirect. " }, - "cancellationReason": { - "name": "cancellationReason", - "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "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. " }, - "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." + "paymentRoleId": { + "name": "paymentRoleId", + "type": "int", + "form": "local" }, - "category": { - "name": "category", - "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "paymentType": { + "name": "paymentType", + "type": "string", + "form": "local", + "doc": "The description of the type of payment sent in a change transaction." }, - "children": { - "name": "children", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's child billing items'" + "ticketId": { + "name": "ticketId", + "type": "int", + "form": "local", + "doc": "Unique identifier for a ticket discussing the switch between payment methods." }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active child billing items." + "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" }, - "downgradeItems": { - "name": "downgradeItems", - "type": "SoftLayer_Product_Item", + "authorizedCreditCardTransaction": { + "name": "authorizedCreditCardTransaction", + "type": "SoftLayer_Billing_Payment_Card_Transaction", "form": "relational", - "typeArray": true, - "doc": "For product items which have a downgrade path defined, this will return those product items." + "doc": "This is the credit card transaction data tied to a credit card manual payment." }, - "filteredNextInvoiceChildren": { - "name": "filteredNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", + "authorizedPayPalTransaction": { + "name": "authorizedPayPalTransaction", + "type": "SoftLayer_Billing_Payment_PayPal_Transaction", "form": "relational", - "typeArray": true, - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee." + "doc": "This is the PayPal transaction data tied to a PayPal manual payment." }, - "hourlyFlag": { - "name": "hourlyFlag", - "type": "boolean", + "captureCreditCardTransaction": { + "name": "captureCreditCardTransaction", + "type": "SoftLayer_Billing_Payment_Card_Transaction", "form": "relational", - "doc": "A flag that will reflect whether this billing item is billed on an hourly basis or not." + "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." }, - "invoiceItem": { - "name": "invoiceItem", - "type": "SoftLayer_Billing_Invoice_Item", + "capturePayPalTransaction": { + "name": "capturePayPalTransaction", + "type": "SoftLayer_Billing_Payment_PayPal_Transaction", "form": "relational", - "doc": "Invoice items associated with this billing item" + "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." }, - "invoiceItems": { - "name": "invoiceItems", - "type": "SoftLayer_Billing_Invoice_Item", + "ticketAttachmentReferences": { + "name": "ticketAttachmentReferences", + "type": "SoftLayer_Ticket_Attachment", "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." + "doc": "These are tickets tied to a credit card manual payment." }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "The account ID to which the credit card and billing information is associated with." }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", - "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "amount": { + "name": "amount", + "type": "decimal", + "form": "local", + "doc": "The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD)." }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", - "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "authorizedCreditCardTransactionId": { + "name": "authorizedCreditCardTransactionId", + "type": "int", + "form": "local", + "doc": "The unique identifier of an attempted credit card transaction." }, - "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.'" + "authorizedPayPalTransactionId": { + "name": "authorizedPayPalTransactionId", + "type": "int", + "form": "local", + "doc": "The unique identifier of an attempted PayPal transaction." }, - "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." + "billingAddressLine1": { + "name": "billingAddressLine1", + "type": "string", + "form": "local", + "doc": "The physical street address. Reserve information such as \"apartment #123\" or \"Suite 2\" for line 1." }, - "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." + "billingAddressLine2": { + "name": "billingAddressLine2", + "type": "string", + "form": "local", + "doc": "The second line in the address. Information such as suite number goes here." }, - "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." + "billingCity": { + "name": "billingCity", + "type": "string", + "form": "local", + "doc": "The city in which a customer's account resides." }, - "originalLocation": { - "name": "originalLocation", - "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "billingCountryCode": { + "name": "billingCountryCode", + "type": "string", + "form": "local", + "doc": "The 2-character Country code for an account's address. (i.e. US)" }, - "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." + "billingEmail": { + "name": "billingEmail", + "type": "string", + "form": "local", + "doc": "The email address associated with a customer account." }, - "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." + "billingNameCompany": { + "name": "billingNameCompany", + "type": "string", + "form": "local", + "doc": "the company name for an account." }, - "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." + "billingNameFirst": { + "name": "billingNameFirst", + "type": "string", + "form": "local", + "doc": "The first name of the customer account owner." }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", - "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "billingNameLast": { + "name": "billingNameLast", + "type": "string", + "form": "local", + "doc": "The last name of the customer account owner." }, - "pendingOrderItem": { - "name": "pendingOrderItem", - "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "billingPhoneFax": { + "name": "billingPhoneFax", + "type": "string", + "form": "local", + "doc": "The fax number associated with a customer account." }, - "provisionTransaction": { - "name": "provisionTransaction", - "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "billingPhoneVoice": { + "name": "billingPhoneVoice", + "type": "string", + "form": "local", + "doc": "The phone number associated with a customer account." }, - "softwareDescription": { - "name": "softwareDescription", - "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" + "billingPostalCode": { + "name": "billingPostalCode", + "type": "string", + "form": "local", + "doc": "The Zip or Postal Code for the billing address on an account." }, - "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." + "billingState": { + "name": "billingState", + "type": "string", + "form": "local", + "doc": "The State for the account." }, - "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." + "browserScreenHeight": { + "name": "browserScreenHeight", + "type": "string", + "form": "local", + "doc": "Total height of browser screen in pixels. " }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", + "browserScreenWidth": { + "name": "browserScreenWidth", + "type": "string", "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " + "doc": "Total width of browser screen in pixels. " }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", + "cancelUrl": { + "name": "cancelUrl", "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. " + "doc": "The cancel URL is the page to which PayPal redirects if payment is not approved." }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", + "cardAccountHash": { + "name": "cardAccountHash", + "type": "string", "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. " + "doc": "A hash value of the credit card number." }, - "categoryCode": { - "name": "categoryCode", + "cardAccountLast4": { + "name": "cardAccountLast4", "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." + "doc": "The last 4 digits of a customer's credit card." }, - "createDate": { - "name": "createDate", - "type": "dateTime", + "cardAccountNumber": { + "name": "cardAccountNumber", + "type": "string", "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." + "doc": "The card number submitted in the change request." }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", + "cardExpirationMonth": { + "name": "cardExpirationMonth", "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. " + "doc": "The month (MM) in which a customer's payment card will expire." }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", + "cardExpirationYear": { + "name": "cardExpirationYear", + "type": "string", "form": "local", - "doc": "The last time this billing item was charged." + "doc": "The year (YYYY) in which a customer's payment card will expire." }, - "description": { - "name": "description", + "cardType": { + "name": "cardType", "type": "string", "form": "local", - "doc": "A brief description of a billing item." + "doc": "The method key of the type payment issued (Visa - 001, Mastercard - 002, American Express - 003, Discover - 004, PayPal - paypal)." }, - "domainName": { - "name": "domainName", + "creditCardVerificationNumber": { + "name": "creditCardVerificationNumber", "type": "string", "form": "local", - "doc": "The domain name is provided for server billing items." + "doc": "The credit card verification number submitted in the change request." }, - "hostName": { - "name": "hostName", + "currencyShortName": { + "name": "currencyShortName", "type": "string", "form": "local", - "doc": "The hostname is provided for server billing items" + "doc": "Describes the currency selected for payment" }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", + "deviceFingerprintId": { + "name": "deviceFingerprintId", + "type": "string", "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " + "doc": "Device Fingerprint Identifier - Used internally and can safely be ignored." }, - "hoursUsed": { - "name": "hoursUsed", + "fromIpAddress": { + "name": "fromIpAddress", "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. " + "doc": "The IP address from which the transaction originates." }, "id": { "name": "id", "type": "int", "form": "local", - "doc": "The unique identifier for this billing item." + "doc": "The unique identifier for a single manual payment request." }, - "laborFee": { - "name": "laborFee", - "type": "decimal", + "notes": { + "name": "notes", + "type": "string", "form": "local", - "doc": "The labor fee, if any. This is a one time charge." + "doc": "Notes generated as a result of the payment request." }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", + "payerAuthenticationEnrollmentReferenceId": { + "name": "payerAuthenticationEnrollmentReferenceId", + "type": "string", "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." + "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. " }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", + "payerAuthenticationEnrollmentReturnUrl": { + "name": "payerAuthenticationEnrollmentReturnUrl", + "type": "string", "form": "local", - "doc": "The last time this billing item was charged." + "doc": "The URL where the issuing bank will redirect. " }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", + "payerAuthenticationWebToken": { + "name": "payerAuthenticationWebToken", + "type": "string", "form": "local", - "doc": "The date that a billing item was last modified." + "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. " }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", + "paymentType": { + "name": "paymentType", + "type": "string", "form": "local", - "doc": "The date on which your account will be charged for this billing item. " + "doc": "The description of the type of payment sent in a change transaction." }, - "notes": { - "name": "notes", + "returnUrl": { + "name": "returnUrl", "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." + "doc": "The return URL is the page to which PayPal redirects after payment is approved." }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", + "type": { + "name": "type", + "type": "string", "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). " + "doc": "Describes the type of manual payment (PAYPAL or CREDIT_CARD)." }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", + "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": "The rate at which one time fees are taxed if you are a taxable customer." + "doc": "This is used to authenticate the customer with the authentication provider." }, - "orderItemId": { - "name": "orderItemId", - "type": "int", + "deviceDataCollectionUrl": { + "name": "deviceDataCollectionUrl", + "type": "string", "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." + "doc": "Location to send the authentication when you invoke device data collection." }, - "packageId": { - "name": "packageId", - "type": "int", + "referenceId": { + "name": "referenceId", + "type": "string", "form": "local", - "doc": "This is the package id for this billing item." + "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." }, - "parentId": { - "name": "parentId", - "type": "int", + "billingAddressLine2": { + "name": "billingAddressLine2", + "type": "string", "form": "local", - "doc": "The unique identifier of the parent of this billing item." + "doc": "The second line in the address. Information such as suite number goes here." }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", + "billingCity": { + "name": "billingCity", + "type": "string", "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " + "doc": "The city in which a customer's account resides." }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", + "billingCountryCode": { + "name": "billingCountryCode", + "type": "string", "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." + "doc": "The 2-character Country code for an account's address. (i.e. US)" }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", + "billingEmail": { + "name": "billingEmail", + "type": "string", "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." + "doc": "The email address associated with a customer account." }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", + "billingNameFirst": { + "name": "billingNameFirst", + "type": "string", "form": "local", - "doc": "This is the service provider for this billing item. " + "doc": "The first name of the customer account owner." }, - "setupFee": { - "name": "setupFee", - "type": "decimal", + "billingNameLast": { + "name": "billingNameLast", + "type": "string", "form": "local", - "doc": "The setup fee, if any. This is a one time charge." + "doc": "The last name of the customer account owner" }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", + "billingPostalCode": { + "name": "billingPostalCode", + "type": "string", "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." + "doc": "The Zip or Postal Code for the billing address on an account." }, - "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." + "billingState": { + "name": "billingState", + "type": "string", + "form": "local", + "doc": "The State for the account." }, - "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." + "cardAccountNumber": { + "name": "cardAccountNumber", + "type": "string", + "form": "local", + "doc": "The credit card number to use." }, - "invoiceItemCount": { - "name": "invoiceItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of all invoice items associated with the billing item" + "cardExpirationMonth": { + "name": "cardExpirationMonth", + "type": "int", + "form": "local", + "doc": "The payment card expiration month" }, - "nextInvoiceChildrenCount": { - "name": "nextInvoiceChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's child billing items and associated items'" + "cardExpirationYear": { + "name": "cardExpirationYear", + "type": "int", + "form": "local", + "doc": "The payment card expiration year" }, - "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." + "cardType": { + "name": "cardType", + "type": "string", + "form": "local", + "doc": "The method key of the type payment issued" }, - "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." + "creditCardVerificationNumber": { + "name": "creditCardVerificationNumber", + "type": "string", + "form": "local", + "doc": "The credit card verification number" } - } + }, + "methods": {} }, - "SoftLayer_Billing_Item_User_Customer_External_Binding": { - "name": "SoftLayer_Billing_Item_User_Customer_External_Binding", - "base": "SoftLayer_Billing_Item", + "SoftLayer_Billing_Payment_Card_Transaction": { + "name": "SoftLayer_Billing_Payment_Card_Transaction", + "base": "SoftLayer_Billing_Payment_Transaction", "noservice": true, - "typeDoc": "The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to an external authentication binding ", + "typeDoc": "The SoftLayer_Billing_Payment_Card_Transaction data type contains general information relating to attempted credit card transactions. ", "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 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." + "doc": "The account to which a transaction belongs." }, - "activeFlag": { - "name": "activeFlag", - "type": "boolean", + "order": { + "name": "order", + "type": "SoftLayer_Billing_Order", "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." + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "The account ID to which the credit card and billing information is associated with." }, - "availableMatchingVlans": { - "name": "availableMatchingVlans", - "type": "SoftLayer_Network_Vlan", - "form": "relational", - "typeArray": true + "amount": { + "name": "amount", + "type": "decimal", + "form": "local", + "doc": "The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD)." }, - "bandwidthAllocation": { - "name": "bandwidthAllocation", - "type": "SoftLayer_Network_Bandwidth_Version1_Allocation", - "form": "relational", - "doc": "The bandwidth allocation for a billing 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." }, - "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." + "billingAddressLine2": { + "name": "billingAddressLine2", + "type": "string", + "form": "local", + "doc": "The second line in the address. Information such as suite number goes here." }, - "bundledItems": { - "name": "bundledItems", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's bundled billing items." + "billingCity": { + "name": "billingCity", + "type": "string", + "form": "local", + "doc": "The city in which a customer's account resides." }, - "canceledChildren": { - "name": "canceledChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's active child billing items." + "billingCountryCode": { + "name": "billingCountryCode", + "type": "string", + "form": "local", + "doc": "The 2-character Country code for an account's address. (i.e. US)" }, - "cancellationReason": { - "name": "cancellationReason", - "type": "SoftLayer_Billing_Item_Cancellation_Reason", - "form": "relational", - "doc": "The billing item's cancellation reason." + "billingEmail": { + "name": "billingEmail", + "type": "string", + "form": "local", + "doc": "The email address 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." + "billingNameCompany": { + "name": "billingNameCompany", + "type": "string", + "form": "local", + "doc": "the company name for an account." }, - "category": { - "name": "category", - "type": "SoftLayer_Product_Item_Category", - "form": "relational", - "doc": "The item category to which the billing item's item belongs. " + "billingNameFirst": { + "name": "billingNameFirst", + "type": "string", + "form": "local", + "doc": "The first name of the customer account owner." }, - "children": { - "name": "children", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's child billing items'" + "billingNameLast": { + "name": "billingNameLast", + "type": "string", + "form": "local", + "doc": "The last name of the customer account owner." }, - "childrenWithActiveAgreement": { - "name": "childrenWithActiveAgreement", - "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." }, - "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." + "billingPhoneVoice": { + "name": "billingPhoneVoice", + "type": "string", + "form": "local", + "doc": "The phone number associated with a customer account." }, - "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." + "billingPostalCode": { + "name": "billingPostalCode", + "type": "string", + "form": "local", + "doc": "The Zip or Postal Code for the billing address on an account." }, - "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." + "billingState": { + "name": "billingState", + "type": "string", + "form": "local", + "doc": "The State for the account." }, - "invoiceItem": { - "name": "invoiceItem", - "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "doc": "Invoice items associated with this billing item" + "cardAccountLast4": { + "name": "cardAccountLast4", + "type": "int", + "form": "local", + "doc": "The last 4 digits of a customer's credit card." }, - "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": "int", + "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": "int", + "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 type of payment issued (i.e. Visa, MasterCard, American Express)." }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "createDate": { + "name": "createDate", + "type": "dateTime", + "form": "local", + "doc": "The date that the transaction was attempted." }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", - "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "id": { + "name": "id", + "type": "int", + "form": "local", + "doc": "The unique identifier for a single credit card transaction request." }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", - "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "invoiceId": { + "name": "invoiceId", + "type": "int", + "form": "local", + "doc": "Unique identifier of the invoice to which funds will be applied." }, - "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.'" + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", + "form": "local", + "doc": "The date that the transaction was modified." }, - "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." + "orderFromIpAddress": { + "name": "orderFromIpAddress", + "type": "string", + "form": "local", + "doc": "The IP address from which the transaction originates." }, - "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." + "referenceCode": { + "name": "referenceCode", + "type": "string", + "form": "local", + "doc": "A code used by the financial institution to refer to the requested transaction." }, - "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." + "requestId": { + "name": "requestId", + "type": "string", + "form": "local", + "doc": "The unique identifier of the request submitted to the financial institution." }, - "originalLocation": { - "name": "originalLocation", - "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "returnStatus": { + "name": "returnStatus", + "type": "int", + "form": "local", + "doc": "The status code returned from the financial institution." }, - "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." + "serializedReply": { + "name": "serializedReply", + "type": "string", + "form": "local", + "doc": "A serialized, delimited string of the transaction request sent to the financial institution." }, - "parent": { - "name": "parent", - "type": "SoftLayer_Billing_Item", + "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": "A billing item's parent item. If a billing item has no parent item then this value is null." + "doc": "The account to which a transaction belongs." }, - "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." + "order": { + "name": "order", + "type": "SoftLayer_Billing_Order", + "form": "relational" }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", - "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "accountId": { + "name": "accountId", + "type": "int", + "form": "local", + "doc": "The account ID to which the PayPal and billing information is associated with." }, - "pendingOrderItem": { - "name": "pendingOrderItem", - "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "addressCityName": { + "name": "addressCityName", + "type": "string", + "form": "local", + "doc": "City given in the address of the PayPal user." }, - "provisionTransaction": { - "name": "provisionTransaction", - "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "addressCountry": { + "name": "addressCountry", + "type": "string", + "form": "local", + "doc": "Country given in the named address of the PayPal user." }, - "softwareDescription": { - "name": "softwareDescription", - "type": "SoftLayer_Software_Description", - "form": "relational", - "doc": "A friendly description of software component" + "addressName": { + "name": "addressName", + "type": "string", + "form": "local", + "doc": "Name given to the address provided for the PayPal user." }, - "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." + "addressPostalCode": { + "name": "addressPostalCode", + "type": "string", + "form": "local", + "doc": "Postal Code of the address of the PayPal user." }, - "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." + "addressStateProvence": { + "name": "addressStateProvence", + "type": "string", + "form": "local", + "doc": "State or Province in the address of the PayPal user." }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", - "type": "int", + "addressStatus": { + "name": "addressStatus", + "type": "string", "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " + "doc": "PayPal defined status of the address of the PayPal user." }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", + "addressStreet1": { + "name": "addressStreet1", "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. " + "doc": "First line of the street address of the PayPal user." }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", + "addressStreet2": { + "name": "addressStreet2", + "type": "string", "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. " + "doc": "Second line of the street address of the PayPal user." }, - "categoryCode": { - "name": "categoryCode", + "contactPhone": { + "name": "contactPhone", "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." + "doc": "Phone number provided for the PayPal user." }, "createDate": { "name": "createDate", "type": "dateTime", "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." + "doc": "The date that the transaction was attempted." }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", + "exchangeRate": { + "name": "exchangeRate", "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. " + "doc": "Exchange rate imposed on the payment amount." }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", + "feeAmount": { + "name": "feeAmount", + "type": "decimal", "form": "local", - "doc": "The last time this billing item was charged." + "doc": "PayPal fee applied to the payment." }, - "description": { - "name": "description", - "type": "string", + "grossAmount": { + "name": "grossAmount", + "type": "decimal", "form": "local", - "doc": "A brief description of a billing item." + "doc": "The total amount of the payment executed by PayPal, represented in decimal format as US Dollars ($USD)." }, - "domainName": { - "name": "domainName", + "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 domain name is provided for server billing items." + "doc": "The name of the command issued to PayPal with regards to the attempted transaction." }, - "hostName": { - "name": "hostName", + "modifyDate": { + "name": "modifyDate", + "type": "dateTime", + "form": "local", + "doc": "The date that the transaction was modified." + }, + "orderFromIpAddress": { + "name": "orderFromIpAddress", "type": "string", "form": "local", - "doc": "The hostname is provided for server billing items" + "doc": "The IP address from where the PayPal payment request originated." }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", + "orderTotal": { + "name": "orderTotal", "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). " + "doc": "The amount of the payment submitted through the SoftLayer interface, represented in decimal format as US Dollars ($USD)." }, - "hoursUsed": { - "name": "hoursUsed", + "payer": { + "name": "payer", "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. " + "doc": "The PayPal user account name (email address) associated with the customer account." }, - "id": { - "name": "id", - "type": "int", + "payerBusiness": { + "name": "payerBusiness", + "type": "string", "form": "local", - "doc": "The unique identifier for this billing item." + "doc": "The name of the business associated with the PayPal user." }, - "laborFee": { - "name": "laborFee", - "type": "decimal", + "payerCountry": { + "name": "payerCountry", + "type": "string", "form": "local", - "doc": "The labor fee, if any. This is a one time charge." + "doc": "Country given in the address of the PayPal user." }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", + "payerFirstName": { + "name": "payerFirstName", + "type": "string", "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." + "doc": "First name of the PayPal user." }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", + "payerId": { + "name": "payerId", + "type": "string", "form": "local", - "doc": "The last time this billing item was charged." + "doc": "Unique PayPal user account identifier." }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", + "payerLastName": { + "name": "payerLastName", + "type": "string", "form": "local", - "doc": "The date that a billing item was last modified." + "doc": "Last name of the PayPal user." }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", + "payerStatus": { + "name": "payerStatus", + "type": "string", "form": "local", - "doc": "The date on which your account will be charged for this billing item. " + "doc": "Current PayPal status associated with the user account." }, - "notes": { - "name": "notes", - "type": "string", + "paymentDate": { + "name": "paymentDate", + "type": "dateTime", "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." + "doc": "Date that the payment was confirmed in PayPal by the user." }, - "oneTimeFee": { - "name": "oneTimeFee", - "type": "decimal", + "paymentStatus": { + "name": "paymentStatus", + "type": "string", "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). " + "doc": "PayPal defined status of the attempted payment." }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", + "paymentType": { + "name": "paymentType", + "type": "string", "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." + "doc": "PayPal defined code used to identify the type of payment. Provided in a PayPal response." }, - "orderItemId": { - "name": "orderItemId", - "type": "int", + "pendingReason": { + "name": "pendingReason", + "type": "string", "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." + "doc": "Reason provided by PayPal for a payment given a pending status." }, - "packageId": { - "name": "packageId", - "type": "int", + "serializedReply": { + "name": "serializedReply", + "type": "string", "form": "local", - "doc": "This is the package id for this billing item." + "doc": "A serialized, delimited string of the reply received from PayPal." }, - "parentId": { - "name": "parentId", - "type": "int", + "serializedRequest": { + "name": "serializedRequest", + "type": "string", "form": "local", - "doc": "The unique identifier of the parent of this billing item." + "doc": "A serialized, delimited string of the request submitted to PayPal." }, - "recurringFee": { - "name": "recurringFee", + "settleAmount": { + "name": "settleAmount", "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). " + "doc": "PayPal defined fee." }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", + "taxAmount": { + "name": "taxAmount", "type": "decimal", "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." + "doc": "Tax applied by PayPal to the payment amount." }, - "recurringMonths": { - "name": "recurringMonths", - "type": "int", + "token": { + "name": "token", + "type": "string", "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." + "doc": "Value issued by PayPal for referencing the attempted transaction." }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", + "transactionId": { + "name": "transactionId", + "type": "string", "form": "local", - "doc": "This is the service provider for this billing item. " + "doc": "Unique transaction ID provided in a PayPal response." }, - "setupFee": { - "name": "setupFee", - "type": "decimal", + "transactionType": { + "name": "transactionType", + "type": "string", "form": "local", - "doc": "The setup fee, if any. This is a one time charge." + "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 }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." + "ownerAccount": { + "name": "ownerAccount", + "type": "SoftLayer_Account", + "form": "relational" }, - "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." + "paymentMethods": { + "name": "paymentMethods", + "type": "SoftLayer_Billing_Payment_Processor_Method", + "form": "relational", + "typeArray": true }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "type": { + "name": "type", + "type": "SoftLayer_Billing_Payment_Processor_Type", + "form": "relational" }, - "activeBundledItemCount": { - "name": "activeBundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active bundled billing items." + "description": { + "name": "description", + "type": "string", + "form": "local" }, - "activeChildrenCount": { - "name": "activeChildrenCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's active child billing items." + "name": { + "name": "name", + "type": "string", + "form": "local" }, - "activeSparePoolAssociatedGuestDiskBillingItemCount": { - "name": "activeSparePoolAssociatedGuestDiskBillingItemCount", + "brandAssignmentCount": { + "name": "brandAssignmentCount", "type": "unsignedLong", "form": "count", "doc": "A count of " }, - "activeSparePoolBundledItemCount": { - "name": "activeSparePoolBundledItemCount", + "paymentMethodCount": { + "name": "paymentMethodCount", "type": "unsignedLong", "form": "count", - "doc": "A count of a Billing Item's spare pool bundled billing items." + "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" }, - "associatedBillingItemHistoryCount": { - "name": "associatedBillingItemHistoryCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a history of billing items which a billing item has been associated with." + "paymentType": { + "name": "paymentType", + "type": "SoftLayer_Billing_Payment_Type", + "form": "relational" }, - "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." + "methodKey": { + "name": "methodKey", + "type": "string", + "form": "local" }, - "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." + "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 }, - "availableMatchingVlanCount": { - "name": "availableMatchingVlanCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "description": { + "name": "description", + "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." + "keyName": { + "name": "keyName", + "type": "string", + "form": "local" }, - "bundledItemCount": { - "name": "bundledItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of a Billing Item's bundled billing items." + "name": { + "name": "name", + "type": "string", + "form": "local" }, - "canceledChildrenCount": { - "name": "canceledChildrenCount", + "paymentProcessorCount": { + "name": "paymentProcessorCount", "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'" + "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" }, - "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." + "keyName": { + "name": "keyName", + "type": "string", + "form": "local" }, - "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." + "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": { - "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." - } - ], + "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": "cancelImmediately", - "type": "boolean", - "doc": "This will trigger an immediate cancellation with a reclaim of the resource", - "defaultValue": false + "name": "account", + "type": "SoftLayer_Account", + "doc": "The template of the account object to be created." }, { - "name": "cancelAssociatedBillingItems", + "name": "bypassDuplicateAccountCheck", "type": "boolean", - "doc": "This only applies to servers and virtual servers and will", + "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": "reason", - "type": "string", - "doc": "The cancellation reason. See the documentation overview to see some possible values.", - "defaultValue": null - }, + "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": "customerNote", - "type": "string", - "doc": "Tracks any additional information that the customer wanted to provide.", + "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 } ] }, - "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": [ + "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": [ { - "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." + "name": "accountId", + "type": "int", + "doc": "The IBM Cloud infrastructure account ID the billing items belong to." } ] }, - "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": [ + "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": [ { - "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." + "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_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.", + "type": "SoftLayer_Brand", + "docOverview": "Retrieve a SoftLayer_Brand 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, + "getToken": { + "name": "getToken", + "type": "string", + "doc": "(DEPRECATED) Use [SoftLayer_User_Customer::getImpersonationToken](/reference/datatypes/$1/#$2) method. ", + "deprecated": 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 + "name": "userId", + "type": "int" } ] }, - "removeAssociationId": { - "name": "removeAssociationId", + "isIbmSlicBrand": { + "name": "isIbmSlicBrand", "type": "boolean", - "doc": "Remove the association from a billing item. ", - "docOverview": "Remove an association from an orphan billing item.", - "docErrorHandling": [ + "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": [ { - "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." + "name": "accountId", + "type": "int" } - ], - "docAssociatedMethods": [ + ] + }, + "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": [ { - "service": "SoftLayer_Billing_Item", - "method": "setAssociationId" + "name": "accountId", + "type": "int" } ] }, - "setAssociationId": { - "name": "setAssociationId", + "refreshBillingItemSnapshot": { + "name": "refreshBillingItemSnapshot", "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": [ + "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": [ { - "service": "SoftLayer_Billing_Item", - "method": "removeAssociationId" + "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": "associatedId", - "type": "int", - "doc": "the billing item to associate to this item" + "name": "accountId", + "type": "int" } ] }, - "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." - }, + "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": [ { - "exception": "SoftLayer_Exception_Public", - "description": "Throw the exception \"Cannot void cancellation. The void cnacellation period has expired.\" If the void cancellation period has expired" + "name": "accountId", + "type": "int" } ] }, "getAccount": { - "doc": "The account that a billing item belongs to.", + "doc": "", "docOverview": "", "name": "getAccount", "type": "SoftLayer_Account", @@ -72801,33 +60603,11 @@ "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.", + "getAllOwnedAccounts": { + "doc": "All accounts owned by the brand.", "docOverview": "", - "name": "getActiveAssociatedChildren", - "type": "SoftLayer_Billing_Item", + "name": "getAllOwnedAccounts", + "type": "SoftLayer_Account", "typeArray": true, "ormMethod": true, "maskable": true, @@ -72835,23 +60615,22 @@ "deprecated": false, "limitable": true }, - "getActiveAssociatedGuestDiskBillingItems": { - "doc": "", + "getAllowAccountCreationFlag": { + "doc": "This flag indicates if creation of accounts is allowed.", "docOverview": "", - "name": "getActiveAssociatedGuestDiskBillingItems", - "type": "SoftLayer_Billing_Item", - "typeArray": true, + "name": "getAllowAccountCreationFlag", + "type": "boolean", + "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, - "limitable": true + "deprecated": false }, - "getActiveBundledItems": { - "doc": "A Billing Item's active bundled billing items.", + "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": "getActiveBundledItems", - "type": "SoftLayer_Billing_Item", + "name": "getBillingItemSnapshots", + "type": "SoftLayer_Billing_Item_Chronicle", "typeArray": true, "ormMethod": true, "maskable": true, @@ -72859,33 +60638,21 @@ "deprecated": false, "limitable": true }, - "getActiveCancellationItem": { - "doc": "A service cancellation request item that corresponds to the billing item.", + "getBusinessPartner": { + "doc": "Business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level.", "docOverview": "", - "name": "getActiveCancellationItem", - "type": "SoftLayer_Billing_Item_Cancellation_Request_Item", + "name": "getBusinessPartner", + "type": "SoftLayer_Brand_Business_Partner", "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": "", + "getBusinessPartnerFlag": { + "doc": "Flag indicating if the brand is a business partner.", "docOverview": "", - "name": "getActiveFlag", + "name": "getBusinessPartnerFlag", "type": "boolean", "typeArray": null, "ormMethod": true, @@ -72893,58 +60660,22 @@ "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.", + "getCatalog": { + "doc": "The Product Catalog for the Brand", "docOverview": "", - "name": "getAssociatedBillingItem", - "type": "SoftLayer_Billing_Item", + "name": "getCatalog", + "type": "SoftLayer_Product_Catalog", "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.", + "getContacts": { + "doc": "The contacts for the brand.", "docOverview": "", - "name": "getAssociatedChildren", - "type": "SoftLayer_Billing_Item", + "name": "getContacts", + "type": "SoftLayer_Brand_Contact", "typeArray": true, "ormMethod": true, "maskable": true, @@ -72952,11 +60683,11 @@ "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.", + "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": "getAssociatedParent", - "type": "SoftLayer_Billing_Item", + "name": "getCustomerCountryLocationRestrictions", + "type": "SoftLayer_Brand_Restriction_Location_CustomerCountry", "typeArray": true, "ormMethod": true, "maskable": true, @@ -72964,81 +60695,44 @@ "deprecated": false, "limitable": true }, - "getAvailableMatchingVlans": { + "getDistributor": { "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", + "name": "getDistributor", + "type": "SoftLayer_Brand", "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.", + "getDistributorChildFlag": { + "doc": "", "docOverview": "", - "name": "getCanceledChildren", - "type": "SoftLayer_Billing_Item", - "typeArray": true, + "name": "getDistributorChildFlag", + "type": "boolean", + "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, - "limitable": true + "deprecated": false }, - "getCancellationReason": { - "doc": "The billing item's cancellation reason.", + "getDistributorFlag": { + "doc": "", "docOverview": "", - "name": "getCancellationReason", - "type": "SoftLayer_Billing_Item_Cancellation_Reason", + "name": "getDistributorFlag", + "type": "string", "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.", + "getHardware": { + "doc": "An account's associated hardware objects.", "docOverview": "", - "name": "getCancellationRequests", - "type": "SoftLayer_Billing_Item_Cancellation_Request", + "name": "getHardware", + "type": "SoftLayer_Hardware", "typeArray": true, "ormMethod": true, "maskable": true, @@ -73046,46 +60740,33 @@ "deprecated": false, "limitable": true }, - "getCategory": { - "doc": "The item category to which the billing item's item belongs. ", + "getHasAgentAdvancedSupportFlag": { + "doc": "", "docOverview": "", - "name": "getCategory", - "type": "SoftLayer_Product_Item_Category", + "name": "getHasAgentAdvancedSupportFlag", + "type": "boolean", "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.", + "getHasAgentSupportFlag": { + "doc": "", "docOverview": "", - "name": "getChildrenWithActiveAgreement", - "type": "SoftLayer_Billing_Item", - "typeArray": true, + "name": "getHasAgentSupportFlag", + "type": "boolean", + "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, - "deprecated": false, - "limitable": true + "deprecated": false }, - "getDowngradeItems": { - "doc": "For product items which have a downgrade path defined, this will return those product items.", + "getOpenTickets": { + "doc": "", "docOverview": "", - "name": "getDowngradeItems", - "type": "SoftLayer_Product_Item", + "name": "getOpenTickets", + "type": "SoftLayer_Ticket", "typeArray": true, "ormMethod": true, "maskable": true, @@ -73093,11 +60774,11 @@ "deprecated": false, "limitable": true }, - "getFilteredNextInvoiceChildren": { - "doc": "A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.", + "getOwnedAccounts": { + "doc": "Active accounts owned by the brand.", "docOverview": "", - "name": "getFilteredNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", + "name": "getOwnedAccounts", + "type": "SoftLayer_Account", "typeArray": true, "ormMethod": true, "maskable": true, @@ -73105,33 +60786,22 @@ "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", + "getSecurityLevel": { + "doc": "", "docOverview": "", - "name": "getInvoiceItem", - "type": "SoftLayer_Billing_Invoice_Item", + "name": "getSecurityLevel", + "type": "SoftLayer_Security_Level", "typeArray": null, "ormMethod": true, "maskable": true, "filterable": true, "deprecated": false }, - "getInvoiceItems": { - "doc": "All invoice items associated with the billing item", + "getTicketGroups": { + "doc": "", "docOverview": "", - "name": "getInvoiceItems", - "type": "SoftLayer_Billing_Invoice_Item", + "name": "getTicketGroups", + "type": "SoftLayer_Ticket_Group", "typeArray": true, "ormMethod": true, "maskable": true, @@ -73139,33 +60809,11 @@ "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'", + "getTickets": { + "doc": "", "docOverview": "", - "name": "getNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", + "name": "getTickets", + "type": "SoftLayer_Ticket", "typeArray": true, "ormMethod": true, "maskable": true, @@ -73173,55 +60821,11 @@ "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.", + "getUsers": { + "doc": "", "docOverview": "", - "name": "getNonZeroNextInvoiceChildren", - "type": "SoftLayer_Billing_Item", + "name": "getUsers", + "type": "SoftLayer_User_Customer", "typeArray": true, "ormMethod": true, "maskable": true, @@ -73229,121 +60833,11 @@ "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.", + "getVirtualGuests": { + "doc": "An account's associated virtual guest objects.", "docOverview": "", - "name": "getUpgradeItems", - "type": "SoftLayer_Product_Item", + "name": "getVirtualGuests", + "type": "SoftLayer_Virtual_Guest", "typeArray": true, "ormMethod": true, "maskable": true, @@ -73351,889 +60845,1537 @@ "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. ", + }, + "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": { - "billingCycleBandwidthUsage": { - "name": "billingCycleBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", + "account": { + "name": "account", + "type": "SoftLayer_Account", + "form": "relational" + }, + "allOwnedAccounts": { + "name": "allOwnedAccounts", + "type": "SoftLayer_Account", "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." + "doc": "All accounts owned by the brand." }, - "billingCyclePrivateBandwidthUsage": { - "name": "billingCyclePrivateBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", + "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": "The raw private bandwidth usage data for the current billing cycle." + "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." }, - "billingCyclePrivateUsageIn": { - "name": "billingCyclePrivateUsageIn", - "type": "decimal", + "businessPartner": { + "name": "businessPartner", + "type": "SoftLayer_Brand_Business_Partner", "form": "relational", - "doc": "The total private network inbound bandwidth for this virtual rack for the current billing cycle." + "doc": "Business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level." }, - "billingCyclePrivateUsageOut": { - "name": "billingCyclePrivateUsageOut", - "type": "decimal", + "businessPartnerFlag": { + "name": "businessPartnerFlag", + "type": "boolean", "form": "relational", - "doc": "The total private network outbound bandwidth for this virtual rack for the current billing cycle." + "doc": "Flag indicating if the brand is a business partner." }, - "billingCyclePrivateUsageTotal": { - "name": "billingCyclePrivateUsageTotal", - "type": "unsignedInt", + "catalog": { + "name": "catalog", + "type": "SoftLayer_Product_Catalog", "form": "relational", - "doc": "The total private network bandwidth for this virtual rack for the current billing cycle." + "doc": "The Product Catalog for the Brand" }, - "billingCyclePublicBandwidthUsage": { - "name": "billingCyclePublicBandwidthUsage", - "type": "SoftLayer_Network_Bandwidth_Usage", + "contacts": { + "name": "contacts", + "type": "SoftLayer_Brand_Contact", "form": "relational", "typeArray": true, - "doc": "The raw public bandwidth usage data for the current billing cycle." + "doc": "The contacts for the brand." }, - "billingCyclePublicUsageIn": { - "name": "billingCyclePublicUsageIn", - "type": "decimal", + "customerCountryLocationRestrictions": { + "name": "customerCountryLocationRestrictions", + "type": "SoftLayer_Brand_Restriction_Location_CustomerCountry", "form": "relational", - "doc": "The total public inbound bandwidth for this virtual rack for the current billing cycle." + "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." }, - "billingCyclePublicUsageOut": { - "name": "billingCyclePublicUsageOut", - "type": "decimal", - "form": "relational", - "doc": "The total public outbound bandwidth for this virtual rack for the current billing cycle." + "distributor": { + "name": "distributor", + "type": "SoftLayer_Brand", + "form": "relational" }, - "billingCyclePublicUsageTotal": { - "name": "billingCyclePublicUsageTotal", - "type": "unsignedInt", - "form": "relational", - "doc": "The total public bandwidth for this virtual rack for the current billing cycle." + "distributorChildFlag": { + "name": "distributorChildFlag", + "type": "boolean", + "form": "relational" }, - "resource": { - "name": "resource", - "type": "SoftLayer_Network_Bandwidth_Version1_Allotment", + "distributorFlag": { + "name": "distributorFlag", + "type": "string", + "form": "relational" + }, + "hardware": { + "name": "hardware", + "type": "SoftLayer_Hardware", "form": "relational", - "doc": "The virtual rack that a virtual rack billing item is associated with." + "typeArray": true, + "doc": "An account's associated hardware objects." }, - "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." + "hasAgentAdvancedSupportFlag": { + "name": "hasAgentAdvancedSupportFlag", + "type": "boolean", + "form": "relational" }, - "billingCyclePrivateBandwidthUsageCount": { - "name": "billingCyclePrivateBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw private bandwidth usage data for the current billing cycle." + "hasAgentSupportFlag": { + "name": "hasAgentSupportFlag", + "type": "boolean", + "form": "relational" }, - "billingCyclePublicBandwidthUsageCount": { - "name": "billingCyclePublicBandwidthUsageCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of the raw public bandwidth usage data for the current billing cycle." + "openTickets": { + "name": "openTickets", + "type": "SoftLayer_Ticket", + "form": "relational", + "typeArray": true }, - "account": { - "name": "account", + "ownedAccounts": { + "name": "ownedAccounts", "type": "SoftLayer_Account", "form": "relational", - "doc": "The account that a billing item belongs to." + "typeArray": true, + "doc": "Active accounts owned by the brand." }, - "activeAgreement": { - "name": "activeAgreement", - "type": "SoftLayer_Account_Agreement", + "securityLevel": { + "name": "securityLevel", + "type": "SoftLayer_Security_Level", "form": "relational" }, - "activeAgreementFlag": { - "name": "activeAgreementFlag", - "type": "SoftLayer_Account_Agreement", + "ticketGroups": { + "name": "ticketGroups", + "type": "SoftLayer_Ticket_Group", "form": "relational", - "doc": "A flag indicating that the billing item is under an active agreement." + "typeArray": true }, - "activeAssociatedChildren": { - "name": "activeAssociatedChildren", - "type": "SoftLayer_Billing_Item", + "tickets": { + "name": "tickets", + "type": "SoftLayer_Ticket", "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." + "typeArray": true }, - "activeAssociatedGuestDiskBillingItems": { - "name": "activeAssociatedGuestDiskBillingItems", - "type": "SoftLayer_Billing_Item", + "users": { + "name": "users", + "type": "SoftLayer_User_Customer", "form": "relational", "typeArray": true }, - "activeBundledItems": { - "name": "activeBundledItems", - "type": "SoftLayer_Billing_Item", + "virtualGuests": { + "name": "virtualGuests", + "type": "SoftLayer_Virtual_Guest", "form": "relational", "typeArray": true, - "doc": "A Billing Item's active bundled billing items." + "doc": "An account's associated virtual guest objects." }, - "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" + "catalogId": { + "name": "catalogId", + "type": "int", + "form": "local", + "doc": "ID of the Catalog used by this Brand" }, - "invoiceItems": { - "name": "invoiceItems", - "type": "SoftLayer_Billing_Invoice_Item", - "form": "relational", - "typeArray": true, - "doc": "All invoice items associated with the billing item" + "id": { + "name": "id", + "type": "int", + "form": "local" }, - "item": { - "name": "item", - "type": "SoftLayer_Product_Item", - "form": "relational", - "doc": "The entry in the SoftLayer product catalog that a billing item is based upon." + "keyName": { + "name": "keyName", + "type": "string", + "form": "local", + "doc": "The brand key name." }, - "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." + "longName": { + "name": "longName", + "type": "string", + "form": "local", + "doc": "The brand long name." }, - "nextInvoiceChildren": { - "name": "nextInvoiceChildren", - "type": "SoftLayer_Billing_Item", - "form": "relational", - "typeArray": true, - "doc": "A Billing Item's child billing items and associated items'" + "name": { + "name": "name", + "type": "string", + "form": "local", + "doc": "The brand name." }, - "nextInvoiceTotalOneTimeAmount": { - "name": "nextInvoiceTotalOneTimeAmount", - "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "allOwnedAccountCount": { + "name": "allOwnedAccountCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of all accounts owned by the brand." }, - "nextInvoiceTotalOneTimeTaxAmount": { - "name": "nextInvoiceTotalOneTimeTaxAmount", - "type": "float", - "form": "relational", - "doc": "A Billing Item's total, including any child billing items if they exist.'" + "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." }, - "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.'" + "contactCount": { + "name": "contactCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of the contacts for the brand." }, - "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." + "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." }, - "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." + "hardwareCount": { + "name": "hardwareCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of an account's associated hardware objects." }, - "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." + "openTicketCount": { + "name": "openTicketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "originalLocation": { - "name": "originalLocation", - "type": "SoftLayer_Location", - "form": "relational", - "doc": "The original physical location for this billing item--may differ from current." + "ownedAccountCount": { + "name": "ownedAccountCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of active accounts owned by the brand." }, - "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." + "ticketCount": { + "name": "ticketCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "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." + "ticketGroupCount": { + "name": "ticketGroupCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "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." + "userCount": { + "name": "userCount", + "type": "unsignedLong", + "form": "count", + "doc": "A count of " }, - "pendingCancellationFlag": { - "name": "pendingCancellationFlag", - "type": "boolean", - "form": "relational", - "doc": "This flag indicates whether a billing item is scheduled to be canceled or not." + "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 }, - "pendingOrderItem": { - "name": "pendingOrderItem", - "type": "SoftLayer_Billing_Order_Item", - "form": "relational", - "doc": "The new order item that will replace this billing item." + "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 }, - "provisionTransaction": { - "name": "provisionTransaction", - "type": "SoftLayer_Provisioning_Version1_Transaction", - "form": "relational", - "doc": "Provisioning transaction for this billing item" + "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 }, - "softwareDescription": { - "name": "softwareDescription", - "type": "SoftLayer_Software_Description", + "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": "A friendly description of software component" + "doc": "Brand associated with the business partner data" }, - "upgradeItem": { - "name": "upgradeItem", - "type": "SoftLayer_Product_Item", + "channel": { + "name": "channel", + "type": "SoftLayer_Business_Partner_Channel", "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." + "doc": "Channel indicator used to categorize business partner revenue." }, - "upgradeItems": { - "name": "upgradeItems", - "type": "SoftLayer_Product_Item", + "segment": { + "name": "segment", + "type": "SoftLayer_Business_Partner_Segment", "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." + "doc": "Segment indicator used to categorize business partner revenue." }, - "allowCancellationFlag": { - "name": "allowCancellationFlag", + "channelId": { + "name": "channelId", "type": "int", "form": "local", - "doc": "Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. " + "doc": "Brand business partner channel identifier " }, - "associatedBillingItemId": { - "name": "associatedBillingItemId", + "countryEnterpriseCode": { + "name": "countryEnterpriseCode", "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. " + "doc": "Brand business partner country enterprise code " }, - "cancellationDate": { - "name": "cancellationDate", - "type": "dateTime", + "resellerLevel": { + "name": "resellerLevel", + "type": "int", "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. " + "doc": "Reseller level of a brand business partner " }, - "categoryCode": { - "name": "categoryCode", + "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 category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance." + "doc": "The contact's address 1." }, - "createDate": { - "name": "createDate", - "type": "dateTime", + "address2": { + "name": "address2", + "type": "string", "form": "local", - "doc": "The date the billing item was created. You can see this date on the invoice." + "doc": "The contact's address 2." }, - "currentHourlyCharge": { - "name": "currentHourlyCharge", + "alternatePhone": { + "name": "alternatePhone", "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. " + "doc": "The contact's alternate phone number." }, - "cycleStartDate": { - "name": "cycleStartDate", - "type": "dateTime", + "brandContactTypeId": { + "name": "brandContactTypeId", + "type": "int", "form": "local", - "doc": "The last time this billing item was charged." + "doc": "The contact's type identifier." }, - "description": { - "name": "description", + "city": { + "name": "city", "type": "string", "form": "local", - "doc": "A brief description of a billing item." + "doc": "The contact's city." }, - "domainName": { - "name": "domainName", + "country": { + "name": "country", "type": "string", "form": "local", - "doc": "The domain name is provided for server billing items." + "doc": "The contact's country." }, - "hostName": { - "name": "hostName", + "email": { + "name": "email", "type": "string", "form": "local", - "doc": "The hostname is provided for server billing items" + "doc": "The contact's email address." }, - "hourlyRecurringFee": { - "name": "hourlyRecurringFee", - "type": "decimal", + "faxPhone": { + "name": "faxPhone", + "type": "string", "form": "local", - "doc": "The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). " + "doc": "The contact's fax number." }, - "hoursUsed": { - "name": "hoursUsed", + "firstName": { + "name": "firstName", "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. " + "doc": "The contact's first name." }, - "id": { - "name": "id", - "type": "int", + "lastName": { + "name": "lastName", + "type": "string", "form": "local", - "doc": "The unique identifier for this billing item." + "doc": "The contact's last name." }, - "laborFee": { - "name": "laborFee", - "type": "decimal", + "officePhone": { + "name": "officePhone", + "type": "string", "form": "local", - "doc": "The labor fee, if any. This is a one time charge." + "doc": "The contact's phone number." }, - "laborFeeTaxRate": { - "name": "laborFeeTaxRate", - "type": "decimal", + "postalCode": { + "name": "postalCode", + "type": "string", "form": "local", - "doc": "The rate at which labor fees are taxed if you are a taxable customer." + "doc": "The contact's postal code." }, - "lastBillDate": { - "name": "lastBillDate", - "type": "dateTime", + "state": { + "name": "state", + "type": "string", "form": "local", - "doc": "The last time this billing item was charged." - }, - "modifyDate": { - "name": "modifyDate", - "type": "dateTime", + "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": "The date that a billing item was last modified." + "doc": "Contact type description." }, - "nextBillDate": { - "name": "nextBillDate", - "type": "dateTime", + "keyName": { + "name": "keyName", + "type": "string", "form": "local", - "doc": "The date on which your account will be charged for this billing item. " + "doc": "Contact type key name." }, - "notes": { - "name": "notes", + "name": { + "name": "name", "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." + "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" }, - "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). " + "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 }, - "oneTimeFeeTaxRate": { - "name": "oneTimeFeeTaxRate", - "type": "decimal", - "form": "local", - "doc": "The rate at which one time fees are taxed if you are a taxable customer." + "getObject": { + "name": "getObject", + "type": "SoftLayer_Brand_Restriction_Location_CustomerCountry", + "docOverview": "Retrieve a SoftLayer_Brand_Restriction_Location_CustomerCountry record.", + "filterable": true, + "maskable": 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." + "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 }, - "packageId": { - "name": "packageId", - "type": "int", - "form": "local", - "doc": "This is the package id for this billing item." + "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." }, - "parentId": { - "name": "parentId", - "type": "int", - "form": "local", - "doc": "The unique identifier of the parent of this billing item." + "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." }, - "recurringFee": { - "name": "recurringFee", - "type": "decimal", + "brandId": { + "name": "brandId", + "type": "int", "form": "local", - "doc": "The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). " + "doc": "The brand associated with customer's account." }, - "recurringFeeTaxRate": { - "name": "recurringFeeTaxRate", - "type": "decimal", + "customerCountryCode": { + "name": "customerCountryCode", + "type": "string", "form": "local", - "doc": "The rate at which recurring fees are taxed if you are a taxable customer." + "doc": "country code associated with customer's account." }, - "recurringMonths": { - "name": "recurringMonths", + "locationId": { + "name": "locationId", "type": "int", "form": "local", - "doc": "The number of months in which the recurring fees will be incurred." - }, - "serviceProviderId": { - "name": "serviceProviderId", - "type": "int", + "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": "This is the service provider for this billing item. " + "doc": "Business partner channel description " }, - "setupFee": { - "name": "setupFee", - "type": "decimal", + "keyName": { + "name": "keyName", + "type": "string", "form": "local", - "doc": "The setup fee, if any. This is a one time charge." + "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 " }, - "setupFeeTaxRate": { - "name": "setupFeeTaxRate", - "type": "decimal", + "keyName": { + "name": "keyName", + "type": "string", "form": "local", - "doc": "The rate at which setup fees are taxed if you are a taxable customer." + "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" }, - "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." + "name": { + "name": "name", + "type": "string", + "form": "local" }, - "activeAssociatedGuestDiskBillingItemCount": { - "name": "activeAssociatedGuestDiskBillingItemCount", - "type": "unsignedLong", - "form": "count", - "doc": "A count of " + "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": "<<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 ,