Home > Aria6 User Documentation > Aria6 core api > get_client_item_prices


Returns a list of prices for inventory item.

Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.

Input Arguments

Req Field Name Field Type Max Length Description
Asterisk_0807a.jpg client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
Asterisk_0807a.jpg 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_sku string 100 Client assigned SKU indicating client Inventory Item.

Output Arguments

Field Name Field Type Description
item_rates hash  
brd_arrow.gif price double The total price for this item
brd_arrow.gif price_per_unit double The price for a single unit of this item
brd_arrow.gif currency_cd string The ISO-compatible 3-digit currency code for the currency this item price bills in
brd_arrow.gif schedule hash  
brd_arrow.gif schedule_no long The ID of this rate schedule
brd_arrow.gif schedule_name string Name for the rate schedule
brd_arrow.gif client_rate_schedule_id string Client-defined unique identifier
brd_arrow.gif currency_cd string Currency for the schedule
brd_arrow.gif 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 for is_default

Values Description
0 this will not be mapped as default plan to the respective parent plan (default)
1 this will be mapped as default plan to the respective parent plan
brd_arrow.gif 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.
brd_arrow.gif tier hash  
brd_arrow.gif from double Tiered pricing rule that specifies from units
brd_arrow.gif to double Tiered pricing rule that specifies to units
brd_arrow.gif amount double Tiered pricing rule that specifies rate per unit
brd_arrow.gif 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.