How long to pay this card off
calculate_payoff_timelineUse this for "if I pay $200 a month, when is this paid off?" or "what happens if I only pay the minimum?". Returns how long a card takes to clear at a fixed monthly payment and the interest paid over that time. This is a cost question, not a reporting one: it does not change what the bureaus see, so use get_reported_snapshot or simulate_paydown for that. Requires the card's purchase APR; without it no timeline is returned, because the rate decides the answer. Calculates scenarios from supplied figures; does not make payments, change accounts, fetch external data, or retain tool inputs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cards | Yes | The person's revolving credit accounts. Ask for limit, statement balance, and statement closing date per card — those three drive everything. | |
| today | No | Today's date in the person's local timezone, yyyy-mm-dd. Pass it — the server otherwise falls back to UTC, which is a day ahead for Canadian evenings. | |
| cardName | Yes | Which card to pay off. Partial names are matched. | |
| monthlyPayment | No | Fixed amount paid each month in CAD. Omit to use the card's minimum payment, if one was supplied. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| aprBps | Yes | ||
| months | Yes | ||
| balance | Yes | ||
| cardName | Yes | ||
| atMinimum | Yes | ||
| aprUnknown | Yes | ||
| disclosure | Yes | ||
| assumptions | Yes | ||
| neverShrinks | Yes | ||
| totalInterest | Yes | ||
| monthlyPayment | Yes |