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



 

Home > Aria Crescendo admintools api > get_plans_m

get_plans_m

Returns all service plans for client

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.
  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.
  OR      
  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  
brd_arrow.gif plan_no int Plan Number
brd_arrow.gif client_plan_id string Client defined unique identifier
brd_arrow.gif plan_name string Plan Name
brd_arrow.gif plan_level int Plan Level. [can be 0 or 1]; 0 - Master plan 1 - indicates Supplemental Plan
brd_arrow.gif active_ind int Specifies if plan is active or inactive. Valid values are: 0 - Inactive 1 - Active
brd_arrow.gif description string Plan description
brd_arrow.gif 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.
brd_arrow.gif rate_sched hash  
brd_arrow.gif details hash  
brd_arrow.gif schedule_no int Schedule Number
brd_arrow.gif client_rate_schedule_id string Client defined unique id for the schedule
brd_arrow.gif schedule_name string Schedule Name
brd_arrow.gif schedule_currency string Schedule currency
brd_arrow.gif recurring_billing_interval int Recurring billing interval
brd_arrow.gif usage_billing_interval int Usage billing interval
brd_arrow.gif default_ind int Plan default indicator
brd_arrow.gif default_ind_curr int Currency default indicator
brd_arrow.gif plan_translation_info hash Array that contains all the translated values for a given locale.
brd_arrow.gif locale_name string Name of the locale
brd_arrow.gif locale_no int Aria-assigned unique identifier of the locale used for translations.
brd_arrow.gif plan_name string Plan Name
brd_arrow.gif description string Plan description
brd_arrow.gif rate_sched_t hash  
brd_arrow.gif schedule_no int Schedule Number
brd_arrow.gif schedule_name string Schedule Name
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.