get_payment_plan_details_m Sample Call and Response
This example retrieves the full configuration and installment schedule for one payment plan on an account, based on the get_payment_plan_details_m method defined in plsql_m_r73.yml. Use get_payment_plan_list_m first to find the payment_plan_no for a specific plan.
This example shows two representative installments out of the plan's full six-installment schedule, one already paid and one not yet due, to illustrate both states; it does not show every installment.
Sample call
{
"rest_call": "get_payment_plan_details_m",
"output_format": "json",
"client_no": 100848,
"auth_key": "8cfb51c1c9110f4152c",
"acct_no": 5017732,
"payment_plan_no": 88213
}
The account is identified by acct_no rather than by its alternative, client_acct_id, and the plan is identified by payment_plan_no, the Aria-assigned payment plan number, rather than by its alternative, client_payment_plan_id.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"initial_balance": 600.00,
"remaining_balance": 250.00,
"paid_amount": 365.00,
"payment_plan_create_date": "2026-01-20",
"payment_plan_name": "Balance Recovery Plan",
"payment_plan_description": "Six-month plan to recover past-due balance",
"client_billing_group_id": "BG-4471",
"payment_plan_status": "active",
"payment_method_no": 774221,
"payment_plan_schedule_details": [
{
"seq_no": 1,
"seq_notify_date": "2026-02-08",
"seq_due_date": "2026-02-15",
"seq_due_amount": 100.00,
"seq_fee_due": 2.50,
"seq_total_due": 102.50,
"seq_remaining_due": 0,
"seq_fee_remaining_due": 0,
"seq_paid_amount": 102.50,
"seq_remaining_balance": 0,
"seq_status": "paid",
"seq_statement_no": 990211,
"seq_message_id": 5510023,
"payment_plan_seq_transaction_list": [
{
"transaction_create_date": "2026-02-15T09:03:00Z",
"transaction_id": 48820113,
"invoice_no": 7723410,
"plan_instance_no": 601122,
"client_plan_instance_id": "SUB-PREMIUM-001",
"client_plan_instance_name": "Premium Monthly Subscription",
"transaction_due_amount": 102.50,
"transaction_paid_amount": 102.50,
"transaction_remaining_balance": 0
}
],
"payment_plan_seq_applied_payment_list": [
{
"payment_trans_type": 3,
"transaction_id": 48820150,
"applied_payment_amount": 102.50,
"date_applied": "2026-02-15",
"client_receipt_id": "RCPT-20260215-01",
"client_payment_method_id": "CARD-END-4471",
"payment_method_no": 774221
}
]
},
{
"seq_no": 3,
"seq_notify_date": "2026-04-08",
"seq_due_date": "2026-04-15",
"seq_due_amount": 100.00,
"seq_fee_due": 2.50,
"seq_total_due": 102.50,
"seq_remaining_due": 100.00,
"seq_fee_remaining_due": 2.50,
"seq_paid_amount": 0,
"seq_remaining_balance": 102.50,
"seq_status": "not paid"
}
]
}
An error_code of zero and an error_msg of "OK" indicate the request completed successfully. Sequence one, seq_no 1, has already been paid in full, so its payment_plan_seq_transaction_list and payment_plan_seq_applied_payment_list arrays each show the settled transaction and applied payment; a fully populated response would show one such entry for each of the plan's transactions and payments, not only one. Sequence three, seq_no 3, is not yet due, so seq_status reads "not paid" and no transaction or applied-payment arrays are present yet, since nothing has been billed or paid against it. This example omits sequence two for brevity and omits the optional child_acct_no and child_client_acct_id fields inside the transaction list, which apply only to family billing scenarios.