edit_payment_plan_term_status_m Sample Call and Response
This example shows a client deactivating two existing client-level payment plan terms in a single call, identifying them by their client-defined identifiers. It is based on the edit_payment_plan_term_status_m method as defined in methods_m_r73.yml, Admin Tools API. This method only changes a term’s active or inactive status; it does not create a new term, as create_payment_plan_term_m does, and it does not return the term’s other details, as get_payment_plan_terms_m does.
This example covers both required inputs: the array of terms to update, identified by client-defined identifier, and the new status. It does not cover identifying the terms by their Aria-assigned payment_plan_term_no, since the two identifier fields are alternatives and cannot be combined on the same call.
Sample call
{
"rest_call": "edit_payment_plan_term_status_m",
"output_format": "json",
"client_no": 700123,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"client_payment_plan_term_id": ["GOLD-12MO", "SILVER-ALIGNED"],
"status": 0
}
The rest_call and output_format fields are not part of the method’s own documented arguments. The REST layer adds them to every call: rest_call names the method being invoked, and output_format requests a JSON response rather than the default WDDX format. Within the method’s own arguments, client_no and auth_key identify and authenticate the client making the call, and both come from the shared param_defaults block. client_payment_plan_term_id and payment_plan_term_no are alternatives to each other and cannot be combined on the same call; this example identifies the terms by their client-defined identifiers rather than their Aria-assigned numeric identifiers, supplying two values in the array to update both terms in one call. In this JSON representation, the array holds the values directly; the yml notes that a REST form submission would instead pass repeated fields such as client_payment_plan_term_id[]=GOLD-12MO&client_payment_plan_term_id[]=SILVER-ALIGNED, and that the API Live testing tool accepts the same values pipe-delimited in a single field, for example GOLD-12MO|SILVER-ALIGNED. status is required and is set to 0, meaning both terms are being set to inactive; the other allowable value, 1, would set them to active.
Sample response
{
"error_code": 0,
"error_msg": "OK"
}
An error_code of zero, paired with an error_msg of “OK,” indicates that Aria updated the status of both payment plan terms successfully. The method’s returns block consists only of these two fields, so it does not echo back the identifiers or the new status; a subsequent get_payment_plan_terms_m call with status_filter set to 1 would confirm that GOLD-12MO and SILVER-ALIGNED now show a status of “Inactive.”