create_payment_plan_m Guide
The create_payment_plan_m API creates a new payment plan for an account, allowing the balance to be split into scheduled payments over time.
API Specification: |
create_payment_plan_m |
Required Fields: |
|
Additional Guidance
- Aria deprecated the <client_payment_method_id> input field (Release 68, January 2025) and replaced it with the following parameters: <primary_payment_method_no>, <client_primary_payment_method_id>, <backup_payment_method_no>, and <client_backup_payment_method_id>.
- The payment plan must have a primary pay method before you specify backup pay method. When attaching a payment method to a payment plan, please add the collection group for this pay method onto the billing group to which the payment plan belongs to.
Input Fields
| <do_collect> |
Indicates whether the system should collect any amount due today during payment plan creation. If set to true and the collection fails, Aria does not create the payment plan. For aligned payment plans, Aria will communicate the immediate collection on the account's next anniversary statement. For independent payment plans, Aria does not generate a notification for the immediate collection. Aria only collects immediately for these payment methods, with immediate success or failure response:
When you specify a Payment Terms Billing Group and specify <do_collect> = true, Aria creates a payment plan without attempting collection. Allowable Values
|
||||||||
| <payment_plan_type> |
Allowable Values
|
||||||||
| <payment_plan_period_type> |
Allowable Values
|
||||||||
| <do_write> |
Allowable Values
|
||||||||
| <all_master_plan_instance> |
Include all master plan instances associated with the billing group. If null, it is treated as N (No). Allowable Values
|
||||||||
| <master_plan_instance_balance_ind> |
Indicates the master plan instance balance to be paid off with the payment plan. If null, it will be treated as 0 (past due balance). Applicable only if <all_master_plan_instance> = Y, or <master_plan_instance_list> (array) is specified. Allowable Values
|
||||||||
| <payment_plan_lump_sum_type> |
Specifies the installment lump sum type for the assigned installment. Allowable Values
|
||||||||
| <payment_plan_lump_sum_amount_type> |
Specifies the lump sum amount type. Allowable Values
|
||||||||
| Field Name | Notes |
|---|
Error Codes
| Error Code/Description | Associated Fields |
|---|---|
|
|
|
| <client_payment_plan_id> | |
|
<aligned_payment_plan_client_master_plan_instance_id>, <payment_plan_type>, <payment_plan_period_type>, <master_plan_instance_id>, <payment_plan_length>, <invoice_list>, <transaction_id_list> |
|
| <invoice_list> | |
| <transaction_list> | |