Skip to content

Commit 35563ee

Browse files
authored
Merge pull request #2101 from Ishavyas9/main
Credits Management doc
2 parents 7590c6b + 07d72f8 commit 35563ee

File tree

2 files changed

+160
-0
lines changed

2 files changed

+160
-0
lines changed

docs/credits-management.md

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
---
2+
id: credits-management
3+
title: Credits Usage & Management in LambdaTest
4+
hide_title: false
5+
sidebar_label: Credits Management
6+
description: Guide for usage of credits for AI features in LambdaTest
7+
keywords:
8+
- credits
9+
- AI
10+
url: https://www.lambdatest.com/support/docs/credits-management/
11+
site_name: LambdaTest
12+
slug: credits-management/
13+
---
14+
15+
import CodeBlock from '@theme/CodeBlock';
16+
import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
17+
18+
<script type="application/ld+json"
19+
dangerouslySetInnerHTML={{ __html: JSON.stringify({
20+
"@context": "https://schema.org",
21+
"@type": "BreadcrumbList",
22+
"itemListElement": [{
23+
"@type": "ListItem",
24+
"position": 1,
25+
"name": "LambdaTest",
26+
"item": "https://www.lambdatest.com"
27+
},{
28+
"@type": "ListItem",
29+
"position": 2,
30+
"name": "Support",
31+
"item": "https://www.lambdatest.com/support/docs/"
32+
},{
33+
"@type": "ListItem",
34+
"position": 3,
35+
"name": "Network Throttling",
36+
"item": "https://www.lambdatest.com/support/docs/credits-management/"
37+
}]
38+
})
39+
}}
40+
></script>
41+
42+
LambdaTest supports a **credit management system** as an add‑on over your active subscriptions for LambdaTest products. Many products include additional **AI features** that are powered by credits. This guide explains how credits work, how to view usage, and how admins can control consumption.
43+
44+
---
45+
46+
## Who gets credits?
47+
48+
* **Free users:** Receive **1,000 complimentary credits** to try AI‑powered features.
49+
* **Paid users:** Receive **complimentary credits** based on subscription to try AI‑powered features and can purchase credits as an add‑on at any time. Credits are used only when AI features are invoked.
50+
51+
:::tip
52+
Once free credits are exhausted, AI features will be unavailable until you **upgrade or purchase credits** from the Billing page. Use this link to buy credits directly: [Upgrade / Buy Credits](https://billing.lambdatest.com/billing/subscriptions?addCredits=true).
53+
:::
54+
55+
---
56+
57+
## View your current credit balance
58+
59+
If you are an **admin** in LambdaTest organization, you can see the current credits and subscription details in [Billing & Subscriptions](https://billing.lambdatest.com/billing/subscriptions).
60+
61+
---
62+
63+
## View credit transactions
64+
65+
**Admins** can view detailed **debits and credits** for your organization - **[Transactions view](https://billing.lambdatest.com/billing/subscriptions?viewCredits=true)**.
66+
67+
The transactions table shows:
68+
69+
* **Date** of the event
70+
* **Type** (Debit / Credit)
71+
* **Credits** (Amount of credits)
72+
* **Name** of the user who did the transaction
73+
74+
---
75+
76+
## Set credit usage limits (Admins Only)
77+
78+
Admins can define **org‑wide controls** to prevent unexpected consumption:
79+
80+
* **Soft Limit**
81+
When the soft limit is reached, users are **notified via email**, but usage **continues**.
82+
83+
* **Hard Limit**
84+
When the hard limit is reached, **no further credit consumption** is allowed. Users are notified via email. To resume, increase the limit or purchase more credits.
85+
86+
:::tip
87+
**Recommendation:** Start with a soft limit (e.g., 70–80% of your monthly plan) and a hard limit (e.g., 90%).
88+
:::
89+
90+
---
91+
92+
## AI features that consume credits
93+
94+
Below are the currently supported features and how they consume credits.
95+
96+
### SmartUI Visual AI
97+
98+
LambdaTest **SmartUI Visual AI** simulates human perception for visual regression. Rather than flagging every pixel change, it highlights **meaningful, human‑relevant** differences between baseline and new screenshots. [Learn more](https://www.lambdatest.com/support/docs/smartui-visual-ai/).
99+
100+
#### How credits are consumed?
101+
102+
**Small / Normal Screenshot**
103+
104+
* A page or screen that fits within a typical device viewport (e.g., one laptop or mobile screen)
105+
* Examples: login page, product details, simple dashboard
106+
* **Consumes \~1–4 credits** (most common)
107+
108+
**Large Screenshot**
109+
* A long or content‑heavy page beyond the standard viewport (full‑page scroll, data‑heavy dashboards)
110+
* Examples: full home page, long reports, multi‑section dashboards
111+
* **Consumes \~5–8 credits** (less common)
112+
113+
**In summary:** The bigger and more content‑heavy the screenshot, the more credits it consumes.
114+
115+
---
116+
117+
### AI Test Case Generator
118+
119+
The **AI Test Case Generator** converts diverse inputs (text, PDFs, audio, videos, images, Jira tickets, and more) into **structured, contextual test cases**, accelerating authoring while improving coverage. [Learn more](https://www.lambdatest.com/support/docs/generate-test-cases-with-ai/).
120+
121+
#### How credits are consumed
122+
123+
* **10 credits per scenario** generated.
124+
* When you start generation, credits are tentatively consumed based on **Max Scenarios** you select (default **5**).
125+
Example: Default 5 → **50 credits** tentatively consumed when you begin.
126+
* If fewer scenarios are produced (e.g., **4**), **10 credits are credited back**, so you only pay for what’s actually generated.
127+
* **Regeneration** also consumes credits at **10 credits per scenario**.
128+
129+
>This ensures fair usage—you are charged only for **actual output** produced by the AI.
130+
---
131+
132+
## FAQs
133+
134+
**Q: What happens when my credits run out?**
135+
AI features that require credits will be disabled. You can **purchase credits** or **upgrade** [here](https://billing.lambdatest.com/billing/subscriptions?addCredits=true).
136+
137+
**Q: Who can view balances and transactions?**
138+
Users with the **Admin** role in your LambdaTest organization.
139+
140+
**Q: Do unused credits expire?**
141+
For free users, complimentary credits are provided for one-time usage and do not expire. While for users subscribed to LambdaTest products, the complimentary credits get reset at the beginning of each month. Any credits explicitly purchased, do not expire.
142+
143+
**Q: Why were credits refunded after generation?**
144+
When fewer scenarios than the selected Max Scenarios are generated, the difference is **credited back automatically**.
145+
146+
**Q: Can I cap my organization’s usage?**
147+
Yes—set **Soft** and **Hard** limits (Admins only).
148+
149+
---
150+
151+
## What’s next
152+
153+
Additional AI features will join the credit system shortly. Watch the **LambdaTest Changelog** and Support Docs for updates.
154+
155+
If you have questions about credits, billing, or limits, reach out to **[[email protected]](mailto:[email protected])**.

sidebars.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3805,6 +3805,11 @@ module.exports = {
38053805
label: "Manage Subscriptions",
38063806
id: "manage-subscriptions",
38073807
},
3808+
{
3809+
type: "doc",
3810+
label: "Credits Management",
3811+
id: "credits-management",
3812+
},
38083813
{
38093814
type: "doc",
38103815
label: "Service Accounts",

0 commit comments

Comments
 (0)