edit_payment_plan_term_status_m Guide
The edit_payment_plan_term_status_m API sets the status of one or more client-level payment plan terms to active or inactive. Aria blocks an inactive term from being applied to new payment plans. Existing payment plans created from that term continue unaffected.
API Specification |
edit_payment_plan_term_status_m |
Required Fields |
|
| Sample Call and Response: | edit_payment_plan_term_status_m Sample Call and Response |
Additional Guidance
Input Fields
| Field Name | Notes | ||||||
|---|---|---|---|---|---|---|---|
| <payment_plan_term_no> |
Provide this field or <client_payment_plan_term_id> to identify the payment plan terms to update. Do not pass both fields in the same request. This field accepts multiple values. For REST, pass array values as payment_plan_term_no[]=101&payment_plan_term_no[]=102. In API Live, delimit multiple values with a pipe, for example 101|102. |
||||||
| <client_payment_plan_term_id> |
Provide this field or <payment_plan_term_no> to identify the payment plan terms to update. Do not pass both fields in the same request. This field accepts multiple values. For REST, pass array values as client_payment_plan_term_id[]=GOLD&client_payment_plan_term_id[]=SILVER. In API Live, delimit multiple values with a pipe, for example GOLD|SILVER. |
||||||
| <status> |
Allowable values:
|