get_acct_plan_history_m Sample Call and Response
This example retrieves the history of plan changes for one master plan instance on an account, based on the get_acct_plan_history_m method defined in plsql_m_r73.yml. The account in this example first had its plan replaced, moving from a Starter Plan to an Enterprise Pro plan, and later had that plan instance suspended and then reactivated after a dunning cycle completed.
This example includes every required field, plus the filter_plan_instance_no field to narrow the history to one plan instance, rather than every optional field the method accepts.
Sample call
{
"rest_call": "get_acct_plan_history_m",
"output_format": "json",
"client_no": 3001,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"acct_no": 900154321,
"filter_plan_instance_no": 7734101
}
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 filter_plan_instance_no field is one side of an alternative pair with filter_client_plan_instance_id; this example uses filter_plan_instance_no to scope the plan history to one specific master plan instance rather than the whole account.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"plan_history": [
{
"plan_instance_no": 7734101,
"master_plan_instance_no": 7734101,
"old_plan_no": 4015,
"new_plan_no": 4021,
"old_client_plan_id": "STARTER-PLAN",
"new_client_plan_id": "ENTERPRISE-PRO",
"old_plan_name": "Starter Plan",
"new_plan_name": "Enterprise Pro",
"old_status_cd": 1,
"new_status_cd": 1,
"old_rate_schedule_no": 201,
"new_rate_schedule_no": 305,
"old_client_rate_schedule_id": "STD-MONTHLY",
"new_client_rate_schedule_id": "ENT-MONTHLY",
"old_client_plan_instance_id": "MPI-STARTER-9921",
"new_client_plan_instance_id": "MPI-ENT-9921",
"update_date": "2026-05-15"
},
{
"plan_instance_no": 7734101,
"master_plan_instance_no": 7734101,
"old_plan_no": 4021,
"new_plan_no": 4021,
"old_client_plan_id": "ENTERPRISE-PRO",
"new_client_plan_id": "ENTERPRISE-PRO",
"old_plan_name": "Enterprise Pro",
"new_plan_name": "Enterprise Pro",
"old_status_cd": -1,
"new_status_cd": 1,
"old_dunning_state": 1,
"new_dunning_state": 2,
"update_date": "2026-06-20"
}
],
"acct_locale_name": "English (United States)"
}
An error_code value of 0 and an error_msg value of “OK” indicate that Aria processed the request successfully. The plan_history array holds one entry per plan change event; this example shows two representative entries rather than an exhaustive history, and a plan instance with a longer history would return more. The first entry is a plan replacement, where old_plan_no and new_plan_no differ, while old_status_cd and new_status_cd both equal 1 (Active), since the replacement did not change the plan's status. The second entry is a status change, where old_status_cd is negative one (Suspended) and new_status_cd is 1 (Active), alongside old_dunning_state 1 (In Progress) and new_dunning_state 2 (Complete), reflecting a suspension that was resolved once dunning finished. This example leaves out the locale_no and locale_name alternative pair, which would request translated field values; the old_promo_cd, new_promo_cd, old_plan_units, and new_plan_units fields; and acct_locale_no_2. It also leaves out acct_locale_no entirely, since that field carries a deprecate_version in the yml.