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

 

Home > Aria6 core api > get_client_plans_basic

get_client_plans_basic

Returns a summary list of all plans associated with a 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.
  plan_no long 22 The unique plan identifier, if only one plan is desired.
  OR      
  client_plan_id string 100 Client-defined Plan ID for which to query available child plans

Output Arguments

Field Name Field Type Description
plans_basic hash  
plan_no long The unique ID of this plan
plan_name string The short name of this plan
plan_desc string The long description of this plan
supp_plan_ind long Whether or not this is a supplemental plan. If not, it is a master plan  Allowable Values
billing_interval long The interval at which this plan appears on invoices
billing_ind long Whether or not this plan is currently billable  Allowable Values
display_ind long Whether or not this plan is to be displayed to the end-users  Allowable Values
rollover_months long Number of months in which the account will change from the current plan to the pre-defined rollover plan.
rollover_plan_no long Pre-defined plan to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined rollover plan.
early_cancel_fee double Fee charged for early cancellations.
early_cancel_min_months long Number of months during which early cancellation fees would apply on plan cancellation.
suspension_period long Pre-defined period in days in which an account will degrade to Suspended status (-1) if action is not taken such as a plan or status change.
new_acct_status long The status code to assert for the new account.  Allowable Values
rollover_acct_status long Default status for new accounts created on this plan.  Allowable Values
rollover_acct_status_days long Number of days in which an account will change from the initial status code to the pre-defined rollover status code.
init_free_months long Initial free months.
plan_2_assign_on_susp long Plan to assign when an account on this plan is suspended.
default_notify_method long Default notification method given to an account that is assigned to this plan.  Allowable Values
prepaid_ind long Indicates whether or not this plan is prepaid  Allowable Values
currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
client_plan_id string Client-defined Plan ID for which to query available child plans
client_rollover_plan_id string Pre-defined plan to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined client rollover plan ID.
client_plan_id_2_assign_on_susp string Client-defined Plan ID to assign when an account on this plan is suspended.
proration_invoice_timing_cd string Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately.  Allowable Values
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.

You must to post a comment.
Last modified
14:43, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.