update webui billing summary docs

gravitational · Jan 22, 2025 · 7eebf2a · 7eebf2a
1 parent 38a1bb3
commit 7eebf2a
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/docs/img/webui_billing_cycle.png b/docs/img/webui_billing_cycle.png
diff --git a/docs/pages/usage-billing.mdx b/docs/pages/usage-billing.mdx
@@ -72,6 +72,22 @@ calculate two types of billing metrics:
 - Monthly Active Users
 - Teleport Protected Resources
 
+### Usage metrics in the Web UI
+
+<Admonition type="note">
+
+This will be displayed only for those on usage-based plans. Users will need permission to read the billing resource.
+
+</Admonition>
+
+1. Go to https://teleport.sh/ and enter your tenant name.
+1. Sign in using your administrator credentials.
+1. Click on your username at the top right to expand the dropdown menu.
+1. Click on "Billing Summary".
+1. Usage data for the current billing cycle will be displayed. Example:
+
+![Billing Cycle](../img/webui_billing_cycle.png)
+
 ### Monthly Active Users
 
 Monthly Active Users (MAU) is the aggregate number of unique active users
@@ -90,7 +106,7 @@ provider, as user activity.
 
 Note: when configured to perform single-sign-on against an external identity
 provider, Teleport creates temporary user records that are valid for the
-duration of the SSO session. As a result, the *Users* page in Teleport's web UI
+duration of the SSO session. As a result, the _Users_ page in Teleport's web UI
 will only show users who have recently logged in and is not a true
 representation of all active users over the last month.
 
@@ -133,7 +149,7 @@ self-hosted Teleport infrastructure or Teleport Cloud, depending on the user's
 plan. The submission service persists usage reports in the case of a submission
 failure, and deletes the reports after a successful submission. It is not
 possible to set up a third-party destination for usage events to independently
-verify usage event data. 
+verify usage event data.
 
 If you are using Teleport Enterprise (Cloud), your usage data is accurate as
 long as Teleport-managed reporting infrastructure works as expected (check the
@@ -171,4 +187,3 @@ to Teleport during a given time period. The Teleport documentation includes
 [how-to guides](./admin-guides/management/export-audit-events/export-audit-events.mdx) for
 exporting audit events to common log management solutions so you can identify
 users that have authenticated using an SSO provider.
-