get_avail_plans_for_acct_m

Use this API to return a list of all plans available for assignment on a particular account. Available plans mean any master plans to create a new master plan instance(s), and any child plans (supplemental plans) of a master or supplemental plan that are available for assignment on the plan instances referred to as parent_plan_instance_no in the output array of this API.

For error messages generated by this API, see get_avail_plans_for_acct_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.
	acct_no	long	22	Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
	plan_instance_no	long	22	The unique identifier of the plan instance (can be either a master or supplemental plan) under which a new plan can be assigned. If blank, results will also include master plans available for assignment for the account.
	OR
	client_plan_instance_id	string	100	The client-defined identifier of the plan instance (can be either a master or supplemental plan) under which a new plan can be assigned. If blank, results will also include master plans available for assignment for the account.
	promo_cd	string	30	Limits the list of master plans available for assignment based on the associated promo code.
	include_full_plan_hierarchy_plans	string	5	You can use this input parameter to to additionally return plans available for assignment to all the supplemental plan instances in the hierarchy (i.e. child supplemental plan instances, grandchild supplemental plan instances, etc.) of the given plan_instance_no / client_plan_instance_id. This input is ignored if plan_instance_no / client_plan_instance_id is not passed.   Allowable Values Allowable values for include_full_plan_hierarchy_plans Values Description true Apart from returning the plans available to assign for a given plan_instance_no / client_plan_instance_id, it will additionally include plans available for assignment to all the supplemental plan instances in the plan hierarchy of the given plan_instance_no / client_plan_instance_id. false (Default) This will return the plans available to assign for the given plan_instance_no / client_plan_instance_id.
	include_rs_summary	string	5	If set to "true", will retrieve summary level rate schedule information for all the rate schedules that are associated with a particular plan. If left blank, will default to "false".   Allowable Values Allowable values for include_rs_summary Values Description true true false false
	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.
	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.
