Get a debt paydown analysis with payoff projections.
Call with NO arguments to get the user's SAVED plan — their chosen
strategy plus their saved extra monthly payment, the exact numbers
the Debt Paydown page shows them. When the user asks "when will I be
debt-free?" / "what's my payoff date?", use the no-argument call and
report the returned `debt_free_date`, `projection`, and `strategy`
VERBATIM — never re-derive a date from the month count and never
substitute a different strategy. Only pass `strategy`/`extra_monthly`
for explicit what-if questions ("what if I paid $200 extra?").
Args:
extra_monthly: Extra monthly payment beyond minimums. Omit to use
the user's saved extra payment (their plan).
strategy: Payoff strategy - highest_rate, snowball, variable_snowball,
minimum_payments, highest_balance, highest_payment,
cashflow_index, npv, max_interest_savings. Omit to use
the user's saved plan strategy.
respect_goal_priorities: When True (default), active debt-payoff
goals override strategy ordering for the primary projection.
Pass False to see what the chosen strategy would do without
goal interference. The strategies_comparison table always
shows pure strategy ordering regardless of this flag.
For "what should I pay this month?" / "which debt gets my extra?",
read `this_month`: `this_month.target` is the debt the plan attacks
first (`target_basis`: extra_this_month, or first_rollover when no
extra is set and freed-up payments start rolling to it in
`first_extra_month`). Each row has payment (what to send =
minimum_payment + extra), minimum_payment (the account's stated
minimum), and plan_minimum_payment / plan_payment (the projection's
amortized figures, which can differ by a few dollars). Quote payment
and minimum_payment as-is.
Returns:
Debt payoff timeline (incl. debt_free_date — quote it as-is),
this_month (per-debt payments + the target debt), interest
savings, strategy comparison, and is_user_saved_plan (True when
the projection is the user's own saved plan).
ConnectorAPI key