Skip to content

Commit e1da693

Browse files
Update APIToken.md
Updated the help document for api credits
1 parent 3f4cffb commit e1da693

1 file changed

Lines changed: 29 additions & 0 deletions

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.

0 commit comments

Comments
 (0)