Skip to main content
The Customer Portal is configured per tenant and environment. You choose which sections appear, which widgets sit inside them, and what colours, logo and font the portal renders with. The configuration is stored under the customer_portal_config setting key, and the portal fetches it on load. Anything you leave unset falls back to a default, so a tenant that has never touched the configuration still gets a complete portal.

Settings toggles

The dashboard exposes the four section-level switches most tenants need. Go to Settings and open the Customer Portal tab. Changes apply to every portal session opened in that environment from the next page load.
Settings, Customer Portal tab, showing the four portal visibility toggles
Saving the configuration requires Super AdminThe portal configuration is stored through the settings API, whose writes are restricted to Super Admin regardless of the portal:write permission. A user without it sees the toggles but cannot save.

Configuration schema

For anything beyond the five toggles, write the configuration directly through the settings API under the key customer_portal_config.

Section fields

Widget fields

Widget types

Usage graph configuration

Valid presets are today, last_7_days, last_30_days, current_month and last_month.

Metric cards configuration

Cost metrics are your numbers, not the customer’sshow_cost_metrics exposes your cost to serve this customer and your margin on them. It is on in the default configuration. Set it to false for any portal your customers use.

How your configuration merges with the defaults

Understanding the merge matters when a Tirdad release adds a section or changes one.
  • Your sections win on content. Labels, enabled and the widgets inside a section are yours.
  • Your order wins. Sections keep the order values in your stored configuration. A default section you have never saved is placed after yours, and a default widget missing from one of your sections is appended at the end of that section.
  • New default sections are appended, not dropped. A wholesale replace would hide any section shipped after you saved, so a section you have never seen is added rather than lost. Express removal as "enabled": false, not by deleting the entry.
  • Overview is configurable like any other section. By default it holds balance, payment methods, subscriptions and current usage.
  • A theme with no values is ignored. An empty theme object does not override the default light appearance.
The Payments section is retiredSaved cards used to live in a section of their own. They now sit on Overview, beside the balance they top up and the subscriptions they pay for. A stored configuration naming a payment_methods section is honoured as hidden. To hide the widget, set the payment_methods widget to "enabled": false in Overview through the settings API. The dashboard has no toggle for it.

Theming

Supply four brand colours and the portal derives the rest, including text colours, from the brightness of your background. Leave the whole theme object out to use the portal’s default light appearance.
Give font_family a real fallback stack, for example "Inter, system-ui, sans-serif". The portal does not load web fonts on your behalf.

Reading the configuration from the portal

A portal session reads its own resolved configuration, already merged with the defaults:
Use this if you build your own portal front end against the Tirdad APIs and want to honour the same tenant configuration.

Customer Portal

Sessions, sections and the security model

Portal payments

Invoice payment, top-ups, auto top-up and saved cards

Settings

All tenant and environment setting keys