| | | account | A valid account number, up to 6 digits in length. | * Optional | | alerts | An array of associative arrays containing | * Optional |
| | | created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | | details | An associative array of arbitrary keys and values. | | level | One of: 'error', 'info', 'warn' | | message | A string of text, containing no newlines or other control characters. | | type | A single word, consisting of only letters, digits, and underscores. |
|
| archived | A boolean value (0 or 1). | | | basket_type | A single word, consisting of only letters, digits, and underscores. | | | claimable | A boolean value (0 or 1). | * Optional | | cloneable | A boolean value (0 or 1). | * Optional | | cpqMetadata | An associative array of arbitrary keys and values. | * Optional | | created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | | | discount | A monetary value, such as -$.05, 0.05, or -5.00 | | | discountSources | An array of associative arrays containing | * Optional |
| | | amount | A positive floating-point value requiring a leading whole number. | * Optional | | by_time_unit | An array of associative arrays containing | |
| | | description | A string of text, containing no newlines or other control characters. | | discount_amount | A positive floating-point value requiring a leading whole number. |
|
| coupon_callout | A string of text, containing no newlines or other control characters. | * Optional | | coupon_code | A 6 to 40 character coupon code | * Optional | | coupon_name | A string of text, containing no newlines or other control characters. | * Optional | | created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | | | discountAmount | A monetary value, such as -$.05, 0.05, or -5.00 | * Optional | | discountStrategy | A single word, consisting of only letters, digits, and underscores. | * Optional | | discount_amount | A monetary value, such as -$.05, 0.05, or -5.00 | * Optional | | discount_strategy | A single word, consisting of only letters, digits, and underscores. | * Optional | | has_valid_product | A string of text, containing no newlines or other control characters. | * Optional | | itemDiscounts | An array of arbitrary values. | * Optional | | metadata | An associative array of arbitrary keys and values. | * Optional | | totals | An associative array containing the fields: | * Optional |
| | | basket_discount_subtotal | A monetary value, such as -$.05, 0.05, or -5.00 | | config_discount_subtotal | A monetary value, such as -$.05, 0.05, or -5.00 | | discount_total | A monetary value, such as -$.05, 0.05, or -5.00 | | item_discount_subtotal | A monetary value, such as -$.05, 0.05, or -5.00 |
|
| type | A single word, consisting of only letters, digits, and underscores. | | | uuid | A valid UUID (Universally Unique IDentifier). | |
|
| expire | Either: a valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.; or perl undef only. | * Optional | | isApproved | A boolean value (0 or 1). | * Optional | | items | An array of associative arrays containing | * Optional |
| | | alerts | An array of associative arrays containing | * Optional |
| | | created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | | details | An associative array of arbitrary keys and values. | | level | One of: 'error', 'info', 'warn' | | message | A string of text, containing no newlines or other control characters. | | type | A single word, consisting of only letters, digits, and underscores. |
|
| availableBackups | An array of associative arrays containing | * Optional |
| | | accnt | A valid account number, up to 6 digits in length. | | hv_type | A single word, consisting of only letters and digits. | | id | A positive integer value (i.e. 1 and up). | | size | A positive floating-point value requiring a leading whole number. | | template | A string. | | time_taken | A valid date and time in YYYY-MM-DD HH:MM:SS format. | | uniq_id | A six-character identifier, containing only capital letters and digits. |
|
| availableImages | An array of associative arrays containing | * Optional |
| | | accnt | A valid account number, up to 6 digits in length. | | | hv_type | A single word, consisting of only letters and digits. | | | id | A positive integer value (i.e. 1 and up). | | | name | A string permitting tabs, carriage returns and newlines (Maximum length: 80) | | | size | A positive floating-point value requiring a leading whole number. | | | source_hostname | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | | | source_uniq_id | A six-character identifier, containing only capital letters and digits. | * Optional | | template | A string. | | | template_description | A string. | | | time_taken | A valid date and time in YYYY-MM-DD HH:MM:SS format. | |
|
| base_price | A monetary value, such as -$.05, 0.05, or -5.00 | | | basket_uuid | A valid UUID (Universally Unique IDentifier). | | | configs | An array of associative arrays containing | * Optional |
| | | alerts | An array of associative arrays containing | * Optional |
| | | created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | | details | An associative array of arbitrary keys and values. | | level | One of: 'error', 'info', 'warn' | | message | A string of text, containing no newlines or other control characters. | | type | A single word, consisting of only letters, digits, and underscores. |
|
| discount | A monetary value, such as -$.05, 0.05, or -5.00 | | | discountable | A non-negative integer value (i.e. 0 and up). | * Optional | | extra_data | An associative array of arbitrary keys and values. | * Optional | | is_extra | A boolean value (0 or 1). | | | key | A product option name. | | | key_description | A string of text, containing no newlines or other control characters. | | | key_display_order | An integer value. | * Optional | | key_group | A string of text, containing no newlines or other control characters. | * Optional | | key_group_display_order | A string of text, containing no newlines or other control characters. | * Optional | | locked | A boolean value (0 or 1). | * Optional | | nonce | A valid UUID (Universally Unique IDentifier). | * Optional | | num_units | An integer value. | * Optional | | num_units_increment | A positive integer value (i.e. 1 and up). | * Optional | | num_units_locked | A boolean value (0 or 1). | * Optional | | num_units_max | A non-negative integer value (i.e. 0 and up). | * Optional | | num_units_min | A non-negative integer value (i.e. 0 and up). | * Optional | | num_units_num_set | An array of arbitrary values. | * Optional | | num_units_type | A single word, consisting of only letters, digits, and underscores. | * Optional | | options | An array of associative arrays containing | * Optional |
| | | alerts | An array of associative arrays containing | * Optional |
| | | created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | | details | An associative array of arbitrary keys and values. | | level | One of: 'error', 'info', 'warn' | | message | A string of text, containing no newlines or other control characters. | | type | A single word, consisting of only letters, digits, and underscores. |
|
| discount | A monetary value, such as -$.05, 0.05, or -5.00 | | | discountable | A non-negative integer value (i.e. 0 and up). | * Optional | | extra_data | An associative array of arbitrary keys and values. | * Optional | | is_extra | A boolean value (0 or 1). | | | key | A product option name. | | | key_description | A string of text, containing no newlines or other control characters. | | | key_display_order | An integer value. | * Optional | | key_group | A string of text, containing no newlines or other control characters. | * Optional | | key_group_display_order | A string of text, containing no newlines or other control characters. | * Optional | | locked | A boolean value (0 or 1). | * Optional | | nonce | A valid UUID (Universally Unique IDentifier). | * Optional | | num_units | An integer value. | * Optional | | num_units_increment | A positive integer value (i.e. 1 and up). | * Optional | | num_units_locked | A boolean value (0 or 1). | * Optional | | num_units_max | A non-negative integer value (i.e. 0 and up). | * Optional | | num_units_min | A non-negative integer value (i.e. 0 and up). | * Optional | | num_units_num_set | An array of arbitrary values. | * Optional | | num_units_type | A single word, consisting of only letters, digits, and underscores. | * Optional | | parent_key | A product option name. | * Optional | | parent_value | A product option value. | * Optional | | price | A monetary value, such as -$.05, 0.05, or -5.00 | | | price_delta | A monetary value, such as -$.05, 0.05, or -5.00 | | | price_total | A monetary value, such as -$.05, 0.05, or -5.00 | | | price_total_delta | A monetary value, such as -$.05, 0.05, or -5.00 | | | ptok | A valid id number (a positive integer). | | | ptov | A valid id number (a positive integer). | | | tax | A monetary value, such as -$.05, 0.05, or -5.00 | * Optional | | value | A product option value. | | | value_comments | A string of text, containing no newlines or other control characters. | * Optional | | value_description | A string of text, containing no newlines or other control characters. | | | value_display_order | An integer value. | | | value_price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | |
|
| parent_key | A product option name. | * Optional | | parent_value | A product option value. | * Optional | | price | A monetary value, such as -$.05, 0.05, or -5.00 | | | price_total | A monetary value, such as -$.05, 0.05, or -5.00 | | | ptok | A valid id number (a positive integer). | | | ptov | A valid id number (a positive integer). | | | quote | An array of associative arrays containing | * Optional |
| | | alerts | An array of associative arrays containing | * Optional |
| | | created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | | details | An associative array of arbitrary keys and values. | | level | One of: 'error', 'info', 'warn' | | message | A string of text, containing no newlines or other control characters. | | type | A single word, consisting of only letters, digits, and underscores. |
|
| discount | A monetary value, such as -$.05, 0.05, or -5.00 | | | discount_delta | A monetary value, such as -$.05, 0.05, or -5.00 | | | discountable | A non-negative integer value (i.e. 0 and up). | * Optional | | extra_data | An associative array of arbitrary keys and values. | * Optional | | is_extra | A boolean value (0 or 1). | | | key | A product option name. | | | key_description | A string of text, containing no newlines or other control characters. | | | key_display_order | An integer value. | * Optional | | key_group | A string of text, containing no newlines or other control characters. | * Optional | | key_group_display_order | A string of text, containing no newlines or other control characters. | * Optional | | locked | A boolean value (0 or 1). | * Optional | | nonce | A valid UUID (Universally Unique IDentifier). | * Optional | | num_units | An integer value. | * Optional | | num_units_increment | A positive integer value (i.e. 1 and up). | * Optional | | num_units_locked | A boolean value (0 or 1). | * Optional | | num_units_max | A non-negative integer value (i.e. 0 and up). | * Optional | | num_units_min | A non-negative integer value (i.e. 0 and up). | * Optional | | num_units_num_set | An array of arbitrary values. | * Optional | | num_units_type | A single word, consisting of only letters, digits, and underscores. | * Optional | | parent_key | A product option name. | * Optional | | parent_value | A product option value. | * Optional | | price | A monetary value, such as -$.05, 0.05, or -5.00 | | | price_delta | A monetary value, such as -$.05, 0.05, or -5.00 | | | price_total | A monetary value, such as -$.05, 0.05, or -5.00 | | | price_total_delta | A monetary value, such as -$.05, 0.05, or -5.00 | | | ptok | A valid id number (a positive integer). | | | ptov | A valid id number (a positive integer). | | | tax | A monetary value, such as -$.05, 0.05, or -5.00 | * Optional | | tax_delta | A monetary value, such as -$.05, 0.05, or -5.00 | | | value | A product option value. | | | value_comments | A string of text, containing no newlines or other control characters. | * Optional | | value_description | A string of text, containing no newlines or other control characters. | | | value_display_order | An integer value. | | | value_price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | |
|
| tax | A monetary value, such as -$.05, 0.05, or -5.00 | * Optional | | totals | An associative array containing the fields: | * Optional |
| | | subtotal_cost | A monetary value, such as -$.05, 0.05, or -5.00 | | total_cost | A monetary value, such as -$.05, 0.05, or -5.00 |
|
| valid | A boolean value (0 or 1). | | | value | A product option value. | | | value_comments | A string of text, containing no newlines or other control characters. | * Optional | | value_description | A string of text, containing no newlines or other control characters. | | | value_display_order | An integer value. | | | value_price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | |
|
| created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | | | discount | A monetary value, such as -$.05, 0.05, or -5.00 | | | discountable | A non-negative integer value (i.e. 0 and up). | * Optional | | extra_data | An associative array of arbitrary keys and values. | * Optional | | maxDiscount | A non-negative integer value (i.e. 0 and up). | * Optional | | nonce | A valid UUID (Universally Unique IDentifier). | * Optional | | productInfo | An associative array containing the fields: | * Optional |
| | | alias | A string containing only lowercase letters, numbers, periods, hyphens, underscores, and slashes up to 100 max. | * Optional | | capabilities | An associative array of arbitrary keys and values. | * Optional | | credit_eligible | A boolean value (0 or 1). | * Optional | | cycle | A single word, consisting of only letters, digits, hyphens, and underscores. | | | defaultSubdomain | A single word, consisting of only letters, digits, and underscores. | * Optional | | discountable | A boolean value (0 or 1). | * Optional | | product_code | A valid product code, at least 3 chars long, including at least one letter. | | | product_description | A string of text, containing no newlines or other control characters. | | | product_display_group | A string consisting of only letters, digits, hyphens, spaces, and underscores. | * Optional | | series_description | A string of text, containing no newlines or other control characters. | * Optional | | series_display_order | A positive integer value (i.e. 1 and up). | * Optional | | sub_title | A string. | * Optional | | tax_code | A single word, consisting of only letters and digits. | * Optional | | title | A string. | * Optional |
|
| product_code | A valid product code, at least 3 chars long, including at least one letter. | | | properties | An associative array of arbitrary keys and values. | | | region | A positive integer value (i.e. 1 and up). | | | tax | A monetary value, such as -$.05, 0.05, or -5.00 | * Optional | | timeUnitTotals | An associative array containing the fields: | * Optional |
| | | configs_discount_total | An associative array of arbitrary keys and values. | | configs_price_total | An associative array of arbitrary keys and values. | | configs_subtotal | An associative array of arbitrary keys and values. | | configs_tax_total | An associative array of arbitrary keys and values. | | configs_total_cost | An associative array of arbitrary keys and values. | | item_discount_total | An associative array of arbitrary keys and values. | | item_price_total | An associative array of arbitrary keys and values. | | item_subtotal | An associative array of arbitrary keys and values. | | item_tax_total | An associative array of arbitrary keys and values. | | item_total_cost | An associative array of arbitrary keys and values. | | subtotal_base_cost | An associative array of arbitrary keys and values. | | total_base_cost | An associative array of arbitrary keys and values. |
|
| totals | An associative array containing the fields: | * Optional |
| | | configs_discount_total | A monetary value, such as -$.05, 0.05, or -5.00 | | configs_price_total | A monetary value, such as -$.05, 0.05, or -5.00 | | configs_subtotal | A monetary value, such as -$.05, 0.05, or -5.00 | | configs_tax_total | A monetary value, such as -$.05, 0.05, or -5.00 | | configs_total_cost | A monetary value, such as -$.05, 0.05, or -5.00 | | item_discount_total | A monetary value, such as -$.05, 0.05, or -5.00 | | item_prepay_auto_renew | Either: a boolean value (0 or 1).; or perl undef only. | | item_prepay_discount | Either: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only. | | item_prepay_once | Either: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only. | | item_prepay_ongoing | Either: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only. | | item_prepay_term_max | Either: a non-negative integer value (i.e. 0 and up).; or perl undef only. | | item_price_total | A monetary value, such as -$.05, 0.05, or -5.00 | | item_setup_fee | A monetary value, such as -$.05, 0.05, or -5.00 | | item_subtotal | A monetary value, such as -$.05, 0.05, or -5.00 | | item_tax_total | A monetary value, such as -$.05, 0.05, or -5.00 | | item_total_cost | A monetary value, such as -$.05, 0.05, or -5.00 | | subtotal_base_cost | A monetary value, such as -$.05, 0.05, or -5.00 | | total_base_cost | A monetary value, such as -$.05, 0.05, or -5.00 |
|
| uuid | A valid UUID (Universally Unique IDentifier). | | | valid | A boolean value (0 or 1). | |
|
| locked | A boolean value (0 or 1). | | | mergeable | A boolean value (0 or 1). | * Optional | | metadata | An associative array of arbitrary keys and values. | * Optional | | modifiable | A boolean value (0 or 1). | * Optional | | name | A string of text, containing no newlines or other control characters. | * Optional | | nonce | A valid UUID (Universally Unique IDentifier). | * Optional | | owner | A subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols). | * Optional | | purchasable | A boolean value (0 or 1). | * Optional | | share_code | A string of text, containing no newlines or other control characters. | | | status | A single word, consisting of only letters, digits, and underscores. | | | timeUnitTotals | An associative array containing the fields: | * Optional |
| | | items_discount_total | An associative array of arbitrary keys and values. | | items_price_total | An associative array of arbitrary keys and values. | | items_subtotal | An associative array of arbitrary keys and values. | | items_tax_total | An associative array of arbitrary keys and values. | | total_basket_cost | An associative array of arbitrary keys and values. |
|
| totals | An associative array containing the fields: | * Optional |
| | | items_discount_total | A monetary value, such as -$.05, 0.05, or -5.00 | | items_prepay_discount_total | Either: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only. | | items_prepay_once_total | Either: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only. | | items_prepay_ongoing_total | Either: a monetary value, such as -$.05, 0.05, or -5.00; or perl undef only. | | items_price_total | A monetary value, such as -$.05, 0.05, or -5.00 | | items_setup_fee_total | A monetary value, such as -$.05, 0.05, or -5.00 | | items_subtotal | A monetary value, such as -$.05, 0.05, or -5.00 | | items_tax_total | A monetary value, such as -$.05, 0.05, or -5.00 | | total_basket_cost | A monetary value, such as -$.05, 0.05, or -5.00 |
|
| unlockable | A boolean value (0 or 1). | * Optional | | uuid | A valid UUID (Universally Unique IDentifier). | | | valid | A boolean value (0 or 1). | |
|
