Customers
Get an embeddable customer dashboard
Generate secure, embeddable dashboard URLs that allow you to seamlessly integrate Metronome’s billing visualizations directly into your application. This endpoint creates authenticated iframe-ready URLs for customer-specific dashboards, providing a white-labeled billing experience without building custom UI.
Use this endpoint to:
- Embed billing dashboards directly in your customer portal or admin interface
- Provide self-service access to invoices, usage data, and credit balances
- Build white-labeled billing experiences with minimal development effort
Key response fields:
- A secure, time-limited URL that can be embedded in an iframe
- The URL includes authentication tokens and configuration parameters
- URLs are customer-specific and respect your security settings
Usage guidelines:
- Dashboard types: Choose from
invoices,usage, orcommits_and_credits - Customization options:
dashboard_options: Configure dashboard behavior. Supported for the invoices dashboard only. Available keys include:show_zero_usage_line_items(“true”/“false”),contract_id(UUID, filters invoices by contract),invoice_type(“USAGE” or “SCHEDULED”, filters by invoice type), andinvoice_status_filter(“VOID”, “FINALIZED”, “DRAFT”, “FINALIZED_AND_DRAFT”, or “ALL”)color_overrides: Match your brand’s color palette
- Iframe implementation: Embed the returned URL directly in an iframe element
- Responsive design: Dashboards automatically adapt to container dimensions
POST
Get an embeddable customer dashboard
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The details of the dashboard to retrieve
Response
Success