diff --git a/docs/admin/enterprise-portal.mdx b/docs/admin/enterprise-portal.mdx index 453582950..ef949b0f1 100644 --- a/docs/admin/enterprise-portal.mdx +++ b/docs/admin/enterprise-portal.mdx @@ -33,14 +33,39 @@ Subscription admins can view [Sourcegraph Analytics](/analytics) for the subscri ![Sourcegraph Enterprise Portal analytics](https://storage.googleapis.com/sourcegraph-assets/Docs/enterprise-portal-analytics.png) -### Deep Search usage monitoring +## Credits -Site administrators can view their own [Deep Search](/deep-search) usage for the current quota period directly in the Enterprise Portal. This provides visibility into consumption relative to usage limits. +Subscription admins can view credit balances and rates for metered services, including [Deep Search](/deep-search) and [Agentic Batch Changes](/agentic-batch-changes), on the **Credits** page. This replaces the former Deep Search usage monitoring page and shows subscription-wide consumption, not an individual user's usage. -To access usage information, you must first [access the Enterprise Portal](#accessing-sourcegraph-enterprise-portal) as a subscription admin. +1. [Sign in to Enterprise Portal](#accessing-sourcegraph-enterprise-portal) as a subscription admin. +2. Select your subscription. +3. Select **Credits** in the subscription navigation. -![Enterprise Portal Deep Search usage](https://storage.googleapis.com/sourcegraph-assets/Docs/enterprise-portal-deep-search-quota-2.jpg) +### Credit balances +A **credit bucket** is a pool of credits with its own allocation and validity period. Under **Active credit buckets**, the summary shows: + +- **Allocated**: Total credits allocated across currently active buckets. +- **Consumed**: Credits used from those buckets. +- **Remaining**: Unused credits summed across those buckets. Consumption beyond a bucket's allocation is shown separately as **over allocated**, rather than subtracted from another bucket's remaining credits. + +Expired buckets and buckets whose start date is in the future are excluded. These figures describe active allocations, not all-time usage or usage during a selectable date range. + +The table lists each active bucket's **Name**, **Credits** consumed out of its total, **Start** date, and **Expires** date. Buckets that have used their allocation are marked **Depleted**. Dates are displayed in UTC. If there are no active buckets, the page displays **No active credit buckets**. + +If your subscription has an uncapped overage bucket, its row shows consumption out of **∞**. These buckets are excluded from the numeric summary totals; **Allocated** displays **+ unlimited bucket** to indicate their presence. + +### Credit rates and purchasing + +The **Credit rates** table lists metered services and their **Credits per unit**. Check this table for current rates, Beta status, general availability dates, and any promotional notes. For the policy on when features begin consuming credits, see [credits and billing](/beta-and-experimental#credits-and-billing). + +To purchase additional credits, contact [Sourcegraph support](mailto:support@sourcegraph.com). Enterprise Portal does not offer self-service credit purchases. + +### Detailed usage and limits + +For a more detailed credit usage breakdown, follow the **Sourcegraph Analytics** link on the Credits page when available. See [Sourcegraph Analytics](/analytics#enablement-instructions) for access requirements. + +Credit balances are separate from administrator-configured usage limits. To control Deep Search usage, configure [entitlements](/admin/entitlements) or [role-based access control](/admin/access-control) on your Sourcegraph instance. ## Architecture diff --git a/docs/deep-search/index.mdx b/docs/deep-search/index.mdx index e88f620e1..950713035 100644 --- a/docs/deep-search/index.mdx +++ b/docs/deep-search/index.mdx @@ -138,7 +138,7 @@ If your Sourcegraph instance sits behind a reverse proxy, load balancer, or ingr Deep Search consumes credits from your Sourcegraph subscription's credit balance. -Customers can request access to [Enterprise Portal](/admin/enterprise-portal#deep-search-usage-monitoring) to monitor Deep Search credit consumption. +Subscription admins can view credit balances and current rates on the [Credits page in Enterprise Portal](/admin/enterprise-portal#credits). For a detailed credit usage breakdown, follow the Sourcegraph Analytics link on that page when available. ## Managing usage