Get an embeddable customer dashboard

curl --request POST \
  --url https://api.metronome.com/v1/dashboards/getEmbeddableUrl \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
  "dashboard": "invoices",
  "dashboard_options": [
    {
      "key": "show_zero_usage_line_items",
      "value": "false"
    },
    {
      "key": "hide_voided_invoices",
      "value": "true"
    }
  ],
  "color_overrides": [
    {
      "name": "Gray_dark",
      "value": "#ff0000"
    }
  ],
  "bm_group_key_overrides": [
    {
      "group_key_name": "tenant_id",
      "display_name": "Org ID",
      "value_display_names": {
        "48ecb18f358f": "Cluster EU",
        "e358f3ce242d": "Cluster APAC"
      }
    }
  ]
}
'

{
  "data": {
    "url": "https://embeddable-dashboards.metronome.com/customers/invoices/v1?..."
  }
}

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, or commits_and_credits
Customization options:
- dashboard_options: Configure whether you want invoices to show zero usage line items
- color_overrides: Match your brand’s color palette
- bm_group_key_overrides: Customize how dimensions are displayed (for the usage embeddable dashboard)
Iframe implementation: Embed the returned URL directly in an iframe element
Responsive design: Dashboards automatically adapt to container dimensions

POST

dashboards

getEmbeddableUrl

Get an embeddable customer dashboard

curl --request POST \
  --url https://api.metronome.com/v1/dashboards/getEmbeddableUrl \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
  "dashboard": "invoices",
  "dashboard_options": [
    {
      "key": "show_zero_usage_line_items",
      "value": "false"
    },
    {
      "key": "hide_voided_invoices",
      "value": "true"
    }
  ],
  "color_overrides": [
    {
      "name": "Gray_dark",
      "value": "#ff0000"
    }
  ],
  "bm_group_key_overrides": [
    {
      "group_key_name": "tenant_id",
      "display_name": "Org ID",
      "value_display_names": {
        "48ecb18f358f": "Cluster EU",
        "e358f3ce242d": "Cluster APAC"
      }
    }
  ]
}
'

{
  "data": {
    "url": "https://embeddable-dashboards.metronome.com/customers/invoices/v1?..."
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The details of the dashboard to retrieve

customer_id

string<uuid>

required

dashboard

enum<string>

required

The type of dashboard to retrieve.

Available options:

invoices,

usage,

commits_and_credits

dashboard_options

object[]

Optional dashboard specific options

Show child attributes

color_overrides

object[]

Optional list of colors to override

Show child attributes

bm_group_key_overrides

object[]

Optional list of billable metric group key overrides

Show child attributes

Response

Success

data

object

required

Show child attributes

Fetch billing provider configurations for a customer

Archive a customer

⌘I