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

 

Home > Aria Crescendo core api > get_avail_plans_for_acct_m

get_avail_plans_for_acct_m

Returns a list of all plans available for assignment on a particular account

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 You can use this input parameter to specify whether to retrieve full hierarchy of child plans associated with the returned plans or with the plan_instance_no or client_plan_instance_id that you specified. If you set the include_full_plan_hierarchy_plans parameter to true , then full hierarchy of child plans down to the bottom level of your plan hierarchy will be returned.   Allowable Values
include_rs_summary string 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
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 Aria-assigned unique parent plan Instance identifier
parent_client_plan_instance_id string Parent plans Client-defined Plan Instance ID
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   Allowable Values
display_ind long Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable.   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.
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.
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
rollover_plan_status long Status used for the master plan instance at the completion of the rollover period.   Allowable Values
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
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.
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
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
initial_plan_status_cd long Default status used when master plan is initially assigned on an account.   Allowable Values
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
rollover_plan_status_cd long Status used for the master plan instance at the completion of the plan status rollover period.   Allowable Values
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
default_ind long If true, this is the default rate schedule for the default currency   Allowable Values
default_ind_curr long If true, this is the default rate schedule for the specified currency   Allowable Values
schedule_display_ind long Determines whether the rate schedule is displayable   Allowable Values
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.
acct_locale_name string Name of the account level locale.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.