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


Home > Aria Crescendo admintools api > get_plans_m


Returns all service plans for client

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.
  include_rs_summary string 10 Boolean - true/false. Summary level rate schedule information for all the rate schedules that are associated with a particular plan.
  locale_no int 38 Aria-assigned unique identifier of the locale used for translations.
  locale_name string 32 Name of the locale to which the translations belong.
  include_translations string 1 Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.   Allowable Values

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error
error_msg string Textual description of any error that occurred. "OK" if there was no error.
plans hash  
plan_no int Plan Number
client_plan_id string Client defined unique identifier
plan_name string Plan Name
plan_level int Plan Level. [can be 0 or 1]; 0 - Master plan 1 - indicates Supplemental Plan
active_ind int Specifies if plan is active or inactive. Valid values are: 0 - Inactive 1 - Active
description string Plan description
is_deletable string Indicates if this plan is deletable. A plan is not deletable if it has an account assigned to it, or to its parent plan.
rate_sched hash  
details hash  
schedule_no int Schedule Number
client_rate_schedule_id string Client defined unique id for the schedule
schedule_name string Schedule Name
schedule_currency string Schedule currency
recurring_billing_interval int Recurring billing interval
usage_billing_interval int Usage billing interval
default_ind int Plan default indicator
default_ind_curr int Currency default indicator
plan_translation_info hash Array that contains all the translated values for a given locale.
locale_name string Name of the locale
locale_no int Aria-assigned unique identifier of the locale used for translations.
plan_name string Plan Name
description string Plan description
rate_sched_t hash  
schedule_no int Schedule Number
schedule_name string Schedule Name
Last modified


This page has no custom tags.


This page has no classifications.