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

 

Home > Aria Crescendo core api > get_acct_plans_m

get_acct_plans_m

Returns the details of the master and supplemental plans most recently assigned to a specified 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.
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.
acct_plans_m hash
plan_no long Aria-assigned unique plan identifier
plan_name string Plan Name
plan_desc string Text description of this plan
plan_instance_no long Unique plan instance number for each assigned master plan.
client_plan_instance_id string Unique client-defined ID for each assigned master plan.
plan_date string Date on which the account was assigned to their current plan.
plan_units long Number of plan units the account is billed for.
last_bill_date string The date the account was last billed
next_bill_date string Date the account will be evaluated for invoicing, whether or not it results in any actual charges.
bill_thru_date string Date the accounts forward charges have been billed through.
bill_day long Day of the month that the account is billed.
recurring_billing_interval long Number of months between billing cycles
usage_billing_interval long Number of months between billing cycles
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.
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.
initial_plan_status long Default status used when master plan is initially assigned on an 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_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
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
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
initial_plan_status_cd long Default status used when master plan is initially assigned on an account.   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_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.
rate_schedule_no long Aria-assigned unique rate schedule number
rate_schedule_name string Name of the rate schedule
rate_sched_is_default_ind long Indicates whether or not the account is using the plans default rate schedule. 0 means the account is using an alternate rate schedule. 1 means the account is using the default rate schedule.   Allowable Values
supp_plan_ind long Indicates whether or not the plan is a supplemental plan. If it is "1", then the plan is a supplemental plan and if it is "0", then the plan is a master plan.   Allowable Values
plan_instance_status_cd long Current status code of the plan instance.   Allowable Values
plan_instance_status_label string Current status of the plan instance.   Allowable Values
plan_instance_status_date string Most recent date on which the status of the plan instance changed.
dunning_state long Current dunning state of the plan instance (applicable only for master plans).   Allowable Values
dunning_step long Current dunning step of the plan instance (applicable only for master plans currently in dunning).
dunning_degrade_date string Next future date on which the plan instance would advance to the next dunning step (applicable only for master plans currently in dunning).
plan_assignment_date string The date on which the current plan was assigned on this plan instance.
plan_deprovisioned_date string The date on which the current plan on this plan instance was suspended, cancelled or terminated.
client_receipt_id string Client-defined unique identifier used to track related system actions
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_2_assign_on_susp string Client-defined Plan identifier to assign when an account on this plan is suspended.
client_rate_schedule_id string Client assigned unique rate schedule number
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
master_plan_instance_no long Master plan instance number for each supplemental plan.
client_master_plan_instance_id string Client master plan instance ID for each supplemental plan.
parent_plan_instance_no long Parent plan instance number to identify each supplemental plan and child supplemental plan heirarchy.
client_parent_plan_instance_id string Client parent plan instance ID to identify each supplemental plan and child supplemental plan heirarchy.
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_no long Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
contract_rollover_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
po_num string Purchase order number assigned to the plan instance.
available_from_dt string Start date of assigned rate schedule
available_to_dt string End date of assigned rate schedule
followup_rs_no long Aria internal ID of follow-up default rate schedule for the assigned rate schedule
client_followup_rs_id string Client-defined ID of followup rate schedule for the assigned rate schedule
acct_locale_no long Aria-assigned Locale identifier. 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.