From e1da69398cfe3c6bd3b2d691932d429dcf289332 Mon Sep 17 00:00:00 2001 From: pravin Date: Wed, 10 Dec 2025 16:52:40 +0530 Subject: [PATCH] Update APIToken.md Updated the help document for api credits --- docs/docs/help/Settings/APIToken.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/docs/help/Settings/APIToken.md b/docs/docs/help/Settings/APIToken.md index 01a39aed2..ef62b10c2 100644 --- a/docs/docs/help/Settings/APIToken.md +++ b/docs/docs/help/Settings/APIToken.md @@ -41,6 +41,35 @@ You’ll also find the option to generate a **Sandbox API Token** on the same pa Sandbox api token +### 🧪 API Credits + +**Premium Credits Available:** +Displays the total API credits available for your organisation. + +**Your Credits Usage:** +- **Used Credits:** The number of credits you have consumed. +- **Remaining Credits:** The number of credits still available for you to use. + +API credit + +### Where API Credits Are Deducted + +API credits are consumed whenever a document is created through the following actions: + +- **Self Sign API:** Credits deducted when a document is created. +- **Draft Document API:** Deducted when drafting a document. +- **Create Document API:** Deducted on document creation. +- **Draft Template API:** Deducted when: + - Sending a document if signers are already assigned, + - Bulk sending, + - Creating documents using public templates (signer fills details and finish). +- **Create Document From Template API:** Deducted on document creation. + +### In the OpenSign Application + +- **Manage Templates → Bulk Send:** Credits are deducted for each document created. +- **Public Template Signing:** Credits are deducted when a document is created during public signing (when the signer enters details and completes the process). + ### 🧪 Sandbox Cloud Account Login 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.