Error Handling
Methods
- Account/
- Account/Auth/
- Account/Auth/TwoFactor/
- Account/BillingAddress/
- Account/ChangeOrder/Source/
- Account/ChatPassword/
- Account/Contact/
- Account/CreditCard/
- Account/Cycle/
- Account/Limits/
- Account/PasswordReset/
- Account/Paymethod/
- Account/SSH/Key/
- Account/Settings/
- Account/Subscriptions/
- Account/User/
- Account/User/StateData/
- Acronis/Backup/
- Asset/
- Asset/Connections/
- Asset/ControlPanel/Credentials/
- Asset/Measurements/
- Asset/Monitoring/
- Attribution/
- Basket/
- Basket/Domain/
- Basket/Item/
- Basket/Item/Config/
- Billing/
- Billing/Bill/
- Billing/Credit/
- Billing/CreditCard/Profile/
- Billing/Cycle/
- Billing/Invoice/
- Billing/Invoice/Preview/
- Billing/PayPal/Agreement/
- Billing/PayPal/Payment/
- Billing/Payment/
- Billing/Payment/Profile/
- BusinessEmail/Customer/
- BusinessEmail/Domain/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Private/Parent/
- Cloud/Server/
- Cloud/Template/
- CloudSites/
- CloudSites/Usage/
- CodeGuard/User/
- Contact/
- Coupon/
- Coupon/Claim/
- Domain/
- Domain/Services/
- HostedEmail/Customer/
- HostedEmail/Domain/
- Licensing/
- Licensing/Cpanel/
- Licensing/Plesk/
- Market/Bundle/
- Market/Bundle/Package/
- Market/Cart/
- Market/Cart/Admin/Quote/
- Market/Cart/Discount/
- Market/Cart/Helpers/Configurator/
- Market/Cart/Item/
- Market/Package/
- Market/Package/Product/
- Market/Place/
- Meta/Timing/
- Migration/
- Migration/Account/
- Migration/Account/Server/
- Migration/Account/Server/Access/
- Migration/Destination/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/MWP/
- Monitoring/Services/
- Network/CDN/User/
- Network/CDN/Zone/
- Network/DNS/Domain/
- Network/DNS/Domain/Contact/
- Network/DNS/Domain/Nameserver/
- Network/DNS/Domain/Transfer/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/DNS/Zone/History/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/SSHKey/
- Network/Util/
- Network/Zone/
- Notifications/
- OneTimeSecret/
- Order/AddOn/
- Product/
- Product/Addon/
- Product/Marketplace/
- Product/Series/
- Project/
- SSL/Certificate/
- Salesforce/Account/InterWorx/
- Salesforce/Chat/Auth/
- Salesforce/User/
- Server/
- Server/Auth/
- Server/Power/
- Server/VirtualDomain/
- Server/WHM/AccessHash/
- Server/WHM/DNS/
- Server/WHM/Firewall/
- Signup/Basic/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Storage/ObjectStore/
- Support/Alert/
- Support/Request/
- Support/Request/Attachment/
- Support/SystemStatus/
- Support/Ticket/Auth/
- Tags/Product/
- UserTask/
- Utilities/Info/
- VIP/
- VMware/vCloud/vDC/
- VPN/
- VPN/User/
- WWW/Cart/
- WordPress/Domain/
API Documentation (API Version bleed)
Product/
DESCRIPTION
This section contains some basic methods for getting lists of products, and details, prices of products.
detailList
URL:
https://api.liquidweb.com/bleed/Product/detailList
Description:
Returns a datastructure with information about a products pricing and options. The options can be a tree structure of arbitrary depth.
Parameters:
Parameter | Type | Notes |
---|---|---|
alias | An array of a string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max. | |
code | An array of a valid product code, at least 3 chars long, including at least one letter. | * Required if:
|
page_num | A positive integer value (i.e. 1 and up). | * Optional
|
page_size | A positive integer value (i.e. 1 and up). | * Optional
|
Returns:
Field | Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
item_count | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
item_total | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | An array of associative arrays containing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_num | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_size | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_total | A positive integer value (i.e. 1 and up). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/bleed/Product/details
Description:
Returns information about a product's pricing and options.
The product code for a specific server or service on an account can be found with the Server/Details method, under the 'type' field, and a list of valid product codes can be obtained via the Product/List method.
Parameters:
Parameter | Type | Notes |
---|---|---|
alias | A string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max. | |
alsowith | A single word, consisting of only letters, digits, and underscores. | |
available_only | A boolean value (0 or 1). | |
code | A valid product code, at least 3 chars long, including at least one letter. | * Required if:
|
include_pov_tags | A boolean value (0 or 1). |
Returns:
Field | Type | Notes | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
alias | A string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max. | * Optional | ||||||||||||||||||||||||
ancestorCode | A valid product code, at least 3 chars long, including at least one letter. | |||||||||||||||||||||||||
capabilities | An associative array of arbitrary keys and values. | |||||||||||||||||||||||||
categories | An array of a string permitting tabs, carriage returns and newlines | |||||||||||||||||||||||||
code | A valid product code, at least 3 chars long, including at least one letter. | |||||||||||||||||||||||||
credit_eligible | A boolean value (0 or 1). | * Optional | ||||||||||||||||||||||||
cycle | A single word, consisting of only letters, digits, hyphens, and underscores. | |||||||||||||||||||||||||
default_price | A positive floating-point value representing a price, containing 2 to 5 decimals. | |||||||||||||||||||||||||
description | A string of text, containing no newlines or other control characters. | |||||||||||||||||||||||||
discountable | A boolean value (0 or 1). | * Optional | ||||||||||||||||||||||||
features | An array of a string permitting tabs, carriage returns and newlines | |||||||||||||||||||||||||
global_discountable | A boolean value (0 or 1). | * Optional | ||||||||||||||||||||||||
option_value_features | An associative array of arbitrary keys and values. | * Optional | ||||||||||||||||||||||||
options | An array of associative arrays containing | * Optional | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
parent_product | An associative array of arbitrary keys and values. | * Optional | ||||||||||||||||||||||||
pov_tags | An array of a string of text, containing no newlines or other control characters. | * Optional | ||||||||||||||||||||||||
prices | An associative array of arbitrary keys and values. | * Optional | ||||||||||||||||||||||||
purchaseQuantityLimit | A positive integer value (i.e. 1 and up). | * Optional | ||||||||||||||||||||||||
related_product | An associative array of arbitrary keys and values. | * Optional | ||||||||||||||||||||||||
series | An array of a string of text, containing no newlines or other control characters. | |||||||||||||||||||||||||
sub_title | A string. | * Optional | ||||||||||||||||||||||||
subdomain | A single word, consisting of only letters, digits, and underscores. | * Optional | ||||||||||||||||||||||||
tax_code | A single word, consisting of only letters and digits. | * Optional | ||||||||||||||||||||||||
title | A string. | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
flatDetails
URL:
https://api.liquidweb.com/bleed/Product/flatDetails
Description:
Returns all the necessary product data in a flat structure. If called by a user associated to an account, 'extra_data' will be included to provide account specific data.
By default, data returned will be reduced, in that keys/value pairs of which the value is null or empty (e.g. {} or []), the key/value pair is deleted from the returned data.
Optional parameter 'price_time_unit_override' will re-calculate prices to the specified override price time unit unless the price time unit is 'nontemporal' or 'deferred' or 'one-time'.
Parameters:
Parameter | Type | Notes |
---|---|---|
price_time_unit_override | One of: 'hour', 'month', 'quarter', 'semiannual', 'year' | |
product_code | A valid product code, at least 3 chars long, including at least one letter. | * Required |
reduce_data | A boolean value (0 or 1). | * Optional
|
Returns:
Field | Type | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
active | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
capabilities | An array of arbitrary values. | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
categories | An array of arbitrary values. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
credit_eligible | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | A string. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discountable | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
flat_options | An array of associative arrays containing | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketplace_active | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketplace_description | A string potentially containing and/or ending with newline characters. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketplace_display_order | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketplace_public | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parent_product_id | A positive integer value (i.e. 1 and up). | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
prepay_settings | An associative array of arbitrary keys and values. | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
primary_category | A string permitting tabs, carriage returns and newlines | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_code | A valid product code, at least 3 chars long, including at least one letter. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_id | A valid id number (a positive integer). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
public | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
region_id_prices | An associative array of arbitrary keys and values. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
related_product_id | A positive integer value (i.e. 1 and up). | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
series_description | A string permitting tabs, carriage returns and newlines | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
series_display_order | A positive integer value (i.e. 1 and up). | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
series_entry_display_order | A positive integer value (i.e. 1 and up). | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sub_title | A string. | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subdomain | A single word, consisting of only letters, digits, and underscores. | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | An array of arbitrary values. | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
title | A string. | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
flatPublicDefaultOptions
URL:
https://api.liquidweb.com/bleed/Product/flatPublicDefaultOptions
Description:
Returns all the necessary product data for a default configuration in a flat structure.
By default, data returned will be reduced, in that keys/value pairs of which the value is null or empty (e.g. {} or []), the key/value pair is deleted from the returned data. Optional parameter to disable this may be passed in.
Parameters:
Parameter | Type | Notes |
---|---|---|
product_code | A valid product code, at least 3 chars long, including at least one letter. | * Required |
reduce_data | A boolean value (0 or 1). | * Optional
|
region_id | A valid id number (a positive integer). | * Required |
Returns:
Field | Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
flat_options | An array of associative arrays containing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
getProductCodeFromPath
URL:
https://api.liquidweb.com/bleed/Product/getProductCodeFromPath
Description:
Converts path elements to a product code and alias.
Parameters:
Parameter | Type | Notes |
---|---|---|
plan | A single word, consisting of only letters and digits. | * Required |
plan_type | A single word, consisting of only letters and digits. | * Required |
series | A single word, consisting of only letters and digits. | * Required |
Returns:
Field | Type |
---|---|
alias | A string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max. |
code | A valid product code, at least 3 chars long, including at least one letter. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/bleed/Product/list
Description:
Returns production information for all products, or products in a series or category depending on the arguments passed. Only returns products available to the account.
Parameters:
Parameter | Type | Notes |
---|---|---|
alsowith | A single word, consisting of only letters, digits, and underscores. | |
cart_category | Either: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits. | |
cart_plan | Either: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits. | |
cart_series | Either: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits. | |
category | A single word, consisting of only letters and digits. | |
page_num | A positive integer value (i.e. 1 and up). | * Optional
|
page_size | A positive integer value (i.e. 1 and up). | * Optional
|
series | A single word, consisting of only letters and digits. |
Returns:
Field | Type | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
item_count | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||||||||
item_total | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||||||||
items | An array of associative arrays containing | |||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||
page_num | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||||||||
page_size | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||||||||
page_total | A positive integer value (i.e. 1 and up). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
marketingList
URL:
https://api.liquidweb.com/bleed/Product/marketingList
Description:
Return required 'marketing' information for products.
Inputs includes everything that list accepts, plus key which is the option_key for certain products.
Parameters:
Parameter | Type | Notes |
---|---|---|
active | A boolean value (0 or 1). | * Optional
|
alsowith | A single word, consisting of only letters, digits, and underscores. | |
cart_category | Either: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits. | |
cart_plan | Either: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits. | |
cart_series | Either: a single word, consisting of only letters and digits.; or An array of a single word, consisting of only letters and digits. | |
category | A single word, consisting of only letters and digits. | |
featured | A boolean value (0 or 1). | |
key | A product option name. | |
page_num | A positive integer value (i.e. 1 and up). | * Optional
|
page_size | A positive integer value (i.e. 1 and up). | * Optional
|
product_code | Either: a valid product code, at least 3 chars long, including at least one letter.; or An array of a valid product code, at least 3 chars long, including at least one letter. | |
series | A single word, consisting of only letters and digits. |
Returns:
Field | Type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
item_count | A non-negative integer value (i.e. 0 and up). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
item_total | A non-negative integer value (i.e. 0 and up). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_num | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_size | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
page_total | A positive integer value (i.e. 1 and up). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
price
URL:
https://api.liquidweb.com/bleed/Product/price
Description:
Get a total price for a product, including other useful information that will affect the order.
The 'balance' is the amount of money on the account that will be used prior to attempting to charge your credit card for the server creation.
The 'initial' amount is the amount you need to prepay for the server for now until your next billing date.
The 'cc_chage' amount is the amount that will be charged to your credit card, if your account is set to the credit card payment method.
'approved' is a boolean. If true then this purchase would be allowed by the system.
Parameters:
Parameter | Type | Notes |
---|---|---|
code | A valid product code, at least 3 chars long, including at least one letter. | * Required |
features | An associative array of arbitrary keys and values. | * Required |
region | A positive integer value (i.e. 1 and up). | * Required |
Returns:
Field | Type | Notes |
---|---|---|
approved | A boolean value (0 or 1). | |
balance | A monetary value, such as -$.05, 0.05, or -5.00 | * Optional |
cc_charge | A monetary value, such as -$.05, 0.05, or -5.00 | * Optional |
hour | A monetary value, such as -$.05, 0.05, or -5.00 | * Optional |
initial | A monetary value, such as -$.05, 0.05, or -5.00 | |
month | A monetary value, such as -$.05, 0.05, or -5.00 | * Optional |
next_bill | A valid date in YYYY-MM-DD format. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
primaryCategoryMapping
URL:
https://api.liquidweb.com/bleed/Product/primaryCategoryMapping
Description:
Return a hash mapping of all product codes and the primary categories associated with them
Parameters:
No Values Defined
Returns:
Field | Type |
---|---|
One or more keys matching: a valid product code, at least 3 chars long, including at least one letter. | A single word, consisting of only letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
startingPrice
URL:
https://api.liquidweb.com/bleed/Product/startingPrice
Description:
Returns the minimal price for a product, picking the cheapest feature for each slot.
Parameters:
Parameter | Type | Notes |
---|---|---|
alsowith | A single word, consisting of only letters, digits, and underscores. | |
code | Either: a valid product code, at least 3 chars long, including at least one letter.; or An array of a valid product code, at least 3 chars long, including at least one letter. | * Required |
Returns:
Field | Type | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
items | An array of associative arrays containing | ||||||||||||
|
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
zonesWithAvailability
URL:
https://api.liquidweb.com/bleed/Product/zonesWithAvailability
Description:
Returns zone availability and the region the zone belongs to for Provisioned products.
Parameters:
Parameter | Type | Notes |
---|---|---|
product_code | A valid product code, at least 3 chars long, including at least one letter. | * Required |
region_id | A valid id number (a positive integer). |
Returns:
Field | Type |
---|---|
available | An array of arbitrary values. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types