Creating Plans
Navigate to Payment Plans → New
Section titled “Navigate to Payment Plans → New”From the sidebar, go to Payment Plans and click New Plan. Alternatively, create a plan from a customer’s detail page — it pre-fills the customer field.
Required fields
Section titled “Required fields”| Field | Notes |
|---|---|
| Customer | The customer to bill |
| Start date | Date of the first payment |
| Frequency period | Number (e.g. 1, 2) |
| Frequency type | W (weekly) or M (monthly) |
| Recurring amount | Amount — min $2.00, max $1,000.00 |
| Failure behaviour | What to do when a payment fails (see below) |
Optional fields
Section titled “Optional fields”| Field | Notes |
|---|---|
| Name | Internal name for the plan (e.g. “Monthly subscription”), up to 50 characters. A plan without one is shown by its category, or as “Payment Plan” |
| Category | Internal grouping label |
| First payment date | If the first payment falls on a different date than start |
| First amount | If the first payment should be a different amount |
| Total amount | Set a fixed total, at most $999,999.99. A plan set up as a number of payments can’t come to more than that either. Once it’s collected the plan schedules nothing more, and a payment that fails later is collected again: see When a plan reaches its total |
| Until further notice | Open-ended plans with no total amount |
Failure behaviour options
Section titled “Failure behaviour options”| Behaviour | Code | Description |
|---|---|---|
| Add to end | NEW_AT_END |
Missed payment added as an extra at end of plan |
| Retry | TRY_AGAIN |
Payment retried after a delay (default: 3 days) |
| Double up | DOUBLE_UP |
Next scheduled payment includes the failed amount |
| Do nothing | DO_NOTHING |
Total reduced; failure recorded; no catchup |
TRY_AGAIN works well for most plans — it recovers missed payments without extending the end date. Use DO_NOTHING when partial collection is acceptable and you don’t want to chase failures.
Activating the plan
Section titled “Activating the plan”Plans are created in draft state. Click Activate to begin scheduling payments.
When a plan is created through the customer flow with a payment method still to be collected, you don’t need to activate it manually — the plan auto-activates once the customer’s payment method is successfully collected.