OpenSign/assets/js/4d139b56.f56ca12e.js

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[7075],{71236(e,t,r){r.r(t),r.d(t,{assets:()=>x,contentTitle:()=>m,default:()=>j,frontMatter:()=>h,metadata:()=>s,toc:()=>X});const s=JSON.parse('{"id":"API-docs/v1.1/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.1/getcredits.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getcredits","permalink":"/docs/API-docs/v1.1/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":"eJztWd1uI7cVfpVTLlCsBf15k7SoUqR1vM7G6DZrrOwuUMvwUMMjDWMOOSE5kgXbQC6KPkDRm972JXrfR9knKQ45HI1kN5sgRW4aYL22yMPD838+Ht0xz5eOTS7ZhUPLrvpMoMutrLw0mk3YeYHwCj0cWxTSOzg6OwWLvrbagUDPpXLA56b24AuEvKHiKy4VnysEb2Bjags8z02t/WSmZ7rXqxTX1w3xpNdruUudq1qggLX0RTzo6nkrD9C5IZwX6BAsOvTA48XOc+vBLAB5XoDGNcylUlIvId/kCoczDXByy8tK4QROF5E1cYPKmpUU6OBwPG7lr9BCabQvgGtBxIBaEI+gJHGMEn4yBosll1rqZT8ynXPFdd6I50h/YhzFJA6tpMRK463vSEim4UKYJ21T1TYvuEMBDituuUe1gYU1JUzRe6mXDt7/9W/BQefmBnX49Hm9gTOLpazLxGgIR0IMjG6VFQa08YC3lbQYFOYWwWi1gZquM6QOVyraq3WxRciNdnWJYhi96o3nqis6BY+rS9J21+e9XrhnT9tej3wrHVisyHya7FdQDHmu2ovz2lrUXm06UbYwlmRt5LCocc3VteAekxjTbhg1BEAEM836zFRoOW2dCjZhS/TNZazPLLrKaIeOTe7Yi/GYfu2myLTOc3RuUSto+bA+y432qD3R86pSMg8bo68dHbpjLi+w5PSX31TIJszMv8bcsz6rLLHxMl7ZNVuHWtflHC3rM4xRzSbjhz7bMecHqXf89UHqrlU7xM5bqZeszxbGltyzCQsEncPsxfjFrwbj3wwOf30+Hk/Cv+F4PP4zeyAhpA9EjRjXFh17eKCdj582dsePFLYLU2vxvzM3WmvsU+pt1XlahF8EqaPcHz+Wm6prl/inFHj/7q7ZpVZS43WK8msSPqnxyWM1TvWKKym2Vean1aR7vY/Xk6i3paJzmpdRpUAU9tmOqt31qKTDvLbSb9jk8o7dDnglB3F/cnn1cNVnJfrCNDWBBOa+YBM22qkQDu0KrQssaqvYhBXeV24yGjmuxdzcDk2F2smlVnzuhrkpR7ySo9Xh8AV76O+f4VX1g+ixHvzQI87zpdTLD5272ppnSi6MXtoxUusrXsk/4Ib1kw+6VH0mKXQK5AJt8JfUCxMON555U6GeyqUOfg2X78OQZ5Bo3v/lny0ZlfvPoNejAk+KDJypbY7w0uR14MeVR6u5lyuE99/+Hea1VD50C4ErVBR9rg/e1s6jgPkGUHu0lZUO3bDXI/7de5dyhS7AAQ65oZj02CcEIeqcBB1Y5GIDOCCLcl9bpJ7pqTKCL6yplwVwcFIvFfbh7cn0nJrG0dnpEKaoBQiT12VoeyRiy6QPJdd8ieCxJH4YZOb5TSAhkOM89zXBJ7DIFXhZYj928tqbknuM2AS1pxafrgElFxjRDBmHWjyhGgJzK9TCWFAmvxlIHfrqYDCgX8+eER4kvAFTgjIoaPVkhXYDFr+p0Xkoa+ch59Zu4r1tupKE1NGzTnxkECMjXJJl2Ux3NifwW+KwXfisoaE+TwDn8kuzJpC1RE2tF/cuvHqegl6Y3D2OdlodFaiqUQJRo6Oz01DZDqL/vzIeHHlyXaANeHaOS6l/BxcOgy69XpPmgHolrdFk2l4PnmffuwxkB8S3ssYbyqfWC3yxwDyYWlEEC+75niuOjUU45hWfSyWpkNL6PRxzj0tjN3AP7wruQ8jmXBPUu5/p+8FgEH6ItNd7maKu14N7QomcotqhFn2oKxE+WVyZmyamBFLcb8NzkNy+Dd+G83mK18D581oqARZrF18GaTNC6crioFI8D+BfLNG7T4MMZBmjEYylLNiEa9G2V0xRLQaUn+GKVykKHC0H0m5WtXZtuIDUK+lDt4KFMuvE9KyeK5nDrvjTgiAvhypuptRTUt+E9NEmcVXS+ZAL0qJIPF9avvDwztgbuily5CvsSGdsxybcgaATLph8ITVXMgZcCURhE99joz3PG+f9MdaJ+HCKwuRxH+bG3FCILS0vS+5lzpXaJCZfGCXQRh5v7JJrumsrmdROCmxLMLy0FI6LeCjxeIfzwpibyOQt5kg0VI4GVI4AV1RxtPFy0QAEBzEyLZi1pgdWZaT2iR2BlsTLW4krTG/IYJHYfoE6CcFO8uD9bmpQ4L//9h8OvsI11Z3UMGjzGRx5z/MiVMF3IdxgWleVsX6mqZtkvN13WROQIB1oswYXCcPLKDqpNVWf5KL42y5EguTYlmC7QNo0MZUWqX65YRL1S7L9NHpz2kTda6lv3ExP0UM2Y4UUeB39fd3E5bUKFGxC3Q3hHhZcOcxI5OzszfQcRkGwJGdGaUZsUth0w9ulsr2rLCTQONya9Vghp+MpdZLzuJrp7NXJOYySjqOJFFlQfnedkieDglJjjqjBeYu8JJAqQppZFLUWXHugR3CJnkKQMtNiaVYomodlZXEhVXji8eS4OLd44gHd6Lxl2OtRz70hA7TvP0DuJFoyVPPubT10xp1bGysGZ9Z4zCk0zl5+sY0o2ic/LaTC66ohnrEs2TUV0LkRG+ozGtbGhttDaUSd203VcHXDxDcE4GSmG3/GwEpmzODf/4Ls7OKRxcNy50Dy5miS6K53yfbiZG9j776wQcWXTJol+7xZLMiBbfRSzbJGtfHLlTLraxOpQgR/V+DuKxpi6AlNvaGZhpK5pGEB6tB1CPrJ2ICa+9pQJ8wVxkeJTevfJvneGkUNNtSHpg1lEB8zIb54nmNFFZt0atLRGoXk6YVEJYDn1jgXkFbQIgwjTO3R0eTDIgLRx3huy8wk9nS6nbooFnwlqWrud/JGpgx6zwUueK38QegJAYw1aJVKrkLufOipW5jaVLjIZyVxTXzaMh7HMG3ek6EsElWcEjXdr2nbELyZGl/GK5qwRXbHXMfMpkaeyPGWrNb05ChN0zvDZfdtaeF2bjQcm2oDz4+PD0g4WUmq0DN9FGZ+2Yzl+dbaj+o1V0YvQysjffBWugCushmbd89RWW/r97ZQx+pH0daii9aLowiUWmeelFwq4EJYdFQ7qKqhoHxvZbRNi+SElOdGD3LSrNsgAQOXMH/bcYB0rUPFEF7LG9zq0Cfxd6SB567OC0IUMUu2GS9FdtAMQBs7RNHIXzYMRcP4LdXyFVc19kMnj1WKLKskGZZgCmBZ+Q1wa/kGnmeXV9nBp2BKGSe00bTegNQF2mZxl/Uetj1qx3snW2DdANzOCuUEdwgXb18/AW6nEXsHIPEDAHmLBNu33S6H73w6t6dPLuAtLh8d/tCTPduHMn9C66QJReqX8DnPb9bcCgfHpqy4lwH6b4iUDlNwLGrCdvNEOMgbwjS2Xh2GMF4dDg/bl1/CXy62RF8Yh7CKF8eCtB23Gmpb0sE82T1w1QbmFmPXzAuul5QIBL46jVpS4Rd1HnMhyBuGzeGdzxXUWqFzYHyBdk0gVBvfzJe35rhwSO/mBgPN9AAuW2j6DudOety++9br9SNLH4QzX9RKQXr8hIT7wGsxHnsl/Zf1HN5iZZz0xm62p5bSF/U8+LJ7tv3QMEiPlHaI9mNeqYHlOdrS0Zh9inYl8w+oP/JEPjoIo++9ec7u2MXiAi3VHbfzxuaVbN7zl0kOIPF+jB40qWveKmEYSKUvDpZ+v88nDPVIhTeLRt9muPXd+rI+UzJH7bAzLDx6dfYaVh8Nx6zfmZJ9D1+OXp8en3w1PSFhmjRhE3Y4HA/HtFQZ50uuOzfRt2jtcGI7Pdwx+N12lvrzN28/f/P2f/DNWzM/9njrR5XiMkzsQyLeNdP2y+73cVd9VhjnafXujtrPhVUPD7T8TY2WxvhXfbbiVpJwYYjfT4NnGs/f4IZyPuB0RoSqjtPrvW8tdkb/r07OWZ/xmoTpDrxvwsC7+YO4py296fDenYRHAeh/Gss/eeDuLg7THx5a+rj1X080CiZqsuHVw8PDfwDLJFN3","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get your account details","permalink":"/docs/API-docs/v1.1/get-user"},"next":{"title":"Create Contact","permalink":"/docs/API-docs/v1.1/createcontact"}}');var n=r(74848),i=r(28453),d=r(57742),o=r.n(d),a=r(78178),l=r.n(a),c=r(19624),p=r.n(c),u=r(96226),y=r.n(u),b=(r(77675),r(19365),r(51107));r(21312);const h={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:"eJztWd1uI7cVfpVTLlCsBf15k7SoUqR1vM7G6DZrrOwuUMvwUMMjDWMOOSE5kgXbQC6KPkDRm972JXrfR9knKQ45HI1kN5sgRW4aYL22yMPD838+Ht0xz5eOTS7ZhUPLrvpMoMutrLw0mk3YeYHwCj0cWxTSOzg6OwWLvrbagUDPpXLA56b24AuEvKHiKy4VnysEb2Bjags8z02t/WSmZ7rXqxTX1w3xpNdruUudq1qggLX0RTzo6nkrD9C5IZwX6BAsOvTA48XOc+vBLAB5XoDGNcylUlIvId/kCoczDXByy8tK4QROF5E1cYPKmpUU6OBwPG7lr9BCabQvgGtBxIBaEI+gJHGMEn4yBosll1rqZT8ynXPFdd6I50h/YhzFJA6tpMRK463vSEim4UKYJ21T1TYvuEMBDituuUe1gYU1JUzRe6mXDt7/9W/BQefmBnX49Hm9gTOLpazLxGgIR0IMjG6VFQa08YC3lbQYFOYWwWi1gZquM6QOVyraq3WxRciNdnWJYhi96o3nqis6BY+rS9J21+e9XrhnT9tej3wrHVisyHya7FdQDHmu2ovz2lrUXm06UbYwlmRt5LCocc3VteAekxjTbhg1BEAEM836zFRoOW2dCjZhS/TNZazPLLrKaIeOTe7Yi/GYfu2myLTOc3RuUSto+bA+y432qD3R86pSMg8bo68dHbpjLi+w5PSX31TIJszMv8bcsz6rLLHxMl7ZNVuHWtflHC3rM4xRzSbjhz7bMecHqXf89UHqrlU7xM5bqZeszxbGltyzCQsEncPsxfjFrwbj3wwOf30+Hk/Cv+F4PP4zeyAhpA9EjRjXFh17eKCdj582dsePFLYLU2vxvzM3WmvsU+pt1XlahF8EqaPcHz+Wm6prl/inFHj/7q7ZpVZS43WK8msSPqnxyWM1TvWKKym2Vean1aR7vY/Xk6i3paJzmpdRpUAU9tmOqt31qKTDvLbSb9jk8o7dDnglB3F/cnn1cNVnJfrCNDWBBOa+YBM22qkQDu0KrQssaqvYhBXeV24yGjmuxdzcDk2F2smlVnzuhrkpR7ySo9Xh8AV76O+f4VX1g+ixHvzQI87zpdTLD5272ppnSi6MXtoxUusrXsk/4Ib1kw+6VH0mKXQK5AJt8JfUCxMON555U6GeyqUOfg2X78OQZ5Bo3v/lny0ZlfvPoNejAk+KDJypbY7w0uR14MeVR6u5lyuE99/+Hea1VD50C4ErVBR9rg/e1s6jgPkGUHu0lZUO3bDXI/7de5dyhS7AAQ65oZj02CcEIeqcBB1Y5GIDOCCLcl9bpJ7pqTKCL6yplwVwcFIvFfbh7cn0nJrG0dnpEKaoBQiT12VoeyRiy6QPJdd8ieCxJH4YZOb5TSAhkOM89zXBJ7DIFXhZYj928tqbknuM2AS1pxafrgElFxjRDBmHWjyhGgJzK9TCWFAmvxlIHfrqYDCgX8+eER4kvAFTgjIoaPVkhXYDFr+p0Xkoa+ch59Zu4r1tupKE1NGzTnxkECMjXJJl2Ux3NifwW+KwXfisoaE+TwDn8kuzJpC1RE2tF/cuvHqegl6Y3D2OdlodFaiqUQJRo6Oz01DZDqL/vzIeHHlyXaANeHaOS6l/BxcOgy69XpPmgHolrdFk2l4PnmffuwxkB8S3ssYbyqfWC3yxwDyYWlEEC+75niuOjUU45hWfSyWpkNL6PRxzj0tjN3AP7wruQ8jmXBPUu5/p+8FgEH6ItNd7maKu14N7QomcotqhFn2oKxE+WVyZmyamBFLcb8NzkNy+Dd+G83mK18D581oqARZrF18GaTNC6crioFI8D+BfLNG7T4MMZBmjEYylLNiEa9G2V0xRLQaUn+GKVykKHC0H0m5WtXZtuIDUK+lDt4KFMuvE9KyeK5nDrvjTgiAvhypuptRTUt+E9NEmcVXS+ZAL0qJIPF9avvDwztgbuily5CvsSGdsxybcgaATLph8ITVXMgZcCURhE99joz3PG+f9MdaJ+HCKwuRxH+bG3FCILS0vS+5lzpXaJCZfGCXQRh5v7JJrumsrmdROCmxLMLy0FI6LeCjxeIfzwpibyOQt5kg0VI4GVI4AV1RxtPFy0QAEBzEyLZi1pgdWZaT2iR2BlsTLW4krTG/IYJHYfoE6CcFO8uD9bmpQ4L//9h8OvsI11Z3UMGjzGRx5z/MiVMF3IdxgWleVsX6mqZtkvN13WROQIB1oswYXCcPLKDqpNVWf5KL42y5EguTYlmC7QNo0MZUWqX65YRL1S7L9NHpz2kTda6lv3ExP0UM2Y4UUeB39fd3E5bUKFGxC3Q3hHhZcOcxI5OzszfQcRkGwJGdGaUZsUth0w9ulsr2rLCTQONya9Vghp+MpdZLzuJrp7NXJOYySjqOJFFlQfnedkieDglJjjqjBeYu8JJAqQppZFLUWXHugR3CJnkKQMtNiaVYomodlZXEhVXji8eS4OLd44gHd6Lxl2OtRz70hA7TvP0DuJFoyVPPubT10xp1bGysGZ9Z4zCk0zl5+sY0o2ic/LaTC66ohnrEs2TUV0LkRG+ozGtbGhttDaUSd203VcHXDxDcE4GSmG3/GwEpmzODf/4Ls7OKRxcNy50Dy5miS6K53yfbiZG9j776wQcWXTJol+7xZLMiBbfRSzbJGtfHLlTLraxOpQgR/V+DuKxpi6AlNvaGZhpK5pGEB6tB1CPrJ2ICa+9pQJ8wVxkeJTevfJvneGkUNNtSHpg1lEB8zIb54nmNFFZt0atLRGoXk6YVEJYDn1jgXkFbQIgwjTO3R0eTDIgLRx3huy8wk9nS6nbooFnwlqWrud/JGpgx6zwUueK38QegJAYw1aJVKrkLufOipW5jaVLjIZyVxTXzaMh7HMG3ek6EsElWcEjXdr2nbELyZGl/GK5qwRXbHXMfMpkaeyPGWrNb05ChN0zvDZfdtaeF2bjQcm2oDz4+PD0g4WUmq0DN9FGZ+2Yzl+dbaj+o1V0YvQysjffBWugCushmbd89RWW/r97ZQx+pH0daii9aLowiUWmeelFwq4EJYdFQ7qKqhoHxvZbRNi+SElOdGD3LSrNsgAQOXMH/bcYB0rUPFEF7LG9zq0Cfxd6SB567OC0IUMUu2GS9FdtAMQBs7RNHIXzYMRcP4LdXyFVc19kMnj1WKLKskGZZgCmBZ+Q1wa/kGnmeXV9nBp2BKGSe00bTegNQF2mZxl/Uetj1qx3snW2DdANzOCuUEdwgXb18/AW6nEXsHIPEDAHmLBNu33S6H73w6t6dPLuAtLh8d/tCTPduHMn9C66QJReqX8DnPb9bcCgfHpqy4lwH6b4iUDlNwLGrCdvNEOMgbwjS2Xh2GMF4dDg/bl1/CXy62RF8Yh7CKF8eCtB23Gmpb0sE82T1w1QbmFmPXzAuul5QIBL46jVpS4Rd1HnMhyBuGzeGdzxXUWqFzYHyBdk0gVBvfzJe35rhwSO/mBgPN9AAuW2j6DudOety++9br9SNLH4QzX9RKQXr8hIT7wGsxHnsl/Zf1HN5iZZz0xm62p5bSF/U8+LJ7tv3QMEiPlHaI9mNeqYHlOdrS0Zh9inYl8w+oP/JEPjoIo++9ec7u2MXiAi3VHbfzxuaVbN7zl0kOIPF+jB40qWveKmEYSKUvDpZ+v88nDPVIhTeLRt9muPXd+rI+UzJH7bAzLDx6dfYaVh8Nx6zfmZJ9D1+OXp8en3w1PSFhmjRhE3Y4HA/HtFQZ50uuOzfRt2jtcGI7Pdwx+N12lvrzN28/f/P2f/DNWzM/9njrR5XiMkzsQyLeNdP2y+73cVd9VhjnafXujtrPhVUPD7T8TY2WxvhXfbbiVpJwYYjfT4NnGs/f4IZyPuB0RoSqjtPrvW8tdkb/r07OWZ/xmoTpDrxvwsC7+YO4py296fDenYRHAeh/Gss/eeDuLg7THx5a+rj1X080CiZqsuHVw8PDfwDLJFN3",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-2",custom_edit_url:null},m=void 0,x={},X=[];function g(e){const t={p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get your API credits"}),"\n",(0,n.jsx)(o(),{method:"get",path:"/getcredits",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Credits API returns details about the credits available to your account:"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.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,n.jsxs)(t.p,{children:[(0,n.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,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"total_credits:"})," The sum of ",(0,n.jsx)(t.strong,{children:"plan_credits"})," and ",(0,n.jsx)(t.strong,{children:"addon_credits"}),". This represents the total credits currently available for use."]}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"renewal_date:"})," The Subscription renewal date"]}),"\n",(0,n.jsx)(l(),{parameters:void 0}),"\n",(0,n.jsx)(p(),{...r(35398)}),"\n",(0,n.jsx)(y(),{...r(40588)})]})}function j(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(g,{...e})}):g(e)}},35398(e){e.exports={title:"Body"}},40588(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"}}}}}}')}}]);