-
Notifications
You must be signed in to change notification settings - Fork 42
Project Releases, Audit logs, editor blocks, widgets #486
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
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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,70 @@ | ||||||||||
| --- | ||||||||||
| title: AI usage | ||||||||||
| description: Monitor how much Plane AI your workspace and its members consume each month, view usage trends and breakdowns, and understand your monthly allowance and limits. | ||||||||||
| --- | ||||||||||
|
|
||||||||||
| # AI usage | ||||||||||
|
|
||||||||||
| AI usage shows how much Plane AI your workspace consumes. It gives you a monthly meter, a usage trend over time, and a detailed breakdown of where AI is being used, so you can keep an eye on consumption and stay ahead of your monthly allowance. | ||||||||||
|
|
||||||||||
| AI usage is read-only. It reports consumption, and it does not change any settings or data. | ||||||||||
|
|
||||||||||
| ## Where to find it | ||||||||||
|
|
||||||||||
| Open Plane AI and use the sidebar to reach two screens: | ||||||||||
|
|
||||||||||
| - **Usage** shows your monthly meter and usage trend. | ||||||||||
| - **Analytics** shows a detailed breakdown of consumption. | ||||||||||
|
|
||||||||||
| ## Personal and workspace views | ||||||||||
|
|
||||||||||
| Both screens have a **Personal** and a **Workspace** view: | ||||||||||
|
|
||||||||||
| - **Personal** shows your own AI consumption. Any member can see this. | ||||||||||
| - **Workspace** shows consumption across the whole workspace, including every member and any AI agents. Only **Admins** and **Owners** can see the Workspace view. | ||||||||||
|
|
||||||||||
| ## The Usage screen | ||||||||||
|
|
||||||||||
| **Monthly meter.** A meter shows how much of your monthly allowance has been used in the current period. On Plane Cloud this is shown as a **percentage** of your allowance. The meter can read above 100% because the limit is applied after a request completes, not partway through it. | ||||||||||
|
|
||||||||||
| **Reset date.** Below the meter, Plane shows where you are in the current cycle (for example, the day within the month) and the date the allowance **resets**. Allowances reset monthly. | ||||||||||
|
|
||||||||||
| **Usage trend.** A chart plots consumption over time. You can switch the interval between **Week** and **Month** and move between periods to see how usage is changing. | ||||||||||
|
|
||||||||||
| On self-hosted deployments, usage is measured in **tokens** rather than a percentage, and the Usage screen also shows total **tokens in** and **tokens out**. | ||||||||||
|
|
||||||||||
| ## The Analytics screen | ||||||||||
|
|
||||||||||
| The Analytics screen breaks usage down so you can see exactly where AI is being spent. Choose a dimension to group by: | ||||||||||
|
|
||||||||||
| - **Models** — which AI models were used | ||||||||||
| - **Users** — consumption per member | ||||||||||
| - **Agents** — consumption by AI agents | ||||||||||
| - **Features** — which AI features were used (for example chat, page actions, or predictions) | ||||||||||
| - **Projects** — consumption per project | ||||||||||
|
|
||||||||||
| The breakdown is a table with the group's name, its **share of usage**, the **tokens used**, and the number of **requests**. The table is paginated, and you can **export** it to CSV for offline analysis. | ||||||||||
|
|
||||||||||
| The Users, Agents, and Projects breakdowns are part of the Workspace view, so they require Admin or Owner access. | ||||||||||
|
|
||||||||||
| ## Your monthly allowance and limits | ||||||||||
|
|
||||||||||
| Each workspace has a monthly AI allowance that depends on your plan. Consumption counts against that allowance during the billing month and resets at the start of the next one. | ||||||||||
|
|
||||||||||
| - **Nearing your limit.** When you reach about 80% of your allowance, Plane shows a warning so you can plan ahead. | ||||||||||
| - **Reaching your limit.** When the allowance is used up, Plane AI features are **paused** for that subject (a member or the workspace's agents) until the next monthly reset. The request that crosses the limit still finishes; the next one is blocked. You will see a message that AI capabilities are temporarily disabled until the reset date. | ||||||||||
|
|
||||||||||
| Because the limit is applied after a request rather than partway through, your meter can briefly show slightly over 100%. | ||||||||||
|
Comment on lines
+50
to
+57
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. 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win Scope allowance behavior to Plane Cloud and include workspace overage. Lines 52-55 describe a plan-based allowance and mandatory pausing for every deployment. Suggested wording change-Each workspace has a monthly AI allowance that depends on your plan.
+On Plane Cloud, each workspace has a monthly AI allowance that depends on your plan.
...
-When the allowance is used up, Plane AI features are paused for that subject
+When the allowance is used up and workspace overage is off, Plane AI features are paused for that subject
+When workspace overage is enabled, AI continues and additional usage is billed to the workspace.🤖 Prompt for AI Agents |
||||||||||
|
|
||||||||||
| For how allowances are assigned per plan, what overage does, and how billing works, see [Plane AI credits](/ai/plane-ai-credits). | ||||||||||
|
|
||||||||||
| ## Plane Cloud and self-hosted | ||||||||||
|
|
||||||||||
| How usage is measured depends on where Plane runs: | ||||||||||
|
|
||||||||||
| - **On Plane Cloud**, usage is shown as a **percentage** of a monthly allowance that scales with your plan. Members and AI agents each have their own allowance. | ||||||||||
| - **On self-hosted deployments**, you connect your own AI provider, so **members are not metered**. Usage is reported in **tokens**, and only the shared pool used by AI agents is bounded, and only if your administrator has configured a token budget for it. If no agent budget is configured, agent features are unavailable rather than metered. | ||||||||||
|
Comment on lines
+65
to
+66
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. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Describe the agent allowance as workspace-level.
Suggested wording change-- **On Plane Cloud**, usage is shown as a **percentage** of a monthly allowance that scales with your plan. Members and AI agents each have their own allowance.
+- **On Plane Cloud**, usage is shown as a **percentage** of a monthly allowance that scales with your plan. Members have per-seat allowances; AI agents use a separate workspace-level allowance.📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||
|
|
||||||||||
| ## Availability | ||||||||||
|
|
||||||||||
| AI usage is part of **Plane AI** and appears only where Plane AI is enabled for your workspace. If Plane AI is not enabled, the Usage and Analytics screens are not available. See [Plane AI](/ai/plane-ai) for how to enable it. | ||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,81 @@ | ||
| --- | ||
| title: How Plane AI credits work | ||
| description: Understand seat-based AI credits, what happens when included credits run out, and how workspace overage keeps your team moving. | ||
| description: Understand how Plane AI credits work on Plane Cloud per-seat monthly allowances, what happens when they run out, workspace overage, and how to monitor usage. | ||
| --- | ||
|
|
||
| # Plane AI credits | ||
|
|
||
| Plane AI credits measure AI usage in Plane Cloud. | ||
| Plane AI credits measure how much Plane AI (Pi) your workspace uses on Plane Cloud. Your plan includes a monthly allowance, and AI features draw from it as your team uses them. | ||
|
|
||
| ::: warning IMPORTANT | ||
| AI credits apply only to Plane Cloud. | ||
| To see how much of your allowance you have used, open the [AI usage](/ai/ai-usage) dashboard. It shows your consumption for the current month as a percentage of your allowance. | ||
|
|
||
| On self-hosted instances, you use your own AI provider [API key](https://developers.plane.so/self-hosting/govern/instance-admin#artificial-intelligence), and all AI usage and costs are managed directly through your provider. | ||
| ::: warning Credits apply only to Plane Cloud | ||
| On self-hosted instances you connect your own AI provider [API key](https://developers.plane.so/self-hosting/govern/instance-admin#artificial-intelligence), so there are no Plane credits. All AI usage and costs are handled directly through your provider, and members are not metered by Plane. | ||
| ::: | ||
|
|
||
| ## How credits are assigned | ||
|
|
||
| Credits are included **per paid seat**. | ||
| Credits are included with your plan and refresh every month. | ||
|
|
||
| - Each active seat gets a monthly included credit amount based on your plan. | ||
| - Included credits are account-level entitlements tied to seats. | ||
| - This model is designed to be simple and predictable, similar to how modern AI products commonly package usage. | ||
| - Each active paid seat gets a monthly included allowance based on your plan. | ||
| - The allowance is an entitlement tied to seats, so your total capacity scales with your team. | ||
| - Allowances reset at the start of each monthly billing period. | ||
|
|
||
| For current included amounts by plan, check the latest pricing details on [Plane pricing](https://plane.so/pricing#ai-&-credits). | ||
| AI **agents** draw from a separate, workspace-level allowance rather than from any one member's. Automated agent activity does not consume a person's individual credits. | ||
|
|
||
| ## No default pooling | ||
| For current included amounts by plan, see [Plane pricing](https://plane.so/pricing#ai-&-credits). | ||
|
|
||
| Plane AI credits are **not pooled by default**. | ||
| ## Credits are not pooled by default | ||
|
|
||
| That means one member's unused included credits are not automatically shared across the rest of the workspace. | ||
| Each member has their own monthly allowance. One member's unused credits are not automatically shared with the rest of the workspace. This keeps each person's available capacity predictable. | ||
|
Comment on lines
+20
to
+30
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. 🗄️ Data Integrity & Integration | 🟠 Major | 🏗️ Heavy lift 🧩 Analysis chain🏁 Script executed: #!/usr/bin/env bash
set -euo pipefail
rg -n -C 3 -i \
'ai credits|allowance|pool(ed)?|per[- ]seat|per[- ]member|workspace[- ]level' \
docs --glob '*.md'Repository: makeplane/docs Length of output: 50370 🏁 Script executed: #!/usr/bin/env bash
set -euo pipefail
printf '%s\n' '--- docs/ai/plane-ai-credits.md ---'
nl -ba docs/ai/plane-ai-credits.md | sed -n '1,90p'
printf '%s\n' '--- docs/workspaces-and-users/billing-and-plans.md ---'
nl -ba docs/workspaces-and-users/billing-and-plans.md | sed -n '180,196p'
printf '%s\n' '--- AI-credit references ---'
rg -n -C 2 -i 'AI credits|credits per seat|credits.*pool|pool.*credits|individual credits|monthly allowance|top-up|rollover' docs --glob '*.md' \
| head -n 240Repository: makeplane/docs Length of output: 228 Reconcile the AI credit-pooling model before publishing.
🤖 Prompt for AI Agents |
||
|
|
||
| ## What happens when included credits run out | ||
| ## What happens when credits run out | ||
|
|
||
| If a member (or your workspace's included capacity) runs out of available credits for the billing period, AI usage can stop unless overage is enabled. | ||
| As a member approaches their allowance, at around 80% used, Plane shows a warning so they can plan ahead. | ||
|
|
||
| Workspace admins can enable a workspace-level overage setting so teams can continue using AI after included credits are exhausted. | ||
| When the allowance is fully used for the month, what happens depends on whether workspace overage is enabled: | ||
|
|
||
| - **Overage off (the default).** Plane AI features pause for that member until the allowance resets at the start of the next month. The request that reaches the limit still finishes, and the next one is paused. The member sees a message that AI is temporarily unavailable until the reset date. | ||
| - **Overage on.** AI keeps working past the included allowance, and the additional usage is billed at the workspace level. | ||
|
|
||
| The same applies to the workspace's agent allowance: agents pause when it is used up, unless overage is enabled. | ||
|
|
||
| ## Workspace overage | ||
|
|
||
| When workspace overage is enabled: | ||
| Overage is a workspace-level setting that keeps your team moving after included credits are used up. | ||
|
|
||
| - When enabled, AI usage continues past the included allowance. | ||
| - The additional usage is billed to the workspace. | ||
| - Workspace admins decide whether to allow it, so cost stays in your control. | ||
|
|
||
| - AI usage continues after included credits are consumed. | ||
| - Additional usage is billed at the workspace level. | ||
| - Admins stay in control of whether overage is allowed. | ||
| If overage is off, AI pauses at the limit until credits reset or more capacity is added to the workspace. | ||
|
|
||
| If overage is disabled, new AI actions are paused after included credits are exhausted until credits reset or additional capacity is purchased/enabled. | ||
| ## Monitor usage | ||
|
|
||
| ## Tracking and controls | ||
| Track consumption from the [AI usage](/ai/ai-usage) dashboard: | ||
|
|
||
| Plane provides usage visibility so admins can manage cost and adoption: | ||
| - A **monthly meter** shows how much of the allowance has been used, as a percentage. | ||
| - A **usage trend** chart shows how consumption changes over time. | ||
| - An **analytics breakdown** shows where AI is being used, by member, feature, project, model, and agent. | ||
|
|
||
| - Current credit balance and consumption trends | ||
| - Workspace-level usage monitoring | ||
| - Billing visibility for additional usage when overage is enabled | ||
| Every member can see their own usage. Workspace admins and owners can also see workspace-wide usage. | ||
|
|
||
| ## FAQs | ||
|
|
||
| ::: details Are credits shared automatically across all users in my workspace? | ||
| No. Plane does not use automatic credit pooling by default. | ||
| No. Credits are not pooled by default. Each member has their own monthly allowance. | ||
| ::: | ||
|
|
||
| ::: details Do I get credits for each seat? | ||
| Yes. Included credits are assigned per paid seat based on your plan. | ||
| Yes. An included allowance is assigned per paid seat based on your plan. AI agents draw from a separate, workspace-level allowance. | ||
| ::: | ||
|
|
||
| ::: details Can we keep using AI after included credits are used up? | ||
| Yes, if a workspace admin enables overage at the workspace level. | ||
| Yes, if a workspace admin enables overage. Otherwise, AI pauses for that member until the allowance resets at the start of the next month. | ||
| ::: | ||
|
|
||
| ::: details How do I see how much AI we have used? | ||
| Open the [AI usage](/ai/ai-usage) dashboard. It shows your usage as a percentage of your allowance, along with trends and a breakdown by member, feature, project, model, and agent. | ||
| ::: | ||
|
|
||
| ::: details Where can I see the latest included credit amounts? | ||
|
|
||
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.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Keep documentation headings and sidebar labels identical.
The changed AI pages use labels that do not exactly match the sidebar entries.
docs/ai/ai-usage.md#L2-L6: useAI Usagefor the front matter and H1, or change the sidebar label.docs/.vitepress/config.ts#L744-L744: use the same capitalization as the AI usage page H1.docs/ai/plane-ai-credits.md#L6-L6: useAI creditsfor the H1, or rename the sidebar label toPlane AI credits.As per coding guidelines, “Page headings (
#) must match the sidebar label defined indocs/.vitepress/config.ts.”📍 Affects 3 files
docs/ai/ai-usage.md#L2-L6(this comment)docs/.vitepress/config.ts#L744-L744docs/ai/plane-ai-credits.md#L6-L6🤖 Prompt for AI Agents
Source: Coding guidelines