create_payment_plan_term_m Guide
The create_payment_plan_term_m API creates a reusable payment plan term at the client level. You can apply a saved term whenever you create a payment plan on an account, rather than specifying the length, interval, lump sum handling, and fee on every call.
API Specification |
create_payment_plan_term_m |
Required Fields |
|
| Sample Call and Response: | create_payment_plan_term_m Sample Call and Response |
Additional Guidance
Input Fields
| Field Name | Notes | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| <payment_plan_term_type> |
If you do not pass this field, Aria treats the payment plan term as type 0 (independent). Allowable values:
|
||||||||
| <payment_plan_term_period_type> |
Required when <payment_plan_term_type> equals 0 (independent). Allowable values:
|
||||||||
| <payment_plan_term_length> |
For <payment_plan_term_type> = 0 (independent), Aria uses this value with <payment_plan_term_period_type> to define the term duration. For example, a period type of M with a length of 36 defines a 36-month term. For <payment_plan_term_type> = 1 (aligned), the value represents the number of statements the payment plan amount is part of. |
||||||||
| <payment_plan_term_interval> |
Works jointly with <payment_plan_term_period_type>. For example, an interval of 2 with a period type of M means a payment is due every 2 months. If you provide this field, the value must be less than or equal to <payment_plan_term_length>. If you do not pass this field, Aria defaults it to 1. |
||||||||
| <payment_plan_term_lump_sum_type> |
Allowable values:
|
||||||||
| <payment_plan_term_lump_sum_amount> |
Required when <payment_plan_term_lump_sum_type> equals P (proportionately split). |
||||||||
| <payment_plan_term_lump_sum_amount_type> |
Required when <payment_plan_term_lump_sum_type> equals P (proportionately split). Allowable values:
|