Home > Aria6 User Documentation > Aria6 core api > get_client_item_prices


Returns a list of prices for inventory item.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
filter_currency_cd string 3 The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
return_no_cost_items string 5 A boolean value that asserts the API call should include no-cost items in its returned results (true/1=yes, false/0=no).
filter_item_no long 8 Aria-assigned unique identifier indicating Client Inventory Item.
filter_client_item_id string 100 Client assigned unique identifier indicating client Inventory Item.

Output Arguments

Field Name Field Type Description
item_rates hash
price double The total price for this item
price_per_unit double The price for a single unit of this item
currency_cd string The ISO-compatible 3-digit currency code for the currency this item price bills in
schedule hash
schedule_no long The ID of this rate schedule
schedule_name string Name for the rate schedule
client_rate_schedule_id string Client-defined unique identifier
currency_cd string Currency for the schedule
is_default string This flag denotes if this rate schedule is the default one for this plan. One and only one rate schedule can be marked as default. The value of 1 is defaulted for the first rate schedule for a given currency denoting it is the default. For subsequent rate schedules, the default is set to 0.  Allowable Values
tax_inclusive_ind string This flag denotes if a rate is inclusive of taxes. Valid values are: 1 - Means tax inclusive rates and 0 (default) - Means tax exclusive rates.
tier hash
from double Tiered pricing rule that specifies from units
to double Tiered pricing rule that specifies to units
amount double Tiered pricing rule that specifies rate per unit
description string This field is used to display custom rate tier description. This will override the rate tier's description at service level.
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.

Last modified


This page has no custom tags.


This page has no classifications.