OpenSign/assets/js/98732f61.e5fa7be2.js

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1065],{73407(e,t,s){s.r(t),s.d(t,{assets:()=>x,contentTitle:()=>j,default:()=>m,frontMatter:()=>G,metadata:()=>r,toc:()=>g});const r=JSON.parse('{"id":"API-docs/v1.2/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","source":"@site/docs/API-docs/v1.2/getcredits.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/getcredits","permalink":"/docs/API-docs/v1.2/getcredits","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar_label":"Get your API credits","hide_title":true,"hide_table_of_contents":true,"api":"eJztWFtvI7cV/iunfGizg7Gk3SYtqrzUDQzXiJFd1F4sUNswKPKMhjGHZHjRBYKAPBT9Ae1TX/vT9pcUh3PRSHawCVrkpQEW3pnhuXznwnPRjkW+DGx+x94H9OyhZBKD8MpFZQ2bs9sa4RIjfOVRqhjg/N0VeIzJmwASI1c6AF/YFCHWCKKj4iuuNF9ohGhha5MHLoRNJs7vzb0pCqe5eeyI50UxSFdG6CRRwlrFumUMaTHgAeKbwG2NAcFjwAi8VRwi9xFsBchFDQbXsFBaK7MEsRUaJ/cG4GLDG6dxDldVK5qkgfN2pSQGeD2bDfgdemisiTVwI4kY0EiSkY0kiS3CL2bgseHKKLMsW6ELrrkRHbxA9pPgFiZJGJCSKIObOEJIruFS2hd945IXNQ8oIaDjnkfUW6i8beAGY1RmGeDj3/+RA3Rrn9Dktz+lLbzz2KjU9IImcC7lmTWDsdKCsRFw45THbDD3CNboLSRSZ8kcrnXrryHEHkFYE1KDctJGNdrI9Rg6JU9IDVl7HPOiyHpOrC0Kiq0K4NGR+wz5r6YcilwPikXyHk3U21GWVdYT1g6HR4Nrrh8lj9jDuBmnUUcARHBvWMmsQ8/p6EqyOVti7JSxknkMzpqAgc137M1sRv8dX5GbJASGUCUNgxxWMmFNRBOJnjunlcgH028DMe1YEDU2nJ7i1iGbM7v4FkVkJXOexETVqhy7bURtUrNAz0qGbVaz+WxfsiN3fpL6KF6fpB57dUQcoldmyUpWWd/wyOYsE4yY2ZvZm9+dzf5w9vr3t7PZPP+bzGazv7I9gVAxE3UwHj0Gtt/TyecvO3sUR0rbyiYj/3fuRu+tf8m8gzkvQ/hVRt3i/vw5bqquY+KfE/Cp7rHbldHK4GOf5Y8Evjfji+dmXJkV10oeqszPa8lYfWzVE9RNo4nP8KY1KRPlc3Zk6vh7a2RAkbyKWza/27HNGXfqrD2f3z3sH0rWYKxtVxMIMI81m7PpUYUI6FfoQxaRvGZzVsfownw6DdzIhd1MrEMT1NJovggTYZspd2q6ej15w/blKQ937ifRYzr7qSwh8qUyy0/xPRzcc0MhbKN05KQhVtypr3HLyj4GY6qSKUqdGrlEn+OlTGUzcxeZtw7NjVqaHNes/HQM+YBa2CaPE9QRiqJn+fi3fw9cRQHSitSgiTkDczt4S43ertFTfaamU2ncKGoaxIZNPgu5x0cLAXmjMQS9BWUiLqnNglRLRR2I/JRHCu74QmlFiUtk/YhzyP0wgQ81xho9Hf2G2ipIXKGmfAeeom04tewBL6ytf6q0XYcSOCxSUAZDADQ1N4II+0iUYD1wA2gieudVoNnHE2rVYrMmei4iNNzwJZLsEsbOkqgVpSt4u0ghQrA6ZchAw5z1KIeZzSDKkJ14sXF0BPRV2MZ5rCltVgjLRMNTCcJKhJDvKZlgJCwwRHCERQnMg1Ay2oqnHMAq0TxhqWwormlAGGMk9ui5CdRTWix9DAaHOW+p62Lomv77gBTha2WeaPa4N2dwN+TVB1wEFfHhs/4KrNfrZ6n/6pjnUsU/pwX8BZ0NKlq/PXAvVazTIl+XsZDhpZV0iQZz/owuw0GGtCI8v330dVqjdtN+qJuev7vKlfYVfPz+n3CN3Buo7brNVpE8jYHLXhV5ro1867ahUOYRiadYk8dFm3wev0sYYu/BDzWPH7//V4BvcA3KdFeKTCkKWgFusXGalPwajl6vVYhFMadJ2K5QQjIGKTTcb4EG1QYj5RtB6ydXCc5jpXQewXg7xZIf0I84JqT6nlVK46PjIaytl/fsQABc0qqg8kxKQGKHqITk5PGHjuJw3Wh6PxxLz6t4OG2h6ipjAm9TbBO42xWgR5Od6ryNKLJNsupBc63t+tFWVe6uJOZHIc+aT8CP9GepNOj6/IomD7+WbkdoH1uFQ6UifLFG5QdpPcDW24/eanwZWd6qMlGAtmHTLT121DO/ftLRzyJFBru00EqcGjyBcyHQkWNXXCcMcyiKFlFRwGcSK550fFVCUawUrukrPXNHUaK3Cdx0+BsqdDVfIe1hGnmIYDsv8Zg8LXNyifFLaAWNGYztDsOX0IsO0PBtJ89s+/NsKi3CfCSYrpjyuQxP8qZx0j6Pu5zHCj35Lof3cKmd6i7xXV8MgGrEf1NMaDCiXsFFnttoidVtH//jqZw8Q6FvwtvqBv1KCexmiR+oo9NMPGUl00qgCTiazc4v313D6reTGStHQ8mPKKnT66uvLr65uSAwFILWYa8ns8mMPjkbYsPNSBOVqKEEHoa1I4fvDqPrLz90/PJDx//BDx3duB5xE6dOc5UXpHwRd91yczf++eOhZLUNkb7udgse8L3X+z19/i6hp63poWQr7hWByztT2c/5tA094ZbufC7jjAh1apeFkyXxaNO6vLhlJaNR5Xi/eMr7RfdA0vsjsx3JPl48WgD0l7agFxl2u3Z32e8H+vboBzk6A3tq8uHDfr//D/mTjkI=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/v1.2/get-user"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/v1.2/createcontact"}}');var i=s(74848),n=s(28453),a=s(57742),c=s.n(a),d=s(78178),o=s.n(d),l=s(19624),p=s.n(l),u=s(96226),h=s.n(u),f=(s(77675),s(19365),s(51107));s(21312);const G={id:"getcredits",title:"Get your API credits",description:"The Get Credits API returns details about the credits available to your account:",sidebar_label:"Get your API credits",hide_title:!0,hide_table_of_contents:!0,api:"eJztWFtvI7cV/iunfGizg7Gk3SYtqrzUDQzXiJFd1F4sUNswKPKMhjGHZHjRBYKAPBT9Ae1TX/vT9pcUh3PRSHawCVrkpQEW3pnhuXznwnPRjkW+DGx+x94H9OyhZBKD8MpFZQ2bs9sa4RIjfOVRqhjg/N0VeIzJmwASI1c6AF/YFCHWCKKj4iuuNF9ohGhha5MHLoRNJs7vzb0pCqe5eeyI50UxSFdG6CRRwlrFumUMaTHgAeKbwG2NAcFjwAi8VRwi9xFsBchFDQbXsFBaK7MEsRUaJ/cG4GLDG6dxDldVK5qkgfN2pSQGeD2bDfgdemisiTVwI4kY0EiSkY0kiS3CL2bgseHKKLMsW6ELrrkRHbxA9pPgFiZJGJCSKIObOEJIruFS2hd945IXNQ8oIaDjnkfUW6i8beAGY1RmGeDj3/+RA3Rrn9Dktz+lLbzz2KjU9IImcC7lmTWDsdKCsRFw45THbDD3CNboLSRSZ8kcrnXrryHEHkFYE1KDctJGNdrI9Rg6JU9IDVl7HPOiyHpOrC0Kiq0K4NGR+wz5r6YcilwPikXyHk3U21GWVdYT1g6HR4Nrrh8lj9jDuBmnUUcARHBvWMmsQ8/p6EqyOVti7JSxknkMzpqAgc137M1sRv8dX5GbJASGUCUNgxxWMmFNRBOJnjunlcgH028DMe1YEDU2nJ7i1iGbM7v4FkVkJXOexETVqhy7bURtUrNAz0qGbVaz+WxfsiN3fpL6KF6fpB57dUQcoldmyUpWWd/wyOYsE4yY2ZvZm9+dzf5w9vr3t7PZPP+bzGazv7I9gVAxE3UwHj0Gtt/TyecvO3sUR0rbyiYj/3fuRu+tf8m8gzkvQ/hVRt3i/vw5bqquY+KfE/Cp7rHbldHK4GOf5Y8Evjfji+dmXJkV10oeqszPa8lYfWzVE9RNo4nP8KY1KRPlc3Zk6vh7a2RAkbyKWza/27HNGXfqrD2f3z3sH0rWYKxtVxMIMI81m7PpUYUI6FfoQxaRvGZzVsfownw6DdzIhd1MrEMT1NJovggTYZspd2q6ej15w/blKQ937ifRYzr7qSwh8qUyy0/xPRzcc0MhbKN05KQhVtypr3HLyj4GY6qSKUqdGrlEn+OlTGUzcxeZtw7NjVqaHNes/HQM+YBa2CaPE9QRiqJn+fi3fw9cRQHSitSgiTkDczt4S43ertFTfaamU2ncKGoaxIZNPgu5x0cLAXmjMQS9BWUiLqnNglRLRR2I/JRHCu74QmlFiUtk/YhzyP0wgQ81xho9Hf2G2ipIXKGmfAeeom04tewBL6ytf6q0XYcSOCxSUAZDADQ1N4II+0iUYD1wA2gieudVoNnHE2rVYrMmei4iNNzwJZLsEsbOkqgVpSt4u0ghQrA6ZchAw5z1KIeZzSDKkJ14sXF0BPRV2MZ5rCltVgjLRMNTCcJKhJDvKZlgJCwwRHCERQnMg1Ay2oqnHMAq0TxhqWwormlAGGMk9ui5CdRTWix9DAaHOW+p62Lomv77gBTha2WeaPa4N2dwN+TVB1wEFfHhs/4KrNfrZ6n/6pjnUsU/pwX8BZ0NKlq/PXAvVazTIl+XsZDhpZV0iQZz/owuw0GGtCI8v330dVqjdtN+qJuev7vKlfYVfPz+n3CN3Buo7brNVpE8jYHLXhV5ro1867ahUOYRiadYk8dFm3wev0sYYu/BDzWPH7//V4BvcA3KdFeKTCkKWgFusXGalPwajl6vVYhFMadJ2K5QQjIGKTTcb4EG1QYj5RtB6ydXCc5jpXQewXg7xZIf0I84JqT6nlVK46PjIaytl/fsQABc0qqg8kxKQGKHqITk5PGHjuJw3Wh6PxxLz6t4OG2h6ipjAm9TbBO42xWgR5Od6ryNKLJNsupBc63t+tFWVe6uJOZHIc+aT8CP9GepNOj6/IomD7+WbkdoH1uFQ6UifLFG5QdpPcDW24/eanwZWd6qMlGAtmHTLT121DO/ftLRzyJFBru00EqcGjyBcyHQkWNXXCcMcyiKFlFRwGcSK550fFVCUawUrukrPXNHUaK3Cdx0+BsqdDVfIe1hGnmIYDsv8Zg8LXNyifFLaAWNGYztDsOX0IsO0PBtJ89s+/NsKi3CfCSYrpjyuQxP8qZx0j6Pu5zHCj35Lof3cKmd6i7xXV8MgGrEf1NMaDCiXsFFnttoidVtH//jqZw8Q6FvwtvqBv1KCexmiR+oo9NMPGUl00qgCTiazc4v313D6reTGStHQ8mPKKnT66uvLr65uSAwFILWYa8ns8mMPjkbYsPNSBOVqKEEHoa1I4fvDqPrLz90/PJDx//BDx3duB5xE6dOc5UXpHwRd91yczf++eOhZLUNkb7udgse8L3X+z19/i6hp63poWQr7hWByztT2c/5tA094ZbufC7jjAh1apeFkyXxaNO6vLhlJaNR5Xi/eMr7RfdA0vsjsx3JPl48WgD0l7agFxl2u3Z32e8H+vboBzk6A3tq8uHDfr//D/mTjkI=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},j=void 0,x={},g=[];function K(e){const t={p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get your API credits"}),"\n",(0,i.jsx)(c(),{method:"get",path:"/getcredits",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Credits API returns details about the credits available to your account:"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"plan_credits:"})," Credits included with your subscription plan. These reset at the start of each new billing cycle.\nExample: If your plan provides 100 credits per month and you end\nthe cycle with 50 remaining, your balance resets to 100 at the\nstart of the next cycle."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"addon_credits:"})," Credits purchased separately from Settings \u2192 API Token \u2192 Buy Premium Credits. Add-on credits do not expire and are only used once all plan credits are consumed."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"total_credits:"})," The sum of ",(0,i.jsx)(t.strong,{children:"plan_credits"})," and ",(0,i.jsx)(t.strong,{children:"addon_credits"}),". This represents the total credits currently available for use."]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"renewal_date:"})," The Subscription renewal date"]}),"\n",(0,i.jsx)(o(),{parameters:void 0}),"\n",(0,i.jsx)(p(),{...s(6977)}),"\n",(0,i.jsx)(h(),{...s(85287)})]})}function m(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(K,{...e})}):K(e)}},6977(e){e.exports={title:"Body"}},85287(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"plan_credits":{"type":"number","example":0},"addon_credits":{"type":"number","example":0},"total_credits":{"type":"number","example":0},"renewal_date":{"type":"string","format":"date","example":"2026-09-17T00:00:00.000Z"}},"title":"credits_res"}}}},"400":{"description":"Subscription not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Subscription not found!"}}}}}},"404":{"description":"User not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"User not found!"}},"title":"inline_response_404"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]);