Managing Plans

Plan detail view

The plan detail page shows:

Schedule — every payment date with its amount and status, plus adjustments, non-debit payments and suspensions, each with the actions you can take on it
Upcoming intents — payment intents scheduled but not yet processed
Collected vs total — how much has been collected against the total (if set)
Failure count — number of consecutive payment failures
Activity log — state changes, edits, and payment outcomes

State actions

Action	From state	To state	Effect
Activate	`draft`, `inactive`	`active`	Begins scheduling future payments
Deactivate	`active`	`inactive`	Stops scheduling; deletes unprocessed future intents
Suspend	`active`	`suspended`	Stops collecting from today until you resume it. Unsent payments are removed, and payments due meanwhile are skipped: a plan with a total runs longer
Resume	`suspended` (or closing and suspended)	`active` (or `closing`)	Ends every suspension, including one for a failed payment method or a review, and re-plans from today. Needs a usable payment method
Close	`active` (or `inactive`, `suspended` with a final amount of 0)	`closing`, then `closed`	Stops the plan for good, optionally collecting a final amount. See Closing a plan

Suspended plans

A suspended plan shows Suspended, or Closing then Suspended for a closing plan, with one line for each reason:

Suspended by you since a date: you clicked Suspend. Click Resume to collect again.
Payment method failed with its code: the payment method can’t be used again. Collection resumes when the customer adds a new payment method. See Handling failures.
Suspended for your review with its code: a code about the customer, such as a cancelled direct debit authority or a deceased customer. No email was sent to the customer. Click Resume when you’ve decided to collect again.

While a plan is suspended, no payment is taken. Payments missed while you suspended it are skipped, and a plan with a total runs longer. Payments missed while a failed payment method or a review suspended it still count: the plan shows them as behind, a plan with a total collects them at the end, and a plan that runs until further notice doesn’t.

Resume ends every suspension at once and plans again from today. It needs a usable payment method: without one, collect a new one from the customer first.

Editing a plan

The following can be changed on an active or inactive plan:

Name and category
Recurring amount (takes effect from the next scheduled payment)
First amount (if the first payment hasn’t been processed yet)
Total amount
Failure behaviour

After editing amounts, the future payment schedule is recalculated automatically.

Changing a payment

On the plan’s Schedule, a payment dated after today that hasn’t been sent to the bank or card network offers:

Change — set a new amount for that date. Set it to zero to skip the payment.
Skip — skip the payment in one click.
Undo — on a date you’ve already changed, go back to the plan’s normal amount.

Add payment takes an extra payment on any future date.

When you change a payment, you choose:

Is this a catch-up payment? Answer No (the default, and what Skip does) when the plan should now expect the new amount, so it isn’t behind. Answer Yes when the plan should still expect the scheduled amount, so it stays behind until the customer catches up.
Total to collect (plans with a total only). Leave the total as it is, and the plan collects any difference at the end: a skipped payment adds a payment at the end, and a larger one finishes the plan sooner. Or change the total by the difference, and the plan keeps its dates.

Without changing the total, a date can’t be raised above what the plan still has to collect up to that date. The form tells you the most it can be. Undo never changes the total, even if the change you’re undoing did.

Changing the payment on the first payment’s date changes the plan’s first payment amount, and setting it to zero removes the first payment.

Non-debit payments

Use Add non-debit payment to record money the customer paid outside the plan, such as cash at reception. It counts as collected, and the plan collects only what’s left.

The date must be today or earlier.
A negative amount adds to what the customer owes.
The description is optional.
On a plan with a total, non-debit payments can’t add up to more than the total.

Undo on its row removes it, and the plan collects the amount again.

Suspending a plan for set dates

Use Add suspension to stop a plan between two dates. Both dates are included: no payment is taken on the start date, the end date or any day between. A plan with a total keeps its total and runs longer.

Suspensions can’t overlap, including on the same day.
A suspension can’t start before the plan does.
It can’t start today if a payment has already been sent today.
Once a suspension has begun, you can’t move its start or remove it. You can still change its end until it finishes.
You can’t change a payment that falls inside a suspension.

This is different from the Suspend action above, which holds the whole plan with no end date until you resume it.

Changes to a closing or closed plan’s schedule aren’t possible.

The same changes can be made through the API and the sandbox MCP tools: see Changing a plan’s schedule. A non-debit payment made through the API can carry your own reference, which the Schedule shows in its Reference column.

Closing a plan

Close plan stops a plan for good: a closed plan can’t be reopened. To stop payments for a while, use Deactivate or Suspend instead. Owners and admins can close plans.

The close form asks for a final amount to collect. It starts at what the plan still has to collect. Change it to any amount, or to 0 to collect nothing more. Payments already being processed still have to go through first.

The plan’s total becomes what it has collected so far, including payments already sent to the bank or card network, plus the final amount.
The final amount is scheduled in instalments of up to $300 on the plan’s next payment dates: a $700 final amount is scheduled as $300, $300 and $100. If one fails, the plan’s failure behaviour can make a later payment larger: doubling up adds the failed amount to the next one.
The final amount must be 0, or at least $2.00. A final amount above 0 that equals or exceeds the remaining balance (what the plan still has to collect) needs a second confirmation: tick the box the form shows, or change the amount. The form starts at the remaining balance, so keeping it asks for the confirmation.
Suspensions that start after today are removed. One that has already started stays, and the final payments move past it. Changed payment dates stay as they are.
A plan set to do nothing when a payment fails switches to adding a payment at the end, so the final amount is still collected.

While its final payments are still to be collected, the plan is Closing, and nothing about its schedule can be changed. If one of them fails, it’s collected again under the plan’s failure behaviour. The plan is Closed once its final payments have gone through: a card payment when it’s approved, a bank debit once it clears, so a bank-debit plan stays Closing until its final debits clear (about 2 business days after they’re sent). If a payment fails after the plan has closed, such as a bank debit returned late, the failure is recorded but the payment isn’t collected again, and the plan shows the Shortfall.

A plan with nothing more to collect and nothing still being processed closes straight away. An inactive or suspended plan can be closed with a final amount of 0; to collect a final amount, activate or resume it first.

Plans can also be closed through the API and the sandbox MCP: see Close a plan.