get_client_plans_basic_m Sample Call and Response
This example shows a call to get_client_plans_basic_m that retrieves a summary list of plans associated with a client, based on the plsql_m_r73.yml definition file for release 73. Unlike get_client_plans_all_m, this method returns only flat plan-level fields, with no nested service or rate schedule arrays.
This example includes the plan identifier used to filter the results and shows two of the returned plans, not a client’s entire plan catalog.
Sample call
{
"rest_call": "get_client_plans_basic_m",
"output_format": "json",
"client_no": "10021",
"auth_key": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"plan_no": 3301,
"include_translations": "false"
}
The plan is identified by one of two alternative fields, plan_no or client_plan_id; this example uses plan_no, the Aria-assigned numeric identifier. This example omits include_rs_summary entirely, since the yml file marks that field usage: unused in this release. Leaving plan_no unset would cause Aria to return every plan configured for the client rather than the single plan and its supplemental plan shown here.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"error_details": null,
"plan_details": [
{
"plan_no": 3301,
"plan_name": "Premium Streaming",
"plan_desc": "Master subscription plan bundling hardware and streaming usage services.",
"supp_plan_ind": 0,
"billing_ind": 1,
"display_ind": 1,
"rollover_months": null,
"rollover_plan_no": null,
"early_cancel_fee": 25.0,
"early_cancel_min_months": 6,
"suspension_period": 30,
"new_acct_status": 1,
"init_free_months": 1,
"default_notify_method": 1
},
{
"plan_no": 3302,
"plan_name": "Premium Streaming - Annual Supplement",
"plan_desc": "Supplemental plan applying an annual pricing discount to the Premium Streaming master plan.",
"supp_plan_ind": 1,
"billing_ind": 1,
"display_ind": 1,
"rollover_months": null,
"rollover_plan_no": null,
"early_cancel_fee": null,
"early_cancel_min_months": null,
"suspension_period": null,
"new_acct_status": null,
"init_free_months": null,
"default_notify_method": null
}
]
}
An error_code of 0 with an error_msg of OK indicates that Aria found the client’s plans and returned the requested summary details successfully. The plan_details array holds one entry per plan; this example shows the requested master plan and one of its supplemental plans, but a real client catalog would typically include many more plans, and the array is not exhaustive. This example excludes plan_rate_schedules_details and contract_rollover_rate_sched, since the response focuses on plan-level summary fields rather than rate schedule detail, and it excludes plan_translation_info and the remaining rollover and contract fields the method can return, since those are outside the scope of this worked example.