get_acct_plans_all_m Sample Call and Response
This example retrieves the complete plan, service, and rate schedule data for a master plan instance and its supplemental plan instance on an account, based on the get_acct_plans_all_m method defined in plsql_m_r73.yml. As the method's own description states, get_acct_plans_all_m provides a more detailed view than get_acct_plans_m, which returns plan-level summaries without the full service and rate breakdown; this example shows that detailed breakdown, including each assigned service's rate tiers, product fields, plan instance fields, and surcharges.
This example includes every required field, plus the master_plan_instance_filter and limit fields to scope and bound the results, rather than every optional field the method accepts.
Sample call
{
"rest_call": "get_acct_plans_all_m",
"output_format": "json",
"client_no": 3001,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"acct_no": 900154321,
"limit": 50,
"master_plan_instance_filter": [
{
"master_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 master_plan_instance_filter array's master_plan_instance_no field is one side of an alternative pair with client_master_plan_instance_id; this example uses master_plan_instance_no to scope the results to one master plan instance and the supplemental plan instance tied to it. This example does not set include_service_supp_fields, include_product_fields, include_plan_instance_fields, include_plan_services, include_surcharges, include_rate_schedule, include_contract_and_rollover_info, or include_dunning_info, since each of those defaults to "true" when left blank, and the response below shows the corresponding arrays as a result of that default behavior.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"record_count": 2,
"all_acct_plans_m": [
{
"plan_no": 4021,
"plan_name": "Enterprise Pro",
"plan_desc": "Enterprise-tier subscription plan with premium support",
"plan_instance_no": 7734101,
"client_plan_instance_id": "MPI-ENT-9921",
"plan_date": "2025-01-15",
"plan_units": 1,
"last_bill_date": "2026-07-01",
"next_bill_date": "2026-08-01",
"bill_thru_date": "2026-07-31",
"bill_day": 1,
"billing_ind": 1,
"display_ind": 1,
"billing_group_no": 55001,
"client_billing_group_id": "BG-STANDARD",
"dunning_group_no": 6601,
"client_dunning_group_id": "DG-STANDARD",
"prepaid_ind": 0,
"currency_cd": "usd",
"rate_schedule_no": 305,
"rate_schedule_name": "Enterprise Monthly Rate Schedule",
"rate_sched_is_default_ind": 1,
"supp_plan_ind": 0,
"plan_instance_status_cd": 1,
"plan_instance_status_label": "Active",
"plan_instance_status_date": "2025-01-15",
"dunning_state": 0,
"plan_assignment_date": "2025-01-15",
"client_plan_id": "ENTERPRISE-PRO",
"client_rate_schedule_id": "ENT-MONTHLY",
"product_fields": [
{
"field_name": "Product Line",
"field_value": "Enterprise Suite"
}
],
"plan_instance_fields_detail": [
{
"field_name": "Contract Owner",
"field_value": "Jane Smith"
}
],
"plan_instance_services": [
{
"service_no": 8801,
"service_desc": "Monthly Subscription Fee",
"is_recurring_ind": 1,
"is_usage_based_ind": 0,
"taxable_ind": 1,
"display_ind": 1,
"client_service_id": "SVC-SUB",
"plan_instance_service_rates": [
{
"rate_seq_no": 1,
"from_unit": 0,
"to_unit": 999999,
"rate_per_unit": 199.00,
"custom_rate_ind": 0
}
]
}
],
"surcharges_all": [
{
"surcharge_no": 901,
"surcharge_name": "Regulatory Recovery Fee",
"client_surcharge_id": "SURCHARGE-REG",
"description": "Recovers cost of regulatory compliance",
"surcharge_type": "Flat",
"currency": "usd",
"invoice_app_method": "I",
"surcharge_rate": [
{
"rate_seq_no": 1,
"from_unit": 0,
"to_unit": 999999,
"rate_per_unit": 2.50
}
]
}
]
},
{
"plan_no": 4550,
"plan_name": "Additional Storage Add-on",
"plan_desc": "Supplemental plan providing extra storage capacity",
"plan_instance_no": 7734188,
"client_plan_instance_id": "SPI-STORAGE-4471",
"plan_date": "2025-06-01",
"plan_units": 100,
"last_bill_date": "2026-07-01",
"next_bill_date": "2026-08-01",
"bill_thru_date": "2026-07-31",
"bill_day": 1,
"billing_ind": 1,
"display_ind": 1,
"billing_group_no": 55001,
"client_billing_group_id": "BG-STANDARD",
"prepaid_ind": 0,
"currency_cd": "usd",
"rate_schedule_no": 410,
"rate_schedule_name": "Storage Add-on Rate Schedule",
"rate_sched_is_default_ind": 1,
"supp_plan_ind": 1,
"plan_instance_status_cd": 1,
"plan_instance_status_label": "Active",
"plan_instance_status_date": "2025-06-01",
"plan_assignment_date": "2025-06-01",
"client_plan_id": "ADDL-STORAGE",
"client_rate_schedule_id": "STORAGE-STD",
"master_plan_instance_no": 7734101,
"client_master_plan_instance_id": "MPI-ENT-9921",
"plan_instance_services": [
{
"service_no": 8802,
"service_desc": "Additional Storage Usage",
"is_recurring_ind": 0,
"is_usage_based_ind": 1,
"taxable_ind": 1,
"display_ind": 1,
"client_service_id": "SVC-STORAGE",
"plan_instance_service_rates": [
{
"rate_seq_no": 1,
"from_unit": 0,
"to_unit": 100,
"rate_per_unit": 0.75,
"custom_rate_ind": 0
},
{
"rate_seq_no": 2,
"from_unit": 100.01,
"to_unit": 999999,
"rate_per_unit": 0.50,
"custom_rate_ind": 0
}
]
}
]
}
]
}
An error_code value of 0 and an error_msg value of “OK” indicate that Aria processed the request successfully. The all_acct_plans_m array holds one entry per plan instance; this example shows two representative entries, a master plan (supp_plan_ind 0) and its supplemental plan (supp_plan_ind 1), though an account with more assigned plans, or a broader filter, would return more. The plan_instance_status_cd value of 1, paired with plan_instance_status_label “Active”, means both plan instances are currently active. The supplemental plan's plan_instance_services entry shows a two-tier usage rate in plan_instance_service_rates, 0.75 per unit for the first 100 units and 0.50 per unit beyond that, illustrating how a service's rate_seq_no entries divide pricing into tiers; the master plan's single service uses one flat, untiered rate instead. The surcharges_all entry's invoice_app_method value of “I” means the surcharge is applied inline on the invoice, rather than the alternative, “O” for offset. This example leaves out plan_services entirely, since that field carries a deprecate_version in the yml, as well as acct_locale_no, which is also deprecated; it uses acct_locale_name instead where a locale needs to be shown, though this example omits locale output altogether. It also leaves out the product_catalog_plan_filter, service_no_filter, and supplemental_field_filter arguments, the rollover, contract, and follow-up rate schedule fields (rollover_months, rollover_plan_no, contract_rollover_plan_no, and related fields), dunning_step and dunning_degrade_date, and several other optional fields on each plan entry.