Home > Aria6 User Documentation > Aria6 core api > get_client_plan_service_rates


Returns information about the rates for a particular service in a specified plan.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
  plan_no long 22 The unique plan identifier.
  client_plan_id string 100 Client-defined Plan ID for which to query available child plans
  service_no long 22 Aria-assigned unique service identifier
  client_service_id string 100 A multidimensional array of client-defined Service ID for this plan.
  alt_rate_schedule_no long 22 Alternative Rate Schedule Number. The alt_rate_schedule_no is the unique identifier for an alternative rate schedule that can be assigned to the account holder in place of the default rate schedule. This is often done by CSR's to provide special compensation or discounts as incentives to account holders.
  client_alt_rate_schedule_id string 100 Client-defined alternate rate schedule number to assign (if any). If none is specified, the default rate schedule number will be used.

Output Arguments

Field Name Field Type Description
plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
brd_arrow.gif rate_seq_no long Sequential number in the rate schedule for dertermining tiers
brd_arrow.gif from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
brd_arrow.gif to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
brd_arrow.gif rate_per_unit double The cost per unit of this service over the time period the plan is billed for
brd_arrow.gif future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
brd_arrow.gif monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif rate_tier_description string Rate Tier Description
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.