Home > Aria6 User Documentation > Aria6 admintools api > get_plans


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.

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 billing_interval int Billing Interval [ can be either of 1, 3, 6 or 12 ) 1 - Monthly 3 - Quarterly 6 - Semi-Annually 12 - Annually
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.
Last modified


This page has no custom tags.


This page has no classifications.