Skip to main content
The Account plans page lists the account plans of a ledger. A plan is versioned as its fees change.
Enable the Fees Engine in Midaz module settings before you use this page. With Access Manager, the page needs the read permission on account-plans.

​
The Account plans page

Select a ledger, then open Fees Engine > Account plans in the Midaz Module sidebar. The table has these columns: A switch in the Status column turns a plan on or off. Turning a plan off asks for confirmation. An inactive plan is not offered for new assignments, and the accounts already assigned to it keep being charged by it. The switch needs the update permission on account-plans. Delete needs the delete permission on account-plans.

​
Create an account plan

1

Open the wizard

Click New plan. The wizard has three steps: Plan data, Fees, and Review.
2

Fill in the plan data

Name the plan, add a description, and choose the timezone. The plan counts its free quotas per calendar month in this timezone.
3

Define the fees

Add each fee of the plan. A fee has a name, a service code or schemes, an amount, a free quota, the account that receives the fee. The free quota is the number of times each month that the fee is not charged. A quota of 0 charges every time.
4

Review and create

Check the plan and its fees, then click Create plan. This step needs the create permission on account-plans. The plan is created as version 1, in effect from the moment it is created.
The Console never charges a service fee. Your system sends the service code of the fee to the fee-charges API.

​
Read a plan and publish a new version

Select Details in the row menu to open the plan. The page has an Overview tab, a Fees tab, and a Versions tab.
  • Overview shows the plan data, the version in effect, and the date from which that version is in effect.
  • Fees shows the fees of the version in effect.
  • Versions lists each version with its situation, In effect, Scheduled, or Previous, and its fees.
Edit data changes the name, the description, and the timezone of the plan. Changing the timezone changes the month in which the free quota is counted, on every account of the plan. The fees are not edited here. Edit data and New version need the update permission on account-plans. A published version cannot be changed. To change the fees, click New version. The wizard starts from the fees of the latest version. You change, add, or remove fees, review the changes from the latest version, and choose when the new version starts: Now, or On a date, in the timezone of the plan. A scheduled version takes effect on its date, and the version in effect stays in effect before then.

​
Assign a plan to an account

An account page has a Fee Plan tab when the Fees Engine is on and you have the read permission on account-plans. Assigning and changing a plan need the put permission on account-plans. Ending a plan needs the delete permission on account-plans. The tab shows the plan of the account, the version in effect, and the date of the assignment. For each fee, it shows the free quota and how much of it the account used in the month, and how many overage charges were made.
1

Open the Fee Plan tab

On the account page, open the Fee Plan tab. An account with no plan follows the fee packages of the ledger.
2

Choose the plan

Click Assign plan, or Change plan when the account already has one. Choose one of the enabled plans of the ledger and review its fees.
3

Confirm

Confirm. Changing a plan ends the current plan now, and the new plan starts charging the account.
To end the plan of an account, click End plan and confirm. The account goes back to following the fee packages of the ledger.