Skip to main content
Aria Knowledge Central

get_payment_plan_list_m Guide

The get_payment_plan_list_m API returns a list of all payment plans configured on an account. Payment plans allow customers to spread an outstanding balance across multiple billing periods rather than paying the full amount at once. Each payment plan has a schedule defining the payment amounts, frequency, and duration. By default, only active payment plans are returned; set include_all_statuses to true to also include completed, cancelled, or suspended plans. Use get_payment_plan_details_m to retrieve the full details and payment schedule for a specific plan.

API Specification:

get_payment_plan_list_m

Required Fields:

  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>

Additional Guidance

Inputs
Field Name Type Description

<include_all_statuses>

string

Specifies whether all payment plans with different statuses need to be included or not. 

Allowable Values

Values Description
false Only payment plans with 'Active' statuses will be included.
true All payment plans with any status will be part of the response.
TOP
  • Was this article helpful?