get_plans_m Sample Call and Response
This example shows a client retrieving the full list of service plans defined for its account, based on the get_plans_m method defined in methods_m_r73.yml.
This example includes every required field for the call and a representative set of returned plan and rate schedule information. It does not attempt to show every optional filter or every field the method can return.
Sample call
{
"rest_call": "get_plans_m",
"output_format": "json",
"client_no": 60123,
"auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
The rest_call and output_format fields are envelope fields that the REST layer adds to every call; they do not appear in the method’s own documented arguments. The call itself requires only client_no, Aria’s identifier for the client requesting the plan list, and auth_key, the authentication key issued to that client. This example omits the optional locale_no, locale_name, and include_translations fields, since the reader is not requesting translated plan information in this scenario. It also omits include_rs_summary, since that field is marked nonpublic in the yml and does not represent a documented, client-facing option.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"plans": [
{
"plan_no": 10045,
"client_plan_id": "gold-monthly",
"plan_name": "Gold Monthly Plan",
"plan_level": 0,
"active_ind": 1,
"description": "Master plan providing gold-tier service with monthly recurring billing.",
"is_deletable": "false",
"rate_sched": [
{
"schedule_no": 88010,
"client_rate_schedule_id": "gold-monthly-usd",
"schedule_name": "Gold Monthly USD Schedule",
"schedule_currency": "USD",
"recurring_billing_interval": 1,
"recurring_billing_period_type": 3,
"usage_billing_interval": 1,
"usage_billing_period_type": 3,
"default_ind": 1,
"default_ind_curr": 1
}
]
},
{
"plan_no": 10046,
"client_plan_id": "silver-monthly",
"plan_name": "Silver Monthly Plan",
"plan_level": 0,
"active_ind": 1,
"description": "Master plan providing silver-tier service with monthly recurring billing.",
"is_deletable": "true",
"rate_sched": [
{
"schedule_no": 88020,
"client_rate_schedule_id": "silver-monthly-usd",
"schedule_name": "Silver Monthly USD Schedule",
"schedule_currency": "USD",
"recurring_billing_interval": 1,
"recurring_billing_period_type": 3,
"usage_billing_interval": 1,
"usage_billing_period_type": 3,
"default_ind": 1,
"default_ind_curr": 1
}
]
}
]
}
An error_code of zero and an error_msg of “OK” indicate that the client’s plan list was retrieved successfully. The plans array holds one entry per service plan configured for the client; a real client could have many more than the two entries shown here. Each plan entry carries its own rate_sched array, since a single plan can be associated with more than one rate schedule (for example, one per currency); this example shows one representative schedule per plan rather than an exhaustive set. The plan_level value of zero indicates each plan shown is a master plan rather than a supplemental plan, and recurring_billing_period_type and usage_billing_period_type both use the value three, meaning a monthly billing period. This example leaves out plan_desc, since that field is marked nonpublic in the yml and is described there only as an unused placeholder, and it leaves out plan_translation_info, which the method returns only when the caller sets include_translations to true.