get_acct_plan_queued_changes_m Sample Call and Response
This example retrieves the queued plan changes for a master plan instance and its supplemental plan instance, based on the get_acct_plan_queued_changes_m method defined in plsql_m_r73.yml. One queued change is a plan replacement scheduled on the master plan instance, and the other is a plan unit increase scheduled on its supplemental plan instance.
This example includes every required field, plus the plan_instance_no and queued_action_status_cd fields to narrow the results to one plan instance's still-pending changes, rather than every optional field the method accepts.
Sample call
{
"rest_call": "get_acct_plan_queued_changes_m",
"output_format": "json",
"client_no": 3001,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"acct_no": 900154321,
"plan_instance_no": 7734101,
"queued_action_status_cd": 1
}
The rest_call and output_format fields form the envelope that the REST layer adds to every call; they are not part of the method's own documented arguments. You identify the account using acct_no, the Aria-assigned account identifier, which is one side of an alternative pair with the client-defined client_acct_id; this example uses acct_no. The plan_instance_no field is one side of an alternative pair with client_plan_instance_id; this example uses plan_instance_no to scope the results to a master plan instance and its child. The queued_action_status_cd value of 1 filters the results to changes that are still queued and have not yet executed; the other values in this enumeration cover changes that were deleted (0), executed successfully (2), failed to execute (3), or, as the default when this field is left blank, all statuses regardless of state (4).
Sample response
{
"error_code": 0,
"error_msg": "OK",
"queued_change_details": [
{
"queue_id": 91234,
"plan_instance_no": 7734101,
"client_plan_instance_id": "MPI-ENT-9921",
"queued_action_status_cd": 1,
"queued_action_status_label": "Queued",
"current_plan_no": 4021,
"current_client_plan_id": "ENTERPRISE-PRO",
"current_plan_name": "Enterprise Pro",
"current_plan_units": 1,
"current_plan_inst_status_2": 1,
"current_rate_schedule_no": 305,
"current_client_rate_schedule_id": "ENT-MONTHLY",
"current_rate_schedule_name": "Enterprise Monthly Rate Schedule",
"effective_date": "2026-08-01",
"target_plan_no": 4030,
"target_client_plan_id": "ENTERPRISE-PLUS",
"target_plan_name": "Enterprise Plus",
"target_plan_units": 1,
"target_plan_inst_status_2": 1,
"target_rate_schedule_no": 340,
"target_client_rate_schedule_id": "ENT-PLUS-MONTHLY",
"target_rate_schedule_name": "Enterprise Plus Monthly Rate Schedule",
"queuing_user_id": "jsmith",
"queuing_date": "2026-07-20",
"queue_type": 3,
"execute_allowed": 1,
"change_effective_date_allowed": 1,
"delete_allowed": 1,
"update_date": "2026-07-20"
},
{
"queue_id": 91240,
"plan_instance_no": 7734188,
"client_plan_instance_id": "SPI-STORAGE-4471",
"parent_plan_instance_no": 7734101,
"client_parent_plan_instance_id": "MPI-ENT-9921",
"queued_action_status_cd": 1,
"queued_action_status_label": "Queued",
"current_plan_no": 4550,
"current_client_plan_id": "ADDL-STORAGE",
"current_plan_name": "Additional Storage Add-on",
"current_plan_units": 50,
"current_plan_inst_status_2": 1,
"current_rate_schedule_no": 410,
"current_client_rate_schedule_id": "STORAGE-STD",
"effective_date": "2026-08-01",
"target_plan_units": 100,
"queuing_user_id": "jsmith",
"queuing_date": "2026-07-21",
"queue_type": 6,
"execute_allowed": 1,
"change_effective_date_allowed": 1,
"delete_allowed": 0,
"update_date": "2026-07-21"
}
]
}
An error_code value of 0 and an error_msg value of “OK” indicate that Aria processed the request successfully. The queued_change_details array holds one entry per queued plan change; this example shows two representative entries, though a plan instance with several pending changes would return more. The first entry has a queue_type of 3 (Plan Replacement), where the target_plan_no, target_plan_name, and related target fields differ from the current ones, since the account is scheduled to move from Enterprise Pro to Enterprise Plus. The second entry has a queue_type of 6 (Plan Update), reflecting a plan unit increase from 50 to 100 on the supplemental storage plan instance, and it includes parent_plan_instance_no and client_parent_plan_instance_id because that plan instance is a supplemental plan tied to the master plan instance in the first entry; the first entry omits those two fields since a master plan instance has no parent. This example leaves out the queued_plan_custom_rates array, which would list any custom rate overrides tied to a queued change, and it leaves out current_plan_inst_status and target_plan_inst_status entirely, since both carry a deprecate_version in the yml; this example uses their non-deprecated replacements, current_plan_inst_status_2 and target_plan_inst_status_2, instead.