-
Notifications
You must be signed in to change notification settings - Fork 2.1k
docs: document embedded-user AI billing and correct SCIM audit log events #11535
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -73,6 +73,21 @@ Contact your account executive for details on purchasing token packages. | |
| Each user on a free plan receives an individual monthly token allowance. This | ||
| allowance resets at the start of each calendar month. | ||
|
|
||
| ## Embedded users | ||
|
|
||
| AI token spend by [embedded](/embedding/iframe) end users — through Analytics | ||
| Chat, Creator Mode, or an embedded dashboard's AI features — is tracked | ||
| separately from regular seats. Embedded users aren't billed as seats, so their | ||
| usage isn't covered by [per-seat token grants](#per-seat-token-grants): | ||
|
|
||
| - **Contract customers**: embedded AI spend draws from [token | ||
| packages](#token-packages) first, then continues as on-demand overage. | ||
|
Comment on lines
+83
to
+84
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit / accuracy check: "then continues as on-demand overage" links contract customers to a mechanism the page frames as on-demand-plan-only — On-demand consumption is nested under Per-seat token grants and says usage "is billed through the credit card on file", which typically isn't how contract customers pay. If contract overage is real, it's a notable billing fact that deserves a sentence in the Token packages section too (what happens when the pool runs dry applies to non-embedded usage as well). If it isn't, this bullet should say spend is blocked / requires another package instead. |
||
| - **On-demand customers**: embedded AI spend is billed directly as [on-demand | ||
| consumption](#on-demand-consumption), subject to the account's on-demand | ||
| spending limit if one is set. | ||
| - **Free plan**: embedded users share the account's [free tier](#free-tier) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This contradicts the Free tier section three lines above, which says the allowance is per user ("Each user on a free plan receives an individual monthly token allowance"), not an account-level pool. "share the account's free tier allowance" tells a reader there's one shared bucket. Worth confirming against the billing code which of the two is actually true, then making both sections agree. If the grant really is per-user, something like "embedded users draw from the free tier allowance" (dropping "the account's" and "share") avoids implying a pool. |
||
| allowance, since free accounts have no seats to grant tokens against. | ||
|
|
||
| ## Tracking usage | ||
|
|
||
| Administrators can monitor token consumption through the **AI Tokens Usage** | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken internal link.
/embedding/iframeisn't a page —docs-mintlify/embedding/iframe/has noindex.mdx, the path isn't indocs.jsonnav, and there's no redirect for it (only/embedding/private-embedding,/embedding/signed-embedding,/embedding/creator-mode). Every other page links either to/embedding(the group index) or to a concrete leaf like/embedding/iframe/dashboards.Since the sentence covers Analytics Chat, Creator Mode, and dashboards,
/embeddingis the right target: