Skip to main content
id
integer
required

Payment Plan ID

Example:

1

total_monthly_contribution
integer
required

Total monthly payment by plan in cents

Example:

20000

debt_free_date
string
required

Date of the last payment

Example:

"2045-01-23"

strategy
enum<string>
required

The payment plan repayment strategy

Available options:
snowball,
avalanche
Example:

"avalanche"

extra_amount
integer
required

Extra payment amount in cents

Example:

5000

upcoming_payments
object[]
required

Upcoming payments for this and next month

accounts
integer[]
required

Array of account IDs

Example: