Skip to content

Commit efa5e2e

Browse files
Merge pull request #2052 from pravinOpenSign/patch-50
Patch 50
2 parents 3d91b8b + c58566e commit efa5e2e

2 files changed

Lines changed: 63 additions & 1 deletion

File tree

docs/docs/help/Settings/APIToken.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,35 @@ You’ll also find the option to generate a **Sandbox API Token** on the same pa
4141

4242
<img width="436" alt="Sandbox api token" src="https://github.com/user-attachments/assets/f27d9e00-7989-4c01-b23e-cecaccce4be2" />
4343

44+
### 🧪 API Credits
45+
46+
**Premium Credits Available:**
47+
Displays the total API credits available for your organisation.
48+
49+
**Your Credits Usage:**
50+
- **Used Credits:** The number of credits you have consumed.
51+
- **Remaining Credits:** The number of credits still available for you to use.
52+
53+
<img width="436" alt="API credit" src="https://github.com/user-attachments/assets/e0d87fb2-7391-4bad-b668-9ce2b558c52d" />
54+
55+
### Where API Credits Are Deducted
56+
57+
API credits are consumed whenever a document is created through the following actions:
58+
59+
- **Self Sign API:** Credits deducted when a document is created.
60+
- **Draft Document API:** Deducted when drafting a document.
61+
- **Create Document API:** Deducted on document creation.
62+
- **Draft Template API:** Deducted when:
63+
- Sending a document if signers are already assigned,
64+
- Bulk sending,
65+
- Creating documents using public templates (signer fills details and finish).
66+
- **Create Document From Template API:** Deducted on document creation.
67+
68+
### In the OpenSign Application
69+
70+
- **Manage Templates → Bulk Send:** Credits are deducted for each document created.
71+
- **Public Template Signing:** Credits are deducted when a document is created during public signing (when the signer enters details and completes the process).
72+
4473
### 🧪 Sandbox Cloud Account Login
4574

4675
OpenSign provides a **sandbox testing cloud environment**, which is a replica of the production environment. This allows users to test features without affecting live data.

docs/docs/help/Settings/manage-users.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,40 @@ To add a new user:
7373
3. Enter the user’s email in the input box and click **Delete**.
7474
- After deletion, the user (and all related data) will be permanently erased.
7575

76-
> **Note:** Once a user is deleted, your **available user count will automatically increase**.
76+
> **Note:** Once a user is deleted, your **available user count will automatically increase**.
77+
78+
## 🔁 Change Password
79+
80+
- OpenSign allows **admins** to update a team user's password whenever required.
81+
82+
- **To change a user’s password:**
83+
1. Navigate to **Settings → Users** and click the **Change Password** button next to the user whose password needs to be updated.
84+
2. Enter the new password on the reset password screen and submit.
85+
86+
- The user’s password will be successfully updated, and they will no longer be able to log in using the old password.
87+
88+
## 🔁 Add API Credits
89+
90+
- OpenSign allows **admins to assign API credits** to team users. This feature helps control and limit how many API-based document operations a user can perform.
91+
- A team user can only use the number of credits allocated by the admin.
92+
- For example, if an admin assigns **100 API credits**, the user can perform API actions only until those 100 credits are consumed.
93+
- Once credits are exhausted, the admin can add more.
94+
- Example: If the admin wants to give the user 50 additional credits, they must enter the updated total — 150 credits. After updating, the user will have 50 usable credits remaining.
95+
96+
- **How to add API credits:**
97+
1. Navigate to **Settings → Users** and click the **Add Credits** button next to the user who needs add API credits.
98+
2. Enter the number of credits to allocate and submit.
99+
100+
- The user will now be able to use the assigned API credits up to the new limit.
101+
102+
> **Note:** Credits can only be added if the selected user has an active API token.
103+
104+
**How to create an API token for a team user:**
105+
1. Log in using the team user's email address.
106+
2. Navigate to **Settings → API Token**.
107+
3. Generate a live API token.
108+
109+
Once the API token is created, the admin can assign API credits to that user.
77110

78111
---
79112

0 commit comments

Comments
 (0)