all_client_avail_plans	hash
parent_plan_instance_no	long	This references the master / supplemental plan instance to which this supplemental plan can be assigned to. If the current record's plan is a master plan, this field will be empty as the master plan will be assigned at the account level.
parent_client_plan_instance_id	string	This references the master / supplemental plan's client-defined plan instance identifier to which this supplemental plan can be assigned to. If the current record's plan is a master plan, this field will be empty as the master plan will be assigned at the account level.
plan_no	long	Aria-assigned unique plan identifier
client_plan_id	string	Client assigned unique plan identifier
plan_name	string	Plan Name
plan_desc	string	Text description of this plan
billing_ind	long	Indicates whether or not this plan is billable. This applies to Master Plans Only. Supplemental Plans inherit this property from their associated Master Plans.   Allowable Values Allowable values for billing_ind Values Description 0 Plan is not billable. 1 Plan is billable.
display_ind	long	Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable.   Allowable Values Allowable values for display_ind Values Description 0 Plan is not displayable. 1 Plan is displayable.
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.
client_rollover_plan_id	string	Pre-defined client rollover plan ID 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.
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. This field is only applicable to master plans.
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_plan_status	long	The status code to assert for the new account.   Allowable Values Allowable values for new_plan_status Values Description 0 INACTIVE 1 ACTIVE 2 CANCELLATION PENDING 3 TERMINATION PENDING 10 ACTIVE DUNNING PENDING 11 ACTIVE DUNNING 1 12 ACTIVE DUNNING 1 13 ACTIVE DUNNING 3 14 ACTIVE DUNNING 4 15 ACTIVE DUNNING 5 16 ACTIVE DUNNING 6 17 ACTIVE DUNNING 7 18 ACTIVE DUNNING 8 21 REINSTATED FORWARD BILL 22 REINSTATED BACK BILL 31 INSTALLATION PENDING 32 REGISTERED PENDING ACTIVATION 41 ACTIVE TRIAL 51 TEMPORARY SERVICE BAN 61 ACTIVE NON-BILLABLE 99 PERMANENT -1 SUSPENDED -2 CANCELLED -3 TERMINATED -4 CONTRACT EXPIRED -11 SUSPENDED DUNNING 1 -12 SUSPENDED DUNNING 2 -13 SUSPENDED DUNNING 3 -14 SUSPENDED DUNNING 4 -15 SUSPENDED DUNNING 5 -99 ARCHIVED
rollover_plan_status	long	Status used for the master plan instance at the completion of the rollover period.   Allowable Values Allowable values for rollover_plan_status Values Description 0 INACTIVE 1 ACTIVE 2 CANCELLATION PENDING 3 TERMINATION PENDING 10 ACTIVE DUNNING PENDING 11 ACTIVE DUNNING 1 12 ACTIVE DUNNING 1 13 ACTIVE DUNNING 3 14 ACTIVE DUNNING 4 15 ACTIVE DUNNING 5 16 ACTIVE DUNNING 6 17 ACTIVE DUNNING 7 18 ACTIVE DUNNING 8 21 REINSTATED FORWARD BILL 22 REINSTATED BACK BILL 31 INSTALLATION PENDING 32 REGISTERED PENDING ACTIVATION 41 ACTIVE TRIAL 51 TEMPORARY SERVICE BAN 61 ACTIVE NON-BILLABLE 99 PERMANENT -1 SUSPENDED -2 CANCELLED -3 TERMINATED -4 CONTRACT EXPIRED -11 SUSPENDED DUNNING 1 -12 SUSPENDED DUNNING 2 -13 SUSPENDED DUNNING 3 -14 SUSPENDED DUNNING 4 -15 SUSPENDED DUNNING 5 -99 ARCHIVED
rollover_plan_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.
client_plan_2_assign_on_susp	string	Client-defined Plan identifier 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 Allowable values for default_notify_method Values Description 0 None 1 HTML Email 2 Text Email 3 Text Email w/link to HTML 4 Data export 5 Printable (no Email) w/Surcharge 6 Printable & Text Email 7 Printable & HTML Email w/Surcharge 8 Printable (no Email) 9 PDF (Printing required, no Email) 10 PDF (delivered by Email) 11 PDF (Printing req & Email)w/surcharge 12 PDF (Printing req, no Email)w/surcharge 13 XML Master File 14 PDF Master File
prepaid_ind	long	Indicates whether or not this plan is prepaid   Allowable Values Allowable values for prepaid_ind Values Description 0 0 1 1
currency_cd	string	The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
rollover_plan_duration	long	Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd).
rollover_plan_uom_cd	long	Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration).   Allowable Values Allowable values for rollover_plan_uom_cd Values Description 1 Day 2 Week 3 Month 4 Quarter 5 Year
init_free_period_duration	long	Duration of the initial free period (used in conjunction with init_free_period_uom_cd).
init_free_period_uom_cd	long	Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).   Allowable Values Allowable values for init_free_period_uom_cd Values Description 1 Day 2 Week 3 Month 4 Quarter 5 Year
initial_plan_status_cd	long	Default status used when master plan is initially assigned on an account.   Allowable Values Allowable values for initial_plan_status_cd Values Description 1 ACTIVE 41 ACTIVE TRIAL 61 ACTIVE NON-BILLABLE
rollover_plan_status_duration	long	Duration of the plan status rollover period, after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjuction with rollover_plan_status_uom_cd).
rollover_plan_status_uom_cd	long	Units associated with the duration of the plan status rollover period after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status. (used in conjunction with rollover_plan_status_duration).   Allowable Values Allowable values for rollover_plan_status_uom_cd Values Description 1 Day 2 Week 3 Month 4 Quarter 5 Year
rollover_plan_status_cd	long	Status used for the master plan instance at the completion of the plan status rollover period.   Allowable Values Allowable values for rollover_plan_status_cd Values Description 1 ACTIVE 41 ACTIVE TRIAL 61 ACTIVE NON-BILLABLE
plan_rate_schedules_details	hash	An array of the rate schedules for the requested plan
schedule_no	long	The ID of this rate schedule
client_rate_schedule_id	string	Client assigned unique rate schedule number
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
recurring_billing_period_type	long	Period type for billing cycles for recurring.   Allowable Values Allowable values for recurring_billing_period_type Values Description 1 Period type for recurring billing cycle is Daily. 2 Period type for recurring billing cycle is Weekly. 3 Period type for recurring billing cycle is Monthly. 4 Period type for recurring billing cycle is Quarterly. 5 Period type for recurring billing cycle is Yearly.
usage_billing_period_type	long	Period type for billing cycles for usage.   Allowable Values Allowable values for usage_billing_period_type Values Description 1 Period type for usage billing cycle is Daily. 2 Period type for usage billing cycle is Weekly. 3 Period type for usage billing cycle is Monthly. 4 Period type for usage billing cycle is Quarterly. 5 Period type for usage billing cycle is Yearly.
default_ind	long	If true, this is the default rate schedule for the default currency   Allowable Values Allowable values for default_ind Values Description 0 Rate schedule is not the default. 1 Rate schedule is the default.
default_ind_curr	long	If true, this is the default rate schedule for the specified currency   Allowable Values Allowable values for default_ind_curr Values Description 0 Rate schedule is not default for specified currency. 1 Rate schedule is default for specified currency.
schedule_display_ind	long	Determines whether the rate schedule is displayable   Allowable Values Allowable values for schedule_display_ind Values Description 0 Rate schedule is not displayable. 1 Rate schedule is displayable.
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
contract_rollover_plan_no	long	Pre-defined plan to be used as the rollover plan at the completion of the contract.
contract_rollover_client_plan_id	string	Client-defined ID of the pre-defined plan to be used as the rollover plan at the completion of a contract.
contract_rollover_rate_sched	hash
contract_current_rate_sched_no	long	Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
contract_current_client_rate_sched_id	string	Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
contract_rollover_rate_sched_no	long	Current rate schedule for which the rollover rate schedule will be used at the completion of the contract
contract_rollover_client_rate_sched_id	string	Client-defined ID of the current rate schedule for which the rollover rate schedule will be used at the completion of the contract
acct_locale_no	long	Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. DEPRECATED
acct_locale_no	long	Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name	string	Name of the account level locale.