Billing configuration
Each tenant has oneBillingConfig record that defines how and when they are invoiced. Only users with the super role can create or update billing configuration.
billing_frequency accepts monthly or annually. The schema also supports quarterly as a valid value.Invoices
Every billing cycle generates anInvoice record. You can view the full invoice history for any tenant from the billing section of that tenant’s detail page.
Invoice statuses
Billing dashboard metrics
The billing dashboard gives you a platform-wide snapshot of billing health viaBillingDashboardMetrics.
The metrics displayed on the billing dashboard reflect the current state of all tenants across the platform, not just those visible on the current page.
Set up billing for a tenant
1
Open the tenant
Go to Tenants in the sidebar and click on the tenant you want to configure billing for.
2
Navigate to the Billing tab
Inside the tenant detail view, select the Billing tab.
3
Enter the billing amount and currency
Set
flat_rate_amount to the amount you charge this tenant each period. Set currency to the appropriate currency code.4
Choose billing frequency and day
Select
monthly or annually for billing_frequency. Set billing_day_of_month to the day invoices should be generated (for example, 1 for the first of each month).5
Set payment terms
Enter a value for
payment_due_days to define how many days the tenant has to pay before an invoice becomes overdue.6
Configure the billing email
Enter the email address in
billing_email that should receive invoice copies and payment reminders. Toggle email_notifications on to enable automatic email delivery.7
Enable automatic invoice generation
Set
auto_generate_invoices to true if you want the platform to create invoices automatically each billing period. Set it to false if you prefer to generate invoices manually.8
Save the configuration
Click Save. The billing configuration becomes active immediately and will apply to the next billing cycle.
View invoice history
To review all invoices for a specific tenant:- Open the tenant from the Tenants list.
- Select the Billing tab.
- Scroll to the Invoice history section.
paid_date, payment_reference, and payment_method.
Monitor platform-wide billing
To view the billing metrics dashboard, go to Administration → Billing in the sidebar. The dashboard showstotal_tenants, pending_invoices, overdue_invoices, and monthly_revenue for the entire platform.