¶ General Setting
¶ Company tab
The Company tab holds your organization's identifying details. These values are typically used on generated invoices and throughout the interface.
| Field | Description |
|---|---|
| Name | Your company name. |
| Address | Your company's postal address (multi-line text). |
| Phone | Contact phone number. |
| Contact email address. | |
| Website | Your company website. |
| Logo | An image file uploaded from your computer. |
¶ Locale tab
The Locale tab controls regional formatting — the time zone the system operates in and the currency used for pricing.
¶ Time Zone
A searchable dropdown of all standard time zones, each shown together with its UTC offset (for example, the offset is displayed next to each zone name to help you pick the right one). This sets the time zone BillRun uses for date and time handling.
¶ Currency
A dropdown of available currencies. Each option is labeled with its code, name, and symbol (for example, USD - US Dollar $). The selected currency is stored as the system pricing currency.
¶ Tax tab
Set the default tax rate:
- Default Tax Rate — A dropdown of the tax rates defined in your system (each listed by its description). This is the tax rate applied by default.
¶ Menu tab
The Menu tab lets you customize the application's main navigation menu — the order in which items appear and whether each item is shown or hidden.
The menu is presented as a draggable tree:
- Main Menu column — the menu items, which you can reorder by dragging. Nested sub-menus are supported.
- Roles column — indicates the roles that have access to each menu item.
- Show/Hide column — toggles whether a given menu item is visible.
Reordering is done by dragging an item to a new position; the new order is saved when you save the tab.
Certain core entries cannot have their show/hide state edited — these are essential items the system always keeps available (for example, the Settings area itself, input processors, and custom fields).
¶ Security tab
The Security tab manages shared secret keys — named secrets, each with a validity period, used for secure integrations.
The tab shows a list of existing keys and have the option to add new keys.
¶ Actions
- Add New — opens a form to create a new key.
- Edit (per row) — edit an existing key.
- Remove (per row) — delete a key. You are asked to confirm before removal.
¶ Creating or editing a key
The key form contains:
- Name — a name for the secret.
- Secret Key — this field is read-only. When creating a new key, the value is generated and becomes available only after you save (a hint reads "Secret will be available after saving").
- Creation Date — a date picker for the start of the validity period.
- Expiration Date — a date picker for the end of the validity period.
Changes on this tab are saved immediately when you confirm the form or a removal — there is no separate global Save step.
¶ Invoicing tab
The Invoicing tab controls when billing runs occur and how invoices are produced and delivered.
| Field | Description |
|---|---|
| Charging Day | A dropdown (days 1–28) selecting the day of the month on which charging takes place. |
| Billing cycle generates PDF invoices | A checkbox. When enabled, the billing cycle produces PDF invoices. |
| Detailed Invoices | A checkbox enabling detailed (itemized) invoices. |
| Send invoices to customers by email | A checkbox. When enabled, confirmed invoices are emailed to eligible customers. The help text explains: once an invoice is confirmed, it is emailed to the customer's email address for customers eligible for the "email" shipping method. |
Dependencies between options: The "Detailed Invoices" and "Send invoices by email" options only apply when PDF generation is enabled. If you turn off "Billing cycle generates PDF invoices", both of those options are automatically turned off and disabled, since there is no PDF to detail or send.
¶ Plays tab
What is a Play? A Play is a named operating profile in BillRun. Plays let you run more than one distinct business configuration within the same environment, for example different scopes for customer subscriber and limiting plans/services and products to subscribers of certain plays. One Play is always marked as the default.
The Plays tab shows a table of all configured Plays.
An Add Play button below the table creates a new Play.
¶ Creating and editing Plays
When creating a Play, the form includes:
- Name (required) — the internal name. It is automatically normalized to uppercase and cleaned of invalid characters, and must be unique. The Label is auto-filled from the name until you edit it.
- Description (Label) — a friendly description.
- Default — a checkbox marking this Play as the default. Marking a Play as default automatically enables it.
- Enabled — a checkbox controlling whether the Play is active.
The Name and Default fields can only be set when creating a Play; when editing an existing Play, they are not editable.
¶ Rules and protections
The default Play is protected to keep the system in a valid state:
- A default Play cannot be disabled.
- A default Play cannot be removed.
- A disabled Play cannot be made the default.
Setting a new default automatically clears the default flag from all other Plays. Enabling, disabling, and removing a Play each take effect immediately (disable and remove ask for confirmation first).
¶ Activity Types tab
The Activity Types tab defines the usage/activity types that BillRun recognizes, along with how each is measured and displayed.
An Add New button creates a new activity type. Each row has an Edit action.
¶ Creating or editing an activity type
The form contains:
- Activity Type (required) — the label. When creating, the internal usage type is derived automatically from what you type.
- Property Type (required) — a dropdown of available property types. Choosing a property type determines which units of measure are available below.
- Invoice Unit of Measure — a dropdown of units valid for the chosen property type.
- Default Unit of Measure — a dropdown of units valid for the chosen property type.
When editing an existing activity type, the base fields (Activity Type and Property Type) are locked; you can adjust the units of measure. Changes are saved immediately when you confirm the form.
¶ System tab
The System tab holds low-level operational toggles.
| Field | Description |
|---|---|
| Allow making changes to entities in closed billing cycles | A checkbox. When enabled, the system permits edits to entities that belong to billing cycles that have already been closed. |
¶ Plugins tab
The Plugins tab lists the extensions installed in your BillRun environment and lets you enable, disable, and configure each one.
The tab shows a table with:
| Column | Description |
|---|---|
| Status | Whether the plugin is enabled or disabled. |
| Label | The plugin's display name. |
Each plugin row offers actions to Edit, Enable, or Disable it. Disabling a plugin asks for confirmation first; enabling and disabling take effect immediately and show a success (or failure) message.
¶ Editing a plugin
Opening a plugin's editor shows:
- Status — Enable / Disable radio buttons.
- Configuration fields — a dynamic set of fields specific to that plugin. Because each plugin declares its own configuration schema, the fields shown here vary from plugin to plugin. The form renders exactly the fields the plugin defines, and validates them before saving.
Because plugin configuration is defined by each plugin individually, the presence or absence of a given field in a plugin's form reflects only what that plugin currently exposes — it is a menu of that plugin's options, not the full set of everything a plugin could theoretically support.