Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo core api > get_rate_schedules_for_plan_m

get_rate_schedules_for_plan_m

Returns a list of rate schedules associated with a specified plan. The plan's default rate schedule will always be the first rate schedule returned and the remaining rate schedules will be sorted by schedule number.

For information on error messages generated by this API, see get_rate_schedules_for_plan_m error messages.

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.
plan_no long 22 The unique plan identifier.
OR
client_plan_id string 100 Client-defined Plan ID for which to query available child plans
currency_cd string 3 The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
locale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
OR
locale_name string 50 Name of the locale.
include_translations string 5 Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.   Allowable Values
alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
optional_transaction_qualifiers array Array of additional values you can associate with this API call.
qualifier_name string 100 Name of the field you want to associate with this API call.
qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

Field Name Field Type 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.
rate_scheds hash An array of the rate schedules for the requested plan
schedule_no long The ID of this rate schedule
schedule_name string The name of this rate schedule
schedule_currency string The currency this rate schedule is linked to
recurring_billing_interval long Number of months between billing cycles for recurring
usage_billing_interval long Number of months between billing cycles for usage
default_ind long If true, this is the default rate schedule for the default currency of the plan.   Allowable Values
display_ind long Whether or not this rate schedule is displayable   Allowable Values
default_ind_curr long If true, this is the default rate schedule for the specified currency   Allowable Values
client_rate_schedule_id string Client assigned unique rate schedule number
available_from_dt string Start date of rate schedule
available_to_dt string End date of rate schedule
followup_rs_no long Aria internal ID of follow-up default rate schedule
client_followup_rs_id string Client-defined ID of followup rate schedule
rate_sched_translations hash
locale_name string Name of the locale.
schedule_no long The ID of this rate schedule
schedule_name string The name of this rate schedule
locale_no long Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.