Payment plans
A payment plan is what one profile owes for one product: a list of fees with amounts and due dates, the discounts taken off them, who pays each fee, and the transactions recorded against them. Every plan belongs to a profile and to a class or course.
Staff find a profile's plans under Financials in the profile's sidebar, on the Payment plans tab, next to All transactions. The list shows each plan's Name, Product, State ("Paid", "Not due", or how many payments are due or overdue), Outstanding, Paid and Total.
Creating a plan
Plans are created in three ways:
- By staff, with Add plan on the profile's Payment plans tab. The Add payment plan dialog asks for the Product (a class or course the profile holds a role in), an optional Payment plan template, which fills in the Name, and the Name. Create plan opens the new plan on its Fees tab.
- By an application, when its template has payment plans switched on and the applicant chooses a plan. See Finance across the platform.
- By automation, with the Create payment plan action. See Automation and emails.
From a template, the new plan copies the fees, sets of instalments, payment settings and discount templates, works out each fee's amount and due date against the plan's product, and applies the automatic discounts. From then on it is independent of the template. A plan created without a template starts empty, and staff add its fees.
The plan's tabs
| Tab | Contents |
|---|---|
| Details | Publication status, the statement download, Name, the read-only Product, and the payment settings: Payment process, Gateway, Allow applicants to define fees and Payment notifications, as on a template. |
| Fees | The fees table, with Add fee and Add discount. |
| Discounts | The plan's discounts. See Discounts. |
| Notes | Staff notes about the plan. |
| Auditing | The plan's history, for staff with auditing access. |
Allow applicants to define fees can only be changed while the plan has no fees. On a plan where applicants define their own fees, the Details tab also shows the template's instalment options and rounding, read only.
Fees
The Fees tab lists each fee's Description (with its external ID, or its number of instalments), Type (Fixed, Partition or Instalment), Reference, Due date, Currency, Subtotal, Discounts applied, Discount total, Total, State, Payer, Outstanding and Paid, with a TOTAL row at the bottom.
Add fee and Edit fee open the fee drawer:
| Field | Description |
|---|---|
| Type | Fixed for one fee, Partition to divide it into instalments. |
| Description | The fee's name. |
| Amount and Currency | What the fee costs before discounts. |
| Due date | When the fee falls due. |
| Gateway | The gateway this fee is paid through. Plan default uses the plan's. |
| External ID | Shown when editing. Changing it may break integrations and templates that reference it. |
| Profiles are required to pay this fee to complete their enrolment/registration process | For a deposit or enrolment fee. Ticked by default on a new fee. |
Each row's actions are Transactions and Fee details, and for staff who can change plans Edit fee and Delete fee. A fee cannot be deleted while money is against it (paid in part or in full, a payment in progress, or a request sent to an external payer), nor while it has discounts. Sets of instalments have Edit partition and Delete partition, and instalments Edit instalment.
Fee state
| State | Meaning |
|---|---|
| Paid | Completed transactions and discounts cover the whole amount. |
| Due / Overdue | Not fully paid, and the due date has been reached. |
| Not due | Not fully paid, and the due date is still ahead. |
A fee allocated to an external payer also shows Sent to payer once the payment link has been emailed. Only completed transactions in the fee's own currency count as paid. See Transactions.
Plan status
The plan's status follows its fees and is recalculated whenever a fee, transaction or discount changes:
Publishing
A plan is created unpublished: "This payment plan is not published". Applicants only see published plans, so staff can prepare and check a plan first.
Publish payment plan, on the Details tab:
- shows the plan to the applicant on their Payments page;
- sends the applicant the payment plan published email, the first time, unless the institution has switched that email off;
- fires the payment plan is published automation trigger, the first time.
Unpublish payment plan hides it again. An application template can publish the plan as soon as the application is submitted, and the Create payment plan automation action can publish it on creation.
The Payment plans list
Finance > Payment plans lists the plans of every profile, for staff with access to payment plans. It can be searched by name, email and plan name, and filtered by Product, Publish status, Fee status ("No fees due", "Fee due or overdue", "All fees paid") and Lifecycle. Profile and journey fields can be added as columns.
- Export exports the visible columns, with the current search and filters, as CSV or Excel. The download link is also emailed.
- Update status publishes or unpublishes, in one go, every plan matching the current search and filters. The dialog says how many of them it will change before you choose Update.
Warning: Update status only changes what applicants can see. It sends no publication email and fires no automation trigger. Publish from the plan's Details tab when those are needed.
Deleting a plan
Delete payment plan is on the plan's row in the profile's Payment plans list, and asks to confirm with I understand the consequences. It removes the plan's fees, sets of instalments and discounts, and fires the payment plan is deleted exit rule. A plan created by an application that is waiting for payment cannot be deleted: "Payment plan is associated with a pending payment Application / Registration".
Warning: Deleting a plan does not delete its transactions; they stay on the profile's All transactions tab. Check for payments before deleting.
Auditing
Every change to a plan, its fees, sets of instalments and discounts is recorded on the Auditing tab, under History, with the Version, Action, Changes, User and time.
Statements
Staff and applicants can download a PDF statement of a plan with Download statement (PDF) on the Details tab. See Applicant payments.