get_payment_plan_terms_m Guide
- Last updated
-
-
Save as PDF
-
The get_payment_plan_terms_m API returns the payment plan terms defined for a client. You can filter the results to a specific term or include inactive terms in the response.
Additional Guidance
Input Fields
| Field Name |
Notes |
| <client_payment_plan_term_id> |
If you provide this field, Aria returns only the matching term.
|
| <status_filter> |
Allowable values:
| Value |
Description |
| 0 |
Active only. This is the default when you do not pass this field. |
| 1 |
Active and inactive. |
|
Output Fields
| Field Name |
Notes |
| <payment_plan_term_list> |
Aria returns the payment plan terms that match the request as a list of records. Each record contains the following fields:
- payment_plan_term_no (long): Aria-assigned unique identifier for the payment plan term.
- client_payment_plan_term_id (string): Client-defined payment plan term ID.
- payment_plan_term_name (string): Payment plan term name.
- payment_plan_term_description (string): Payment plan term description.
- payment_plan_term_type (int): Payment plan term type. Values are 0 (independent, its own schedule and due dates) and 1 (aligned with an existing master plan instance).
- payment_plan_term_length (int): For payment_plan_term_type 0 (independent), used with payment_plan_term_period_type to define the term duration. For payment_plan_term_type 1 (aligned), the value is the number of statements the payment plan amount is part of.
- payment_plan_term_period_type (string): M (months), W (weeks), or D (days). Applicable only when payment_plan_term_type equals 0 (independent).
- payment_plan_term_interval (int): Payment frequency within the term duration. Applicable only when payment_plan_term_type equals 0 (independent).
- payment_plan_term_lump_sum_type (string): P (proportionately split across charges and tax) or T (applied to purchase tax only).
- payment_plan_term_lump_sum_amount (float): One-time amount that reduces the total amount spread over the term. Applicable when payment_plan_term_lump_sum_type equals P.
- payment_plan_term_lump_sum_amount_type (string): P (percentage of the outstanding balance) or F (flat amount).
- client_sku (string): Client-defined SKU for the fee-type inventory item associated with this payment plan term.
- status (string): Payment plan term status, for example Active or Inactive.
|
