Skip to main content
A Billing Package sets a periodic charge in the Fees Engine. A package has one of two types:
  • Volume: charges per number of events in the period. It supports price tiers, a free quota, and discounts.
  • Maintenance: charges a fixed amount from each target account every period.
Enable the Fees Engine in Midaz module settings before you use this page.

Accessing the Billing Packages page


In the Midaz Module sidebar, expand Fees Engine. Select Billing Packages. The page lists the packages of the Ledger that you select in the organization switcher. The list shows the Name, Type, Asset, and Status of each package. Use the Type filter to show Volume or Maintenance packages. From the list, you can:
  • Turn the Status switch on or off to activate or deactivate a package.
  • Select Details in the row menu to see the package configuration.
  • Select Edit in the row menu to change the package.
  • Select Delete in the row menu to delete the package. The Console asks you to confirm.

Creating a Billing Package


1

Choose the type

Click New Package. In Choose the billing type, select Volume Package (Tiered) or Maintenance Package (Flat Fee).
2

Fill in the basic information

In Type & Information, enter the Package Name and an optional Description. Select the Asset Code. The package uses the Ledger that you select in the organization switcher.
3

Configure the package

In Configuration, set the fields for the package type. The next two sections describe these fields.
4

Review and save

In Review, check the summary. To change a section, use its edit button to go back to that step. Then select Save.
A new package is active when you create it. The next billing run includes it. You can change the type until you save the package. If you change it after you fill in Configuration, the Console discards the Configuration data.

Volume package fields


Maintenance package fields


  • Fee Amount: the amount that the package charges from each target account every period.
  • Target Accounts: the accounts to charge.
    • By Segment: the accounts in the selected segment.
    • By Portfolio: the accounts in the selected portfolio.
    • Account List: account aliases that you type, or that you upload in a UTF-8 CSV file with an accountAlias column.
  • Credit Account (alias): the account that receives the charged amounts.
An account list can have at most 100 aliases. When you create the package, Midaz checks that each alias exists in the Ledger. If an alias does not exist, Midaz refuses the package.

Editing a Billing Package


Select Edit in the row menu. You can change the Package Name and the Description. The type, the asset, and the Configuration fields do not change after creation. To stop a package from charging, turn its Status switch off. Billing runs use active packages only.

Where to go next


Billing Runs

Preview the fees for a period before you apply them.

Fees Engine overview

Understand how the Fees Engine, packages, and rules fit together.