CINXE.COM

<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><title>Partner Program API | Text Platform Docs & API Reference</title><link rel="canonical" href="https://platform.text.com/docs/monetization/partner-program-api"/><link rel="preconnect" href="https://LATDYRDX9J-dsn.algolia.net" crossorigin="true"/><meta name="description" content="Getting started with the LiveChat Partners API? See our API documentation to make the best use of partnership."/><meta property="og:title" content="Partner Program API"/><meta property="og:description" content="Getting started with the LiveChat Partners API? See our API documentation to make the best use of partnership."/><meta property="og:type" content="website"/><meta property="og:image" content="https://platform.text.com/docs/images/text-docs-og.png"/><link rel="icon" href="/docs/images/favicon.ico"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:creator" content="@textplatform"/><meta name="twitter:title" content="Partner Program API"/><meta name="twitter:description" content="Getting started with the LiveChat Partners API? See our API documentation to make the best use of partnership."/><meta name="twitter:image" content="https://platform.text.com/docs/images/livechat-docs-og.png"/><script type="text/javascript"> window.__lc = window.__lc || {}; window.__lc.license = 1520; ;(function(n,t,c){function i(n){return e._h?e._h.apply(null,n):e._q.push(n)}var e={_q:[],_h:null,_v:"2.0",on:function(){i(["on",c.call(arguments)])},once:function(){i(["once",c.call(arguments)])},off:function(){i(["off",c.call(arguments)])},get:function(){if(!e._h)throw new Error("[LiveChatWidget] You can't use getters before load.");return i(["get",c.call(arguments)])},call:function(){i(["call",c.call(arguments)])},init:function(){var n=t.createElement("script");n.async=!0,n.type="text/javascript",n.src="https://cdn.livechatinc.com/staging/tracking.js",t.head.appendChild(n)}};!n.__lc.asyncInit&&e.init(),n.LiveChatWidget=n.LiveChatWidget||e}(window,document,[].slice)) </script><meta name="next-head-count" content="17"/><link rel="preload" href="/docs/_next/static/css/5c94b719b441ef6e576e.css" as="style"/><link rel="stylesheet" href="/docs/_next/static/css/5c94b719b441ef6e576e.css" data-n-g=""/><noscript data-n-css=""></noscript><link rel="preload" href="/docs/_next/static/chunks/webpack-af19fbe32e13fc779465.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/framework.57a22ac5870571c2eff5.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/commons.0889bf71124535c6c4cd.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/main-7bb61c4f8d40f1e634e9.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/pages/_app-cdbe91fdfdbd305577ef.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/f66b9295.f9eceaafe4216b86326e.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/b31dc3a52fd33fe1943f491eae223576a0413e10.ac30430b2138b8fefed8.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/067aff065064306958fa97cea949633bebf95d70.dede6f8249fbb82aff52.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/pages/monetization/partner-program-api-a4d20582b6fc3c5898db.js" as="script"/> <script>!function(e){var n="https://s.go-mpulse.net/boomerang/";if("False"=="True")e.BOOMR_config=e.BOOMR_config||{},e.BOOMR_config.PageParams=e.BOOMR_config.PageParams||{},e.BOOMR_config.PageParams.pci=!0,n="https://s2.go-mpulse.net/boomerang/";if(window.BOOMR_API_key="SWHJY-Y2PHV-NVPM2-PDH42-VMPQS",function(){function e(){if(!o){var e=document.createElement("script");e.id="boomr-scr-as",e.src=window.BOOMR.url,e.async=!0,i.parentNode.appendChild(e),o=!0}}function t(e){o=!0;var n,t,a,r,d=document,O=window;if(window.BOOMR.snippetMethod=e?"if":"i",t=function(e,n){var t=d.createElement("script");t.id=n||"boomr-if-as",t.src=window.BOOMR.url,BOOMR_lstart=(new Date).getTime(),e=e||d.body,e.appendChild(t)},!window.addEventListener&&window.attachEvent&&navigator.userAgent.match(/MSIE [67]\./))return window.BOOMR.snippetMethod="s",void t(i.parentNode,"boomr-async");a=document.createElement("IFRAME"),a.src="about:blank",a.title="",a.role="presentation",a.loading="eager",r=(a.frameElement||a).style,r.width=0,r.height=0,r.border=0,r.display="none",i.parentNode.appendChild(a);try{O=a.contentWindow,d=O.document.open()}catch(_){n=document.domain,a.src="javascript:var d=document.open();d.domain='"+n+"';void(0);",O=a.contentWindow,d=O.document.open()}if(n)d._boomrl=function(){this.domain=n,t()},d.write("<bo"+"dy onload='document._boomrl();'>");else if(O._boomrl=function(){t()},O.addEventListener)O.addEventListener("load",O._boomrl,!1);else if(O.attachEvent)O.attachEvent("onload",O._boomrl);d.close()}function a(e){window.BOOMR_onload=e&&e.timeStamp||(new Date).getTime()}if(!window.BOOMR||!window.BOOMR.version&&!window.BOOMR.snippetExecuted){window.BOOMR=window.BOOMR||{},window.BOOMR.snippetStart=(new Date).getTime(),window.BOOMR.snippetExecuted=!0,window.BOOMR.snippetVersion=12,window.BOOMR.url=n+"SWHJY-Y2PHV-NVPM2-PDH42-VMPQS";var i=document.currentScript||document.getElementsByTagName("script")[0],o=!1,r=document.createElement("link");if(r.relList&&"function"==typeof r.relList.supports&&r.relList.supports("preload")&&"as"in r)window.BOOMR.snippetMethod="p",r.href=window.BOOMR.url,r.rel="preload",r.as="script",r.addEventListener("load",e),r.addEventListener("error",function(){t(!0)}),setTimeout(function(){if(!o)t(!0)},3e3),BOOMR_lstart=(new Date).getTime(),i.parentNode.appendChild(r);else t(!1);if(window.addEventListener)window.addEventListener("load",a,!1);else if(window.attachEvent)window.attachEvent("onload",a)}}(),"".length>0)if(e&&"performance"in e&&e.performance&&"function"==typeof e.performance.setResourceTimingBufferSize)e.performance.setResourceTimingBufferSize();!function(){if(BOOMR=e.BOOMR||{},BOOMR.plugins=BOOMR.plugins||{},!BOOMR.plugins.AK){var n=""=="true"?1:0,t="",a="bdpnbeqxglupcz2bkv3a-f-eabf53f79-clientnsv4-s.akamaihd.net",i="false"=="true"?2:1,o={"ak.v":"39","ak.cp":"1461330","ak.ai":parseInt("908031",10),"ak.ol":"0","ak.cr":0,"ak.ipv":4,"ak.proto":"http/1.1","ak.rid":"9f84484","ak.r":40747,"ak.a2":n,"ak.m":"","ak.n":"essl","ak.bpcip":"8.222.208.0","ak.cport":41366,"ak.gh":"23.50.232.247","ak.quicv":"","ak.tlsv":"tls1.2","ak.0rtt":"","ak.0rtt.ed":"","ak.csrc":"-","ak.acc":"reno","ak.t":"1732334966","ak.ak":"hOBiQwZUYzCg5VSAfCLimQ==oEJAfSxdERzO7uampAVtW/m3U4GQUp20cw9AIV95C3A+WLg+Z7P5CDGr23+GAK8pbI577kV/+/R6FJUwHaop7XIkN4Iz38G7nuCIJmU6NGghugg7VEsfckt//xy8TvZ/f9z8ghaY/UBwmEUyTJYkXkMsshUrh1ResggGxOdDZtWk/HWG/cmTOfBFYGBnj1rSeWAdCKIPwPnws6Ov5avmtF/Y6QgsuhhOZq9pVBwqMFR47RrU0lYGDWUQKSMYueEUdGNHLt3G07uNU8/IdRzaCibiTxau5BirbA1ONKgrh8nhtjSqKcs/WGlBI/9EbhqqcuWYNWs/+V9YATdlOsk/VWFqBFMJSmWl6Pm2z1ZTqn5OYFFbQ73QawF+tZNncdHn7fwyRkJXqvRXo3Fz78tWG6byP+HfmVUKmjT/aj9d6ec=","ak.pv":"55","ak.dpoabenc":"","ak.tf":i};if(""!==t)o["ak.ruds"]=t;var r={i:!1,av:function(n){var t="http.initiator";if(n&&(!n[t]||"spa_hard"===n[t]))o["ak.feo"]=void 0!==e.aFeoApplied?1:0,BOOMR.addVar(o)},rv:function(){var e=["ak.bpcip","ak.cport","ak.cr","ak.csrc","ak.gh","ak.ipv","ak.m","ak.n","ak.ol","ak.proto","ak.quicv","ak.tlsv","ak.0rtt","ak.0rtt.ed","ak.r","ak.acc","ak.t","ak.tf"];BOOMR.removeVar(e)}};BOOMR.plugins.AK={akVars:o,akDNSPreFetchDomain:a,init:function(){if(!r.i){var e=BOOMR.subscribe;e("before_beacon",r.av,null,null),e("onbeacon",r.rv,null,null),r.i=!0}return this},is_complete:function(){return!0}}}}()}(window);</script></head><body><div id="__next"><style data-emotion-css="cvn8wj">.css-cvn8wj{font-family:Colfax,colfax-web,Proxima Nova,Open Sans,Gill Sans MT, Gill Sans,Corbel,Arial,sans-serif;background-color:#4a4a55;height:60px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;position:fixed;top:0;width:100%;z-index:99;}@media (min-width:768px){.css-cvn8wj{height:60px;}}</style><div class="css-cvn8wj"><style data-emotion-css="y9662z">.css-y9662z{background:#4a4a55;width:100%;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;}</style><div class="css-y9662z"><style data-emotion-css="qqcdow">.css-qqcdow{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;font-size:15px;margin:0 20px;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;height:60px;}.css-qqcdow > a > svg{margin:0;display:block;height:24px;}</style><nav class="css-qqcdow"><style data-emotion-css="c2yzgf">.css-c2yzgf{color:white;-webkit-text-decoration:none;text-decoration:none;font-weight:500;white-space:nowrap;margin-left:8px;}.css-c2yzgf:hover{-webkit-text-decoration:none;text-decoration:none;color:white;}</style><a href="https://text.com/" class="css-c2yzgf"><style data-emotion-css="ofqsza">.css-ofqsza{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;justify-items:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;gap:0.8em;height:40px;}.css-ofqsza .logo{margin:0;font-size:2em;font-weight:500;-webkit-letter-spacing:-0.01em;-moz-letter-spacing:-0.01em;-ms-letter-spacing:-0.01em;letter-spacing:-0.01em;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}.css-ofqsza .adjacent{margin:0;font-size:1.8em;font-weight:500;line-height:34px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-letter-spacing:-0.5px;-moz-letter-spacing:-0.5px;-ms-letter-spacing:-0.5px;letter-spacing:-0.5px;}.css-ofqsza .carrier{font-weight:500;-webkit-animation-name:blink;animation-name:blink;-webkit-animation-duration:0.9s;animation-duration:0.9s;-webkit-animation-iteration-count:infinite;animation-iteration-count:infinite;}</style><header class="css-ofqsza"><span class="logo">text<span class="carrier">|</span></span></header></a><a href="/docs" class="css-c2yzgf">Platform Docs</a></nav><style data-emotion-css="16b59id">.css-16b59id{margin:0;padding:0;max-width:calc(100% - 60px);width:calc(100% - 60px);overflow-x:auto;overflow-y:hidden;display:none;margin-right:10px;margin-left:40px;}@media (min-width:1024px){.css-16b59id{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;gap:32px;}}</style><div class="css-16b59id"><style data-emotion-css="11hjr56">.css-11hjr56{font-family:Colfax,colfax-web,Proxima Nova,Open Sans,Gill Sans MT, Gill Sans,Corbel,Arial,sans-serif;position:relative;display:inline-block;height:100%;color:#ffffff;font-weight:400;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}.css-11hjr56:hover{cursor:default;}</style><div class="css-11hjr56">Platform<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div><div class="css-11hjr56">APIs & SDKs<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div><div class="css-11hjr56">Resources<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div></div><style data-emotion-css="1hppjzv">.css-1hppjzv{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}</style><div class="css-1hppjzv"><style data-emotion-css="7wgbw1">.css-7wgbw1{display:none;}@media (min-width:1024px){.css-7wgbw1{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;width:192px;margin-right:16px;}}</style><div class="DocSearch-Button-Desktop css-7wgbw1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div><style data-emotion-css="1i8rrts">.css-1i8rrts{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;height:100%;}@media (min-width:1024px){.css-1i8rrts{display:none;}}</style><div class="DocSearch-Button-Mobile css-1i8rrts"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div><p>...</p><style data-emotion-css="pskeb7">@media (min-width:1024px){.css-pskeb7{display:none;}}</style><style data-emotion-css="19rp0xe">.css-19rp0xe{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;margin-right:16px;cursor:pointer;}@media (min-width:1024px){.css-19rp0xe{display:none;}}@media (min-width:1024px){.css-19rp0xe{display:none;}}</style><svg width="32px" height="28px" fill="#ffffff" class="rmi rmi-menu css-19rp0xe" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"></path></svg></div></div></div><style data-emotion-css="ov1ktg">.css-ov1ktg{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;}</style><div class="css-ov1ktg"><style data-emotion-css="hpx2k5">.css-hpx2k5{border-right:1px solid #e2e2e4;height:50px;position:fixed;-webkit-transition:height 300ms;transition:height 300ms;display:block;bottom:0%;width:100%;opacity:1;z-index:10;box-shadow:0px 0px 8px rgba(0,0,0,0.25);background-color:white;}@media (min-width:768px){.css-hpx2k5{box-shadow:none;height:100vh;max-height:100vh;position:-webkit-sticky;position:sticky;top:60px;-webkit-transition:all 0s;transition:all 0s;width:260px;}}</style><aside class="css-hpx2k5"><style data-emotion-css="y8dejn">.css-y8dejn{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;background-color:white;padding:10px 14px;cursor:pointer;}@media (min-width:768px){.css-y8dejn{display:none;}}</style><div class="css-y8dejn"><svg style="transform:rotate(270deg);transition:transform 300ms" xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24"><path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z" fill="currentColor"></path><path d="M0 0h24v24H0z" fill="none"></path></svg>Partner Program API</div><style data-emotion-css="v8mm6">.css-v8mm6{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}@media (min-width:768px){.css-v8mm6{display:none;}}</style><div class="css-v8mm6"><style data-emotion-css="1pjh3pd">.css-1pjh3pd{width:100%;color:#62626D;}.css-1pjh3pd:hover{cursor:pointer;-webkit-text-decoration:none;text-decoration:none;background-color:#f6f6f7;}</style><a class="css-1pjh3pd"><style data-emotion-css="1yw2pv4">.css-1yw2pv4{padding:4px 14px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;font-size:16px;}</style><div class="css-1yw2pv4"><style data-emotion-css="5c7uuc">.css-5c7uuc{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:start;-webkit-justify-content:start;-ms-flex-pack:start;justify-content:start;}</style><div class="css-5c7uuc"><svg width="24" height="20px" fill="#62626D" class="rmi rmi-home undefined" viewBox="0 0 24 24"><path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8h5z"></path></svg></div>Home</div></a></div><style data-emotion-css="1ln71vl">.css-1ln71vl{overflow:scroll;height:calc(100% - 90px);}@media (min-width:768px){.css-1ln71vl{height:calc(100% - 60px);position:fixed;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;height:100%;max-height:100vh;position:-webkit-sticky;position:-webkit-sticky;position:sticky;top:0;margin-top:8px;}}</style><div class="css-1ln71vl"><style data-emotion-css="1psvkz3">.css-1psvkz3{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;margin-right:10px;font-weight:500;font-size:16px;border-radius:0px 8px 8px 0px;}.css-1psvkz3:hover{background-color:#f6f6f7;}</style><div class="css-1psvkz3"><style data-emotion-css="19nl305">.css-19nl305{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;color:#62626D;width:100%;}.css-19nl305:hover{color:#4284F5;cursor:pointer;-webkit-text-decoration:none;text-decoration:none;}</style><a class="css-19nl305"><style data-emotion-css="2hhlpj">.css-2hhlpj{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:6px 16px 6px 20px;margin-right:10px;font-weight:500;font-size:16px;border-radius:0px 8px 8px 0px;width:100%;}.css-2hhlpj:hover{background-color:#f6f6f7;}</style><div class="css-2hhlpj"><style data-emotion-css="oe3dsw">.css-oe3dsw{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;margin-right:8px;}</style><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Monetization Overview</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>How to monetize apps</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>App Review process</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Text Billing API</div></a></div><style data-emotion-css="1gg9bms">.css-1gg9bms{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;margin-right:10px;font-weight:600;font-size:16px;border-radius:0px 8px 8px 0px;}.css-1gg9bms:hover{background-color:#f6f6f7;}</style><div class="css-1gg9bms"><style data-emotion-css="17iyluq">.css-17iyluq{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;color:#4284F5;width:100%;}.css-17iyluq:hover{color:#4284F5;cursor:pointer;-webkit-text-decoration:none;text-decoration:none;}</style><a class="css-17iyluq"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Partner Program API</div></a></div></div></aside><style data-emotion-css="1g06r20">.css-1g06r20{padding-bottom:30vh;position:relative;width:100%;}@media (min-width:768px){.css-1g06r20{width:calc(100% - 258px);max-width:900px;}}</style><div class="css-1g06r20"><style data-emotion-css="c8i9h7">.css-c8i9h7{margin-top:120px;padding:0px 30px;}@media (min-width:768px){.css-c8i9h7{padding:0px 60px;}}.css-c8i9h7.redoc{margin-top:60px;display:block;}</style><article class=" css-c8i9h7"><style data-emotion-css="1lyzzun">.css-1lyzzun{margin:3em 0 1em;padding:2em 0 1em;}</style><div class="css-1lyzzun"><style data-emotion-css="12qxxrf">.css-12qxxrf{margin:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;font-weight:500;text-rendering:optimizeLegibility;font-size:2.25rem;line-height:1.1;-webkit-letter-spacing:-0.02em;-moz-letter-spacing:-0.02em;-ms-letter-spacing:-0.02em;letter-spacing:-0.02em;}@media (min-width:768px){.css-12qxxrf{-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;}}</style><h2 id="partner-program-api" class="css-12qxxrf"><span>Partner Program API</span><style data-emotion-css="1g0dr3m">.css-1g0dr3m{margin-top:8px;}.css-1g0dr3m > label{margin:0 0 5px 0;}.css-1g0dr3m label + div{-webkit-box-pack:end;-webkit-justify-content:flex-end;-ms-flex-pack:end;justify-content:flex-end;}</style></h2></div><style data-emotion-css="1679d3t">.css-1679d3t{border-bottom:1px solid #e0e4e9;padding-bottom:0.5em;}</style><h2 class="heading css-1679d3t"><style data-emotion-css="180507a">.css-180507a{color:inherit;-webkit-text-decoration:none;text-decoration:none;position:relative;}.css-180507a:hover{color:inherit;-webkit-text-decoration:none;text-decoration:none;}.css-180507a:hover:before{content:"#";position:absolute;font-weight:300;left:-1em;top:1px;opacity:0.3;}.css-180507a:focus-visible{outline-width:0px;}</style><a id="introduction" href="#introduction" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#introduction"><span class="icon icon-link"></span></a>Introduction</a></h2><p>LiveChat Partner Program API allows you to build tools that will help you make a better use of your data. The API is 100% open, so it鈥檚 up to you what you create.</p><style data-emotion-css="v24v0q">.css-v24v0q{max-width:830px;}</style><section class="css-v24v0q"><style data-emotion-css="11ycufd">.css-11ycufd{-webkit-box-flex:2;-webkit-flex-grow:2;-ms-flex-positive:2;flex-grow:2;max-width:100%;overflow-x:auto;}</style><div class="css-11ycufd"><h3 class="heading"><a id="api-url" href="#api-url" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#api-url"><span class="icon icon-link"></span></a>API URL</a></h3><p><code>https://api.livechatinc.com</code></p></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="status" href="#status" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#status"><span class="icon icon-link"></span></a>Status</a></h3><p><code>GET /v2/partners/status</code> - check if the API is running</p><h5 class="heading"><a id="response" href="#response" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - the API is up and running</li><li>everything else - the API has some issues</li></ul></div><style data-emotion-css="17buymi">.css-17buymi{width:100%;}@media (min-width:768px){.css-17buymi{padding:25px 25px 30px 0px;}}</style><div class="css-17buymi"><style data-emotion-css="16prjg8">.css-16prjg8{border:1px solid #e8e8e8;border-radius:6px;background-color:#505671;color:white;margin:0 0 20px;max-width:100%;--code-color:#f5fbff;--code-background:#505671;--code-string-color:#56d4bc;}</style><div class="css-16prjg8"><style data-emotion-css="13hnul0">.css-13hnul0{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:5px 15px;background-color:#383f54;border-radius:8px 8px 0 0;color:#dee5e8;}.css-13hnul0 code{font-size:12px;max-width:100%;-webkit-box-flex:2;-webkit-flex-grow:2;-ms-flex-positive:2;flex-grow:2;word-break:break-all;}.css-13hnul0 .code-sample-header{border:none;background-color:#383f54;color:#dee5e8;padding:0.2em 0;}</style><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><style data-emotion-css="1sg2lsz">.css-1sg2lsz{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}</style><div class="css-1sg2lsz"><style data-emotion-css="1wp1vo7">.css-1wp1vo7{position:relative;-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;width:45px;}</style><div class="css-1wp1vo7"><style data-emotion-css="xnt8k0">.css-xnt8k0{position:relative;min-height:18px;}</style><div class="css-xnt8k0"><style data-emotion-css="6oazep">.css-6oazep{position:absolute;top:0;left:0;right:0;text-align:right;text-transform:capitalize;line-height:20px;font-size:13px;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;opacity:0;-webkit-transition-delay:0.25s;transition-delay:0.25s;-webkit-transition:none;transition:none;}</style><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><style data-emotion-css="139ndot">.css-139ndot{position:absolute;top:0;right:0;text-align:right;max-width:24px;opacity:1;-webkit-transition-delay:0.25;transition-delay:0.25;-webkit-transition:opacity 0.25s ease-in-out;transition:opacity 0.25s ease-in-out;}.css-139ndot:hover{cursor:pointer;}</style><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><style data-emotion-css="ju12u0">.css-ju12u0{min-height:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;max-width:100%;overflow:scroll;}.css-ju12u0 code{display:inline-block;}</style><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -I https://api.livechatinc.com/v2/partners/status </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="authorization" href="#authorization" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#authorization"><span class="icon icon-link"></span></a>Authorization</a></h3><p>Each API request requires an authorization header to identify the Partner. Authorization is provided by a unique API token.</p><p>You can create your token in the <a href="https://partners.livechat.com/dashboard/account/tokens">API tokens section</a> in Dashboard.</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="postman-collection" href="#postman-collection" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#postman-collection"><span class="icon icon-link"></span></a>Postman Collection</a></h3><p>You can find all the requests from the Partner Program API in Postman. In our collection, we use <a href="https://learning.getpostman.com/docs/postman/environments_and_globals/manage_environments/">environment variables</a> for the API token - remember to replace it with your own.</p><p><a href="https://god.gw.postman.com/run-collection/8504794-0813ae6c-17ba-4b58-9aca-5b6679c356da?action=collection%2Ffork&collection-url=entityId%3D8504794-0813ae6c-17ba-4b58-9aca-5b6679c356da%26entityType%3Dcollection%26workspaceId%3D5e6fb31b-587b-4258-b215-4dccaae38a38#?env%5BLiveChat%20APIs%5D=W3sia2V5IjoiZGF0ZV9mcm9tIiwidmFsdWUiOiIyMDEzLTAxLTI5IiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiMjAxMy0wMS0yOSIsInNlc3Npb25JbmRleCI6MH0seyJrZXkiOiJkYXRlX3RvIiwidmFsdWUiOiIyMDEzLTAxLTI5IiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiMjAxMy0wMS0yOSIsInNlc3Npb25JbmRleCI6MX0seyJrZXkiOiJhZ2VudCIsInZhbHVlIjoiam9obi5kb2VAbXljb21wYW55LmNvbSIsImVuYWJsZWQiOnRydWUsInNlc3Npb25WYWx1ZSI6ImpvaG4uZG9lQG15Y29tcGFueS5jb20iLCJzZXNzaW9uSW5kZXgiOjJ9LHsia2V5IjoiZ3JvdXBfYnkiLCJ2YWx1ZSI6ImhvdXIiLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJob3VyIiwic2Vzc2lvbkluZGV4IjozfSx7ImtleSI6Imdyb3VwIiwidmFsdWUiOiIyIiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiMiIsInNlc3Npb25JbmRleCI6NH0seyJrZXkiOiJ3ZWVrZGF5IiwidmFsdWUiOiJtb24iLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJtb24iLCJzZXNzaW9uSW5kZXgiOjV9LHsia2V5IjoiYXBpX3ZlcnNpb24iLCJ2YWx1ZSI6InYzLjQiLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJ2My40Iiwic2Vzc2lvbkluZGV4Ijo2fSx7ImtleSI6ImFjY2Vzc190b2tlbiIsInZhbHVlIjoiZGFsOnRlc3RfLUF2WlNTT0RLa1pzcmpvUGtRIiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiZGFsOnRlc3RfLUF2WlNTT0RLa1pzcmpvUGtRIiwic2Vzc2lvbkluZGV4Ijo3fSx7ImtleSI6ImN1c3RvbWVyX2FjY2Vzc190b2tlbiIsInZhbHVlIjoiZGFsOnRlc3RfcHE3UVllVlpMRkV6RE5CVGciLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJkYWw6dGVzdF9wcTdRWWVWWkxGRXpETkJUZyIsInNlc3Npb25JbmRleCI6OH0seyJrZXkiOiJhY2NvdW50X2lkIiwidmFsdWUiOiJiN2VmZjc5OC1mOGRmLTQzNjQtODA1OS02NDljMzVjOWVkMGMiLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJiN2VmZjc5OC1mOGRmLTQzNjQtODA1OS02NDljMzVjOWVkMGMiLCJzZXNzaW9uSW5kZXgiOjl9LHsia2V5IjoibGljZW5zZV9pZCIsInZhbHVlIjoiMTA0MTMwNjIzIiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiMTA0MTMwNjIzIiwic2Vzc2lvbkluZGV4IjoxMH0seyJrZXkiOiJwYXJ0bmVyX2FwaV91cmwiLCJ2YWx1ZSI6Imh0dHBzOi8vYXBpLmxpdmVjaGF0aW5jLmNvbS92Mi9wYXJ0bmVycyIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9hcGkubGl2ZWNoYXRpbmMuY29tL3YyL3BhcnRuZXJzIiwic2Vzc2lvbkluZGV4IjoxMX0seyJrZXkiOiJwYXJ0bmVyX2FjY2Vzc190b2tlbiIsInZhbHVlIjoiZGFsOnRlc3Rfb3VoZWZnMzQ4N3dlcnRxM0pFQiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiZGFsOnRlc3Rfb3VoZWZnMzQ4N3dlcnRxM0pFQiIsInNlc3Npb25JbmRleCI6MTJ9LHsia2V5Ijoib3JnYW5pemF0aW9uX2lkIiwidmFsdWUiOiJiN2VmZjc5OC1mOGxqLTQzNjQtODA1OS02NDljMzVjOWVkMGMiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6ImI3ZWZmNzk4LWY4bGotNDM2NC04MDU5LTY0OWMzNWM5ZWQwYyIsInNlc3Npb25JbmRleCI6MTN9XQ=="><div style="max-width:123px"><style data-emotion-css="v3memn">.css-v3memn{display:block;max-width:100%;overflow:hidden;position:relative;box-sizing:border-box;margin-top:0;margin-left:0;margin-right:0;margin-bottom:10px;}</style><div class="css-v3memn"><style data-emotion-css="sa8835">.css-sa8835{box-sizing:border-box;display:block;max-width:100%;padding-top:calc(30 / 123 * 100%);}</style><div class="css-sa8835"><style data-emotion-css="5r33xa">.css-5r33xa{position:absolute;top:0;left:0;bottom:0;right:0;box-sizing:border-box;padding:0;border:none;margin:auto;display:block;width:0;height:0;min-width:100%;max-width:100%;min-height:100%;max-height:100%;}</style><img alt="Run in Postman" src="https://run.pstmn.io/button.svg" decoding="async" class="css-5r33xa"/></div></div></div></a></p></div></section><h2 class="heading css-1679d3t"><a id="account" href="#account" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#account"><span class="icon icon-link"></span></a>Account</a></h2><ul><li><a href="/docs/monetization/partner-program-api#get-profile">Get Profile</a></li><li><a href="/docs/monetization/partner-program-api#update-profile">Update Profile</a></li><li><a href="/docs/monetization/partner-program-api#get-stats">Get Stats</a></li><li><a href="/docs/monetization/partner-program-api#get-coupons">Get Coupons</a></li><li><a href="/docs/monetization/partner-program-api#get-earnings">Get Earnings</a></li><li><a href="/docs/monetization/partner-program-api#get-commission-report">Get Commission Report</a></li><li><a href="/docs/monetization/partner-program-api#get-partners-referred-earnings-report">Get Partners Referred Earnings Report</a></li><li><a href="/docs/monetization/partner-program-api#get-billing">Get Billing</a></li><li><a href="/docs/monetization/partner-program-api#get-balance">Get Balance</a></li><li><a href="/docs/monetization/partner-program-api#get-commission-metric">Get Commission Metric</a></li><li><a href="/docs/monetization/partner-program-api#update-billing">Update Billing</a></li><li><a href="/docs/monetization/partner-program-api#request-withdrawal">Request Withdrawal</a></li><li><a href="/docs/monetization/partner-program-api#get-withdrawals">Get Withdrawals</a></li><li><a href="/docs/monetization/partner-program-api#create-api-token">Create API Token</a></li><li><a href="/docs/monetization/partner-program-api#get-api-tokens">Get API Tokens</a></li><li><a href="/docs/monetization/partner-program-api#revoke-api-token">Revoke API Token</a></li></ul><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-profile" href="#get-profile" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-profile"><span class="icon icon-link"></span></a>Get Profile</a></h3><p><code>GET /v2/partners</code> - get the profile info</p><h5 class="heading"><a id="headers" href="#headers" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-1" href="#response-1" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-1"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><style data-emotion-css="1vuwrgc">.css-1vuwrgc{border:1px solid #e8e8e8;border-radius:6px;background-color:#f1f6f8;min-height:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;margin:0 0 20px;max-width:100%;}.css-1vuwrgc .remark-highlight{min-height:0;}.css-1vuwrgc pre{min-height:0;}</style><div class="css-1vuwrgc"><style data-emotion-css="iwgofq">.css-iwgofq{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:5px 15px;height:42px;background-color:#dee5e8;border-radius:5px 5px 0 0;font-size:13px;text-transform:uppercase;-webkit-letter-spacing:0.04em;-moz-letter-spacing:0.04em;-ms-letter-spacing:0.04em;letter-spacing:0.04em;}</style><div class="css-iwgofq"><style data-emotion-css="w6gvpm">.css-w6gvpm{-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;}</style><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"partner_id"</span><span class="token operator">:</span> <span class="token string">"xyz"</span><span class="token punctuation">,</span> <span class="token property">"login"</span><span class="token operator">:</span> <span class="token string">"joe@email.com"</span><span class="token punctuation">,</span> <span class="token property">"first_name"</span><span class="token operator">:</span> <span class="token string">"Joe"</span><span class="token punctuation">,</span> <span class="token property">"last_name"</span><span class="token operator">:</span> <span class="token string">"Doe"</span><span class="token punctuation">,</span> <span class="token property">"contact_name"</span><span class="token operator">:</span> <span class="token string">"Jane Doe"</span><span class="token punctuation">,</span> <span class="token property">"contact_email"</span><span class="token operator">:</span> <span class="token string">"jane@email.com"</span><span class="token punctuation">,</span> <span class="token property">"solution_status"</span><span class="token operator">:</span> <span class="token string">"accepted"</span><span class="token punctuation">,</span> <span class="token property">"properties"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"sales_kit_popup_closed"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"pitch_deck_downloaded"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"tier2_popup_closed"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"payment_origin_popup_closed"</span><span class="token operator">:</span> <span class="token boolean">true</span> <span class="token comment">// and more properties (used for showing popups in Partners App)</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="update-profile" href="#update-profile" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#update-profile"><span class="icon icon-link"></span></a>Update Profile</a></h3><p><code>PUT /v2/partners</code> - update the profile info</p><h5 class="heading"><a id="headers-1" href="#headers-1" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-1"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="body" href="#body" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>first_name</code> - <strong>required</strong> - first name</li><li><code>last_name</code> - <strong>required</strong> - last name</li><li><code>contact_name</code> - <strong>required</strong> - contact name</li><li><code>contact_email</code> - <strong>required</strong> - contact email</li><li><code>send_monthly_summary</code> - <code>boolean</code> value</li><li><code>send_reseller_weekly_summary</code> - <code>boolean</code> value</li><li><code>send_newsletter</code> - <code>boolean</code> value</li><li><code>send_notifications</code> - <code>boolean</code> value</li></ul><h5 class="heading"><a id="response-2" href="#response-2" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-2"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>204 - No Content</code> - success</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-stats" href="#get-stats" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-stats"><span class="icon icon-link"></span></a>Get Stats</a></h3><p><code>GET /v2/partners/stats</code> - get the number of licenses for each product and partnership model</p><h5 class="heading"><a id="headers-2" href="#headers-2" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-2"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-3" href="#response-3" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-3"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/stats <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"affiliate"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"livechat"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token number">120</span><span class="token punctuation">,</span> <span class="token property">"trials_cc"</span><span class="token operator">:</span> <span class="token number">38</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">41</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"chatbot"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token number">96</span><span class="token punctuation">,</span> <span class="token property">"trials_cc"</span><span class="token operator">:</span> <span class="token number">52</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">34</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"helpdesk"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token number">21</span><span class="token punctuation">,</span> <span class="token property">"trials_cc"</span><span class="token operator">:</span> <span class="token number">37</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">47</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"partner_program"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"partners_referred"</span><span class="token operator">:</span> <span class="token number">63</span><span class="token punctuation">,</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token number">42</span><span class="token punctuation">,</span> <span class="token property">"trials_cc"</span><span class="token operator">:</span> <span class="token number">24</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">37</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"solution"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"livechat"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token number">12</span><span class="token punctuation">,</span> <span class="token property">"trials_cc"</span><span class="token operator">:</span> <span class="token number">7</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">28</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"chatbot"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token number">51</span><span class="token punctuation">,</span> <span class="token property">"trials_cc"</span><span class="token operator">:</span> <span class="token number">21</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">19</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"helpdesk"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token number">21</span><span class="token punctuation">,</span> <span class="token property">"trials_cc"</span><span class="token operator">:</span> <span class="token number">37</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">47</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-coupons" href="#get-coupons" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-coupons"><span class="icon icon-link"></span></a>Get Coupons</a></h3><p><code>GET /v2/partners/coupons</code> - get the list of active coupons</p><h5 class="heading"><a id="headers-3" href="#headers-3" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-3"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-4" href="#response-4" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-4"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/coupons <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"label"</span><span class="token operator">:</span> <span class="token string">"30% off first payment"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">2</span><span class="token punctuation">,</span> <span class="token property">"label"</span><span class="token operator">:</span> <span class="token string">"$25 discount"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-earnings" href="#get-earnings" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-earnings"><span class="icon icon-link"></span></a>Get Earnings</a></h3><p><code>GET /v2/partners/earnings</code> - get earnings (commission earned, balance, blocked and pending amount, and more)</p><h5 class="heading"><a id="headers-4" href="#headers-4" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-4"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-5" href="#response-5" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-5"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/earnings <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"balance"</span><span class="token operator">:</span> <span class="token number">2552</span><span class="token punctuation">,</span> <span class="token property">"blocked"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"commission_total"</span><span class="token operator">:</span> <span class="token number">16519.12</span><span class="token punctuation">,</span> <span class="token property">"commission_last_30_days"</span><span class="token operator">:</span> <span class="token number">61.34</span><span class="token punctuation">,</span> <span class="token property">"withdrawals"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"pending"</span><span class="token operator">:</span> <span class="token number">13546</span><span class="token punctuation">,</span> <span class="token property">"affiliate"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"commission_total"</span><span class="token operator">:</span> <span class="token number">16098</span><span class="token punctuation">,</span> <span class="token property">"commission_last_30_days"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"livechat"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"commission_total"</span><span class="token operator">:</span> <span class="token number">15942</span><span class="token punctuation">,</span> <span class="token property">"commission_last_30_days"</span><span class="token operator">:</span> <span class="token number">0</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"chatbot"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"commission_total"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"commission_last_30_days"</span><span class="token operator">:</span> <span class="token number">0</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"partner_program"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"commission_total"</span><span class="token operator">:</span> <span class="token number">156</span><span class="token punctuation">,</span> <span class="token property">"commission_last_30_days"</span><span class="token operator">:</span> <span class="token number">0</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"solution"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"commission_total"</span><span class="token operator">:</span> <span class="token number">421.12</span><span class="token punctuation">,</span> <span class="token property">"commission_last_30_days"</span><span class="token operator">:</span> <span class="token number">61.34</span><span class="token punctuation">,</span> <span class="token property">"livechat"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"discount"</span><span class="token operator">:</span> <span class="token number">45943.76</span><span class="token punctuation">,</span> <span class="token property">"commission_total"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"commission_last_30_days"</span><span class="token operator">:</span> <span class="token number">0</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"chatbot"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"discount"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"commission_total"</span><span class="token operator">:</span> <span class="token number">421.12</span><span class="token punctuation">,</span> <span class="token property">"commission_last_30_days"</span><span class="token operator">:</span> <span class="token number">61.34</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-commission-report" href="#get-commission-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-commission-report"><span class="icon icon-link"></span></a>Get Commission Report</a></h3><p><code>GET /v2/partners/reports/commission</code> - get commission reports</p><h5 class="heading"><a id="headers-5" href="#headers-5" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-5"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters" href="#query-parameters" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - <strong>required</strong> - get report from a given date</li><li><code>date_to</code> - <strong>required</strong> - get report up to a given date</li><li><code>filters</code> - filters</li><li><code>aggregation</code> - <strong>required</strong> - get report aggregated by a given timespan (one of: <code>day</code>, <code>week</code>, <code>month</code>)</li></ul><p><strong>Note:</strong></p><ul><li>Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></li><li><code>filters</code> is an array of objects, where each object has the following fields:<ul><li><code>field</code> - field name (one of: <code>program</code>, <code>product</code>)</li><li><code>value</code> - field value</li><li><code>operator</code> - operator (<code>equals</code>)</li></ul></li><li>for example: <code>filters=[{"field": "prod", "value": "livechat", "operator": "equals"}]</code></li></ul><h5 class="heading"><a id="response-6" href="#response-6" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-6"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/reports/commission?date_from<span class="token operator">=</span><span class="token number">2022</span>-12-15T00:00:00Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2023</span>-02-14T23:59:59Z<span class="token operator">&</span><span class="token assign-left variable">aggregation</span><span class="token operator">=</span>month<span class="token operator">&</span><span class="token assign-left variable">filters</span><span class="token operator">=</span><span class="token punctuation">[</span><span class="token punctuation">{</span><span class="token string">"field"</span><span class="token builtin class-name">:</span><span class="token string">"product"</span>,<span class="token string">"value"</span><span class="token builtin class-name">:</span><span class="token string">"livechat"</span>,<span class="token string">"operator"</span><span class="token builtin class-name">:</span><span class="token string">"equals"</span><span class="token punctuation">}</span><span class="token punctuation">]</span> <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2022-12-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2022-12-31 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">6326.39</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-01-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-01-31 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">4949.1</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-02-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-02-28 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">7824.5</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-partners-referred-earnings-report" href="#get-partners-referred-earnings-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-partners-referred-earnings-report"><span class="icon icon-link"></span></a>Get Partners Referred Earnings Report</a></h3><p><code>GET /v2/partners/partners-referred/reports/commission</code> - get commission earned from referring partners</p><h5 class="heading"><a id="headers-6" href="#headers-6" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-6"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-1" href="#query-parameters-1" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-1"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - <strong>required</strong> - get report from a given date</li><li><code>date_to</code> - <strong>required</strong> - get report up to a given date</li><li><code>aggregation</code> - <strong>required</strong> - get report aggregated by a given timespan (one of: <code>day</code>, <code>week</code>, <code>month</code>)</li><li><code>product</code> - get report for a given product (one of: <code>livechat</code>, <code>chatbot</code>, <code>helpdesk</code>, <code>all</code>; default: <code>all</code>)</li><li><code>program</code> - get report for a given program (one of: <code>affiliate</code>, <code>solution</code>, <code>all</code>; default: <code>all</code>)</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-7" href="#response-7" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-7"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example below</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/partners-referred/reports/commission?aggregation<span class="token operator">=</span>month<span class="token operator">&</span><span class="token assign-left variable">date_from</span><span class="token operator">=</span><span class="token number">2022</span>-03-25T00:00:00Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-05-04T00:00:00Z <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2022-03-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2022-03-31 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">885.58</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2022-04-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2022-04-30 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">347.94</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2022-05-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2022-05-31 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">1413.69</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-billing" href="#get-billing" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-billing"><span class="icon icon-link"></span></a>Get Billing</a></h3><p><code>GET /v2/partners/billing</code> - get billing information</p><h5 class="heading"><a id="headers-7" href="#headers-7" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-7"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-8" href="#response-8" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-8"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/billing <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"company"</span><span class="token operator">:</span> <span class="token string">"Awesome Company"</span><span class="token punctuation">,</span> <span class="token property">"vat"</span><span class="token operator">:</span> <span class="token string">"123"</span><span class="token punctuation">,</span> <span class="token property">"address"</span><span class="token operator">:</span> <span class="token string">"Wall Street 123"</span><span class="token punctuation">,</span> <span class="token property">"city"</span><span class="token operator">:</span> <span class="token string">"New York"</span><span class="token punctuation">,</span> <span class="token property">"zip_code"</span><span class="token operator">:</span> <span class="token string">"10005"</span><span class="token punctuation">,</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"US"</span><span class="token punctuation">,</span> <span class="token property">"paypal"</span><span class="token operator">:</span> <span class="token string">"paypal@email.com"</span><span class="token punctuation">,</span> <span class="token property">"type"</span><span class="token operator">:</span> <span class="token string">"business"</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-balance" href="#get-balance" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-balance"><span class="icon icon-link"></span></a>Get Balance</a></h3><p><code>GET /v2/partners/balance</code> - get balance information</p><h5 class="heading"><a id="headers-8" href="#headers-8" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-8"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-9" href="#response-9" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-9"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/balance <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"pending"</span><span class="token operator">:</span> <span class="token number">21.00</span><span class="token punctuation">,</span> <span class="token property">"withdrawn"</span><span class="token operator">:</span> <span class="token number">37.00</span><span class="token punctuation">,</span> <span class="token property">"available"</span><span class="token operator">:</span> <span class="token number">362.00</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token string">"420.00"</span><span class="token punctuation">,</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-commission-metric" href="#get-commission-metric" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-commission-metric"><span class="icon icon-link"></span></a>Get Commission Metric</a></h3><p><code>GET /v2/partners/metrics/commission</code> - get commission metric</p><h5 class="heading"><a id="headers-9" href="#headers-9" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-9"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-2" href="#query-parameters-2" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-2"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get commission metric from a given date</li><li><code>date_to</code> - get commission metric up to a given date</li><li><code>product</code> - get commission metric for a given product (one of: <code>livechat</code>, <code>chatbot</code>, <code>helpdesk</code>, <code>all</code>; default: <code>all</code>)</li><li><code>program</code> - get commission metric for a given program (one of: <code>solution</code>, <code>affiliate</code>, <code>all</code>; default: <code>all</code>)</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-10" href="#response-10" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-10"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/metrics/commission?date_from<span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">product</span><span class="token operator">=</span>livechat<span class="token operator">&</span><span class="token assign-left variable">program</span><span class="token operator">=</span>solution <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">1232.12</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="update-billing" href="#update-billing" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#update-billing"><span class="icon icon-link"></span></a>Update Billing</a></h3><p><code>PUT /v2/partners/billing</code> - update billing information</p><h5 class="heading"><a id="headers-10" href="#headers-10" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-10"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="body-1" href="#body-1" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-1"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>type</code> - <strong>required</strong> - <code>business</code> or <code>individual</code></li><li><code>company</code> - <strong>required</strong> - company name (if business) or full name (if individual)</li><li><code>address</code> - <strong>required</strong></li><li><code>city</code> - <strong>required</strong></li><li><code>country</code> - <strong>required</strong> - country code, one of <a href="https://api.livechatinc.com/v2/partners/data/countries">these</a></li><li><code>paypal</code> - <strong>required</strong> - PayPal login (email)</li><li><code>zip_code</code> - ZIP / Postal code</li><li><code>vat</code> - VAT</li><li><code>state</code> - State</li></ul><h5 class="heading"><a id="response-11" href="#response-11" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-11"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>204 - No Content</code> - success</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="request-withdrawal" href="#request-withdrawal" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#request-withdrawal"><span class="icon icon-link"></span></a>Request Withdrawal</a></h3><p><code>POST /v2/partners/withdrawals</code> - create a withdrawal request</p><h5 class="heading"><a id="headers-11" href="#headers-11" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-11"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-12" href="#response-12" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-12"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>201 - Created</code> - success, see example</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>403 - Forbidden</code> - not enough money to withdraw (min. \$50)</li><li><code>409 - Conflict</code> - billing info not found; please, <a href="/docs/monetization/partner-program-api#update-billing">update billing</a></li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/withdrawals <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"withdrawal_id"</span><span class="token operator">:</span> <span class="token number">2</span><span class="token punctuation">,</span> <span class="token property">"request_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-03-06 12:24:42"</span><span class="token punctuation">,</span> <span class="token property">"action_timestamp"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"pending"</span><span class="token punctuation">,</span> <span class="token property">"amount"</span><span class="token operator">:</span> <span class="token number">1520</span><span class="token punctuation">,</span> <span class="token property">"invoice_id"</span><span class="token operator">:</span> <span class="token string">"2018/2/xyz"</span><span class="token punctuation">,</span> <span class="token property">"paypal"</span><span class="token operator">:</span> <span class="token string">"joe@doe.com"</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-withdrawals" href="#get-withdrawals" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-withdrawals"><span class="icon icon-link"></span></a>Get Withdrawals</a></h3><p><code>GET /v2/partners/withdrawals</code> - get the list of withdrawals</p><h5 class="heading"><a id="headers-12" href="#headers-12" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-12"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-3" href="#query-parameters-3" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-3"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get a report on withdrawals starting from a given date</li><li><code>date_to</code> - get a report on withdrawals ending on a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DD</code></p><h5 class="heading"><a id="response-13" href="#response-13" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-13"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>400 - Bad Request</code> - incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/withdrawals <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"withdrawal_id"</span><span class="token operator">:</span> <span class="token number">2</span><span class="token punctuation">,</span> <span class="token property">"request_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-03-06 12:24:42"</span><span class="token punctuation">,</span> <span class="token property">"action_timestamp"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"pending"</span><span class="token punctuation">,</span> <span class="token property">"amount"</span><span class="token operator">:</span> <span class="token number">1520</span><span class="token punctuation">,</span> <span class="token property">"invoice_id"</span><span class="token operator">:</span> <span class="token string">"2018/2/xyz"</span><span class="token punctuation">,</span> <span class="token property">"paypal"</span><span class="token operator">:</span> <span class="token string">"joe@doe.com"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"withdrawal_id"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"request_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-02-02 11:43:37"</span><span class="token punctuation">,</span> <span class="token property">"action_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-02-02 12:04:11"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"paid"</span><span class="token punctuation">,</span> <span class="token property">"amount"</span><span class="token operator">:</span> <span class="token number">1063.3</span><span class="token punctuation">,</span> <span class="token property">"invoice_id"</span><span class="token operator">:</span> <span class="token string">"2018/1/xyz"</span><span class="token punctuation">,</span> <span class="token property">"paypal"</span><span class="token operator">:</span> <span class="token string">"joe@doe.com"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="create-api-token" href="#create-api-token" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#create-api-token"><span class="icon icon-link"></span></a>Create API Token</a></h3><p><code>POST /v2/partners/tokens</code> - create a new API token</p><h5 class="heading"><a id="headers-13" href="#headers-13" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-13"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="body-2" href="#body-2" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-2"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>label</code> - <strong>required</strong> - a custom label for the token (min. 3 characters)</li></ul><h5 class="heading"><a id="response-14" href="#response-14" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-14"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>201 - Created</code> - success, see example</li><li><code>400 - Bad Request</code> - incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>409 - Conflict</code> - the given label was already taken</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --data <span class="token string">'label=My first API token'</span> <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/tokens <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"token"</span><span class="token operator">:</span> <span class="token string">"secrettokengeneratedbyapi..."</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-03-06 15:14:26"</span><span class="token punctuation">,</span> <span class="token property">"label"</span><span class="token operator">:</span> <span class="token string">"My first API token"</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-api-tokens" href="#get-api-tokens" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-api-tokens"><span class="icon icon-link"></span></a>Get API Tokens</a></h3><p><code>GET /v2/partners/tokens</code> - get the list of active API tokens</p><h5 class="heading"><a id="headers-14" href="#headers-14" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-14"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-15" href="#response-15" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-15"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>400 - Bad Request</code> - incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/tokens <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">2</span><span class="token punctuation">,</span> <span class="token property">"token"</span><span class="token operator">:</span> <span class="token string">"anothersecrettokengeneratedbyapi..."</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-03-06 17:14:26"</span><span class="token punctuation">,</span> <span class="token property">"label"</span><span class="token operator">:</span> <span class="token string">"Token for my service"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"token"</span><span class="token operator">:</span> <span class="token string">"secrettokengeneratedbyapi..."</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-03-06 15:14:26"</span><span class="token punctuation">,</span> <span class="token property">"label"</span><span class="token operator">:</span> <span class="token string">"My first API token"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="revoke-api-token" href="#revoke-api-token" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#revoke-api-token"><span class="icon icon-link"></span></a>Revoke API Token</a></h3><p><code>DELETE /v2/partners/tokens/<id></code> - a revoke API token</p><h5 class="heading"><a id="headers-15" href="#headers-15" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-15"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters" href="#path-parameters" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><id></code> - <strong>required</strong> - token ID</li></ul><h5 class="heading"><a id="response-16" href="#response-16" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-16"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>204 - No Content</code> - success</li><li><code>400 - Bad Request</code> - incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request DELETE <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/tokens/1 <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div></div></section><h2 class="heading css-1679d3t"><a id="affiliate-partner" href="#affiliate-partner" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#affiliate-partner"><span class="icon icon-link"></span></a>Affiliate Partner</a></h2><ul><li><a href="/docs/monetization/partner-program-api#create-campaign">Create Campaign</a></li><li><a href="/docs/monetization/partner-program-api#search-campaigns">Search Campaigns</a></li><li><a href="/docs/monetization/partner-program-api#get-campaigns">Get Campaigns</a></li><li><a href="/docs/monetization/partner-program-api#disable-campaign">Disable Campaign</a></li><li><a href="/docs/monetization/partner-program-api#get-affiliate-licenses">Get Affiliate Licenses</a></li><li><a href="/docs/monetization/partner-program-api#get-performance-report">Get Performance Report</a></li><li><a href="/docs/monetization/partner-program-api#get-partners-referred">Get Partners Referred</a></li><li><a href="/docs/monetization/partner-program-api#get-affiliate-links">Get Affiliate Links</a></li><li><a href="/docs/monetization/partner-program-api#get-trials-metrics">Get Trials Metrics</a></li><li><a href="/docs/monetization/partner-program-api#get-earnings-metrics">Get Earnings Metrics</a></li><li><a href="/docs/monetization/partner-program-api#get-conversions-metrics">Get Conversions Metrics</a></li><li><a href="/docs/monetization/partner-program-api#get-clicks-metrics">Get Clicks Metrics</a></li><li><a href="/docs/monetization/partner-program-api#get-referred-partners-commission-metrics">Get Referred Partners Commission Metrics</a></li><li><a href="/docs/monetization/partner-program-api#get-trials-report">Get Trials Report</a></li><li><a href="/docs/monetization/partner-program-api#get-earnings-report">Get Earnings Report</a></li><li><a href="/docs/monetization/partner-program-api#get-conversions-report">Get Conversions Report</a></li><li><a href="/docs/monetization/partner-program-api#get-clicks-report">Get Clicks Report</a></li><li><a href="/docs/monetization/partner-program-api#get-licenses-by-status">Get Licenses By Status</a></li><li><a href="/docs/monetization/partner-program-api#get-campaigns-earnings-metric">Get Campaigns Earnings Metric</a></li><li><a href="/docs/monetization/partner-program-api#get-campaigns-earnings-report">Get Campaigns Earnings Report</a></li><li><a href="/docs/monetization/partner-program-api#get-campaigns-summary">Get Campaigns Summary</a></li><li><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-clicks-report">Get Best Performing Campaigns Clicks Report</a></li><li><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-trials-report">Get Best Performing Campaigns Trials Report</a></li><li><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-conversions-report">Get Best Performing Campaigns Conversions Report</a></li><li><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-earnings-report">Get Best Performing Campaigns Earnings Report</a></li><li><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-clicks-metrics">Get Best Performing Campaigns Clicks Metrics</a></li><li><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-trials-metrics">Get Best Performing Campaigns Trials Metrics</a></li><li><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-conversions-metrics">Get Best Performing Campaigns Conversions Metrics</a></li><li><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-earnings-metrics">Get Best Performing Campaigns Earnings Metrics</a></li><li><a href="/docs/monetization/partner-program-api#get-summary">Get Summary</a></li></ul><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="create-campaign" href="#create-campaign" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#create-campaign"><span class="icon icon-link"></span></a>Create Campaign</a></h3><p><code>POST /v2/partners/affiliates/campaigns</code> - create a new campaign</p><h5 class="heading"><a id="headers-16" href="#headers-16" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-16"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-4" href="#query-parameters-4" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-4"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>product</code> - <strong>required</strong> - product (<code>livechat</code>, <code>chatbot</code> or <code>partner_program</code> itself)</li></ul><h5 class="heading"><a id="body-3" href="#body-3" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-3"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>name</code> - <strong>required</strong> - campaign name (min. 5, max. 100 characters)</li><li><code>link</code> - the URL of the product landing page (default: product homepage)</li><li><code>trial_duration</code> - only for the <code>livechat</code> product - the number of days of a trial period (min. 14 - default, max. 30)</li><li><code>coupon_id</code> - only for the <code>livechat</code> product - the ID of the coupon assigned to a Partner (a discount will be applied)</li></ul><h5 class="heading"><a id="response-17" href="#response-17" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-17"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>201 - Created</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>403 - Forbidden</code> - not allowed to use the given <code>coupon_id</code></li><li><code>409 - Conflict</code> - campaign with the given name already exists</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns?product<span class="token operator">=</span>livechat <span class="token punctuation">\</span> --data <span class="token string">'name=New campaign&link=https://www.livechat.com/features/&trial_duration=30&coupon_id=1'</span> <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"livechat"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"New campaign"</span><span class="token punctuation">,</span> <span class="token property">"slug"</span><span class="token operator">:</span> <span class="token string">"pp_new-campaign"</span><span class="token punctuation">,</span> <span class="token property">"url"</span><span class="token operator">:</span> <span class="token string">"https://www.livechat.com/features/?a=xyz&utm_campaign=pp_new-campaign"</span><span class="token punctuation">,</span> <span class="token property">"short_url"</span><span class="token operator">:</span> <span class="token string">"https://lc.chat/abc"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-03-06 11:30:40"</span> <span class="token property">"trial_duration"</span><span class="token operator">:</span> <span class="token number">30</span><span class="token punctuation">,</span> <span class="token property">"discount"</span><span class="token operator">:</span> <span class="token string">"$25 discount"</span><span class="token punctuation">,</span> <span class="token punctuation">}</span> <span class="token comment">// Note - `slug` is a URL-friendly campaign name with `pp_` prefix</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="search-campaigns" href="#search-campaigns" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#search-campaigns"><span class="icon icon-link"></span></a>Search Campaigns</a></h3><p><code>GET /v2/partners/affiliates/campaigns/search</code> - search for campaigns</p><h5 class="heading"><a id="headers-17" href="#headers-17" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-17"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-5" href="#query-parameters-5" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-5"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>page</code> - pagination page number</li><li><code>state</code> - <strong>required</strong> - state (<code>active</code> or <code>archived</code>)</li><li><code>product</code> - product (one of: <code>livechat</code>, <code>chatbot</code>, <code>helpdesk</code>, <code>all</code>; default: <code>all</code>)</li><li><code>filters</code> - filters (see below)</li><li><code>sort_by</code> - sort by (one of: <code>creation_timestamp</code>)</li><li><code>sort_order</code> - sort order (one of: <code>desc</code>, <code>asc</code>) </li></ul><p><strong>Note:</strong></p><ul><li><code>filters</code> is an array of objects, where each object has the following fields:<ul><li><code>field</code> - field name (one of: <code>name</code>, <code>product</code>)</li><li><code>value</code> - field value</li><li><code>operator</code> - operator (one of: <code>equals</code>, <code>contains</code>)</li></ul></li><li>for example: <code>filters=[{"field": "name", "value": "campaign-name-123", "operator": "equals"}]</code></li></ul><h5 class="heading"><a id="response-18" href="#response-18" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-18"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/search?page<span class="token operator">=</span><span class="token number">1</span><span class="token operator">&</span><span class="token assign-left variable">product</span><span class="token operator">=</span>all<span class="token operator">&</span><span class="token assign-left variable">state</span><span class="token operator">=</span>active<span class="token operator">&</span><span class="token assign-left variable">filters</span><span class="token operator">=</span><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token operator">&&</span><span class="token assign-left variable">sort_order</span><span class="token operator">=</span>desc<span class="token operator">&</span><span class="token assign-left variable">sort_by</span><span class="token operator">=</span>creation_timestamp <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">123.00</span><span class="token punctuation">,</span> <span class="token property">"results"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">123</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"campaign-test-name"</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"chatbot"</span><span class="token punctuation">,</span> <span class="token property">"created_at"</span><span class="token operator">:</span> <span class="token string">"2023-01-01 11:22:59"</span><span class="token punctuation">,</span> <span class="token property">"landing_page_url"</span><span class="token operator">:</span> <span class="token string">"https://staging.chatbot.com/features"</span><span class="token punctuation">,</span> <span class="token property">"slug"</span><span class="token operator">:</span> <span class="token string">"pp-campaign-test-name"</span><span class="token punctuation">,</span> <span class="token property">"is_default"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"region"</span><span class="token operator">:</span> <span class="token string">"dal"</span><span class="token punctuation">,</span> <span class="token property">"offer"</span><span class="token operator">:</span> <span class="token null keyword">null</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">120</span><span class="token punctuation">,</span> <span class="token comment">// represents total number of campaigns</span> <span class="token property">"limit"</span><span class="token operator">:</span> <span class="token number">15</span><span class="token punctuation">,</span> <span class="token comment">// represents number of campaigns per page</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-campaigns" href="#get-campaigns" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-campaigns"><span class="icon icon-link"></span></a>Get Campaigns</a></h3><p><code>GET /v2/partners/affiliates/campaigns</code> - get campaigns</p><h5 class="heading"><a id="headers-18" href="#headers-18" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-18"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-6" href="#query-parameters-6" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-6"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>state</code> - <code>active</code> (default) or <code>disabled</code></li></ul><h5 class="heading"><a id="response-19" href="#response-19" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-19"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"active"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"livechat"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"Hello World!"</span><span class="token punctuation">,</span> <span class="token property">"slug"</span><span class="token operator">:</span> <span class="token string">"pp_hello-world"</span><span class="token punctuation">,</span> <span class="token property">"url"</span><span class="token operator">:</span> <span class="token string">"https://www.livechat.com/pricing/?a=xyz&utm_campaign=pp_hello-world&utm_source=PP"</span><span class="token punctuation">,</span> <span class="token property">"short_url"</span><span class="token operator">:</span> <span class="token string">"https://lc.chat/abc"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-03-06 23:42:19"</span> <span class="token property">"trial_duration"</span><span class="token operator">:</span> <span class="token number">30</span><span class="token punctuation">,</span> <span class="token property">"discount"</span><span class="token operator">:</span> <span class="token string">"30% off first payment"</span><span class="token punctuation">,</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"active"</span><span class="token operator">:</span> <span class="token boolean">true</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2019-11-21 14:22:14"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"Test Campaign"</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"chatbot"</span><span class="token punctuation">,</span> <span class="token string">"short_url:"</span> <span class="token string">"https://lc.chat/xyz"</span><span class="token punctuation">,</span> <span class="token property">"slug"</span><span class="token operator">:</span> <span class="token string">"pp_test-campaign"</span> <span class="token property">"trial_duration"</span><span class="token operator">:</span> <span class="token number">7</span><span class="token punctuation">,</span> <span class="token property">"url"</span><span class="token operator">:</span> <span class="token string">"https://chatbot.com/?a=xyzK&utm_campaign=pp_test-campaign&utm_source=PP"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> <span class="token comment">// Note - `slug` is a URL-friendly campaign name with `pp_` prefix</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="disable-campaign" href="#disable-campaign" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#disable-campaign"><span class="icon icon-link"></span></a>Disable Campaign</a></h3><p><code>DELETE /v2/partners/affiliates/campaigns/<campaign_id></code> - disable a campaign</p><h5 class="heading"><a id="path-parameters-1" href="#path-parameters-1" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-1"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><campaign_id></code> - <strong>required</strong> - campaign ID</li></ul><h5 class="heading"><a id="headers-19" href="#headers-19" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-19"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-20" href="#response-20" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-20"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>204 - No Content</code> - success</li><li><code>400 - Bad Request</code> - incorrect parameter</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>403 - Forbidden</code> - the given campaign doesn't exist or was already disabled</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request DELETE <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/123 <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-affiliate-licenses" href="#get-affiliate-licenses" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-affiliate-licenses"><span class="icon icon-link"></span></a>Get Affiliate Licenses</a></h3><p><code>GET /v2/partners/affiliates/licenses</code> - get the list of Affiliate licenses</p><h5 class="heading"><a id="headers-20" href="#headers-20" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-20"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-7" href="#query-parameters-7" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-7"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get licenses created from a given date</li><li><code>date_to</code> - get licenses created up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DD</code></p><h5 class="heading"><a id="response-21" href="#response-21" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-21"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>400 - Bad Request</code> - incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/licenses <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"livechat"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2019-10-25 14:55:57"</span><span class="token punctuation">,</span> <span class="token property">"end_timestamp"</span><span class="token operator">:</span> <span class="token string">"2019-11-25 12:55:54"</span><span class="token punctuation">,</span> <span class="token property">"active"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"ql"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"cc_added"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"commission_percent"</span><span class="token operator">:</span> <span class="token number">20</span><span class="token punctuation">,</span> <span class="token property">"earnings"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"blocked"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"campaign_name"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_campaign"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_medium"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_content"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_term"</span><span class="token operator">:</span> <span class="token string">""</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"chatbot"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2019-09-05 15:51:39"</span><span class="token punctuation">,</span> <span class="token property">"end_timestamp"</span><span class="token operator">:</span> <span class="token string">"2019-10-05 13:51:39"</span><span class="token punctuation">,</span> <span class="token property">"active"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"ql"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"cc_added"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"commission_percent"</span><span class="token operator">:</span> <span class="token number">20</span><span class="token punctuation">,</span> <span class="token property">"earnings"</span><span class="token operator">:</span> <span class="token number">18.2</span><span class="token punctuation">,</span> <span class="token property">"blocked"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"campaign_name"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_campaign"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_medium"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_content"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_term"</span><span class="token operator">:</span> <span class="token string">""</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-performance-report" href="#get-performance-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-performance-report"><span class="icon icon-link"></span></a>Get Performance Report</a></h3><p><code>GET /v2/partners/affiliates/performance</code> - get Affiliate's performance report</p><h5 class="heading"><a id="headers-21" href="#headers-21" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-21"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-8" href="#query-parameters-8" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-8"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get a report for licenses created from a given date</li><li><code>date_to</code> - get a report for licenses created up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DD</code></p><h5 class="heading"><a id="response-22" href="#response-22" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-22"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>400 - Bad Request</code> - incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/performance <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"livechat"</span><span class="token punctuation">,</span> <span class="token property">"campaign_name"</span><span class="token operator">:</span> <span class="token string">"Newsletter"</span><span class="token punctuation">,</span> <span class="token property">"utm_campaign"</span><span class="token operator">:</span> <span class="token string">"pp_newsletter"</span><span class="token punctuation">,</span> <span class="token property">"utm_medium"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_content"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_term"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"clicks"</span><span class="token operator">:</span> <span class="token number">141</span><span class="token punctuation">,</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token number">58</span><span class="token punctuation">,</span> <span class="token property">"qls"</span><span class="token operator">:</span> <span class="token number">47</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">24</span><span class="token punctuation">,</span> <span class="token property">"partners_referred"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"commission"</span><span class="token operator">:</span> <span class="token number">7284.2</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"partner_program"</span><span class="token punctuation">,</span> <span class="token property">"campaign_name"</span><span class="token operator">:</span> <span class="token string">"ad"</span><span class="token punctuation">,</span> <span class="token property">"utm_campaign"</span><span class="token operator">:</span> <span class="token string">"pp_ad"</span><span class="token punctuation">,</span> <span class="token property">"utm_medium"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_content"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_term"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"clicks"</span><span class="token operator">:</span> <span class="token number">154</span><span class="token punctuation">,</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"qls"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"partners_referred"</span><span class="token operator">:</span> <span class="token number">123</span><span class="token punctuation">,</span> <span class="token property">"commission"</span><span class="token operator">:</span> <span class="token number">3141</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"chatbot"</span><span class="token punctuation">,</span> <span class="token property">"campaign_name"</span><span class="token operator">:</span> <span class="token string">"AI Campaign"</span><span class="token punctuation">,</span> <span class="token property">"utm_campaign"</span><span class="token operator">:</span> <span class="token string">"pp_ai-campaign"</span><span class="token punctuation">,</span> <span class="token property">"utm_medium"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_content"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_term"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"clicks"</span><span class="token operator">:</span> <span class="token number">72</span><span class="token punctuation">,</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token number">41</span><span class="token punctuation">,</span> <span class="token property">"qls"</span><span class="token operator">:</span> <span class="token number">17</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">23</span><span class="token punctuation">,</span> <span class="token property">"partners_referred"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"commission"</span><span class="token operator">:</span> <span class="token number">1961.6</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-partners-referred" href="#get-partners-referred" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-partners-referred"><span class="icon icon-link"></span></a>Get Partners Referred</a></h3><p><code>GET /v2/partners/affiliates/partners-referred</code> - get the list of referred Partners</p><h5 class="heading"><a id="headers-22" href="#headers-22" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-22"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-23" href="#response-23" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-23"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/partners-referred <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"partner_id"</span><span class="token operator">:</span> <span class="token string">"W-5ZzZyiR"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2019-08-21 10:02:44"</span><span class="token punctuation">,</span> <span class="token property">"active_trials"</span><span class="token operator">:</span> <span class="token number">10</span><span class="token punctuation">,</span> <span class="token property">"active_trials_cc_added"</span><span class="token operator">:</span> <span class="token number">14</span><span class="token punctuation">,</span> <span class="token property">"total_trials"</span><span class="token operator">:</span> <span class="token number">41</span><span class="token punctuation">,</span> <span class="token property">"active_paid"</span><span class="token operator">:</span> <span class="token number">8</span><span class="token punctuation">,</span> <span class="token property">"total_paid"</span><span class="token operator">:</span> <span class="token number">8</span><span class="token punctuation">,</span> <span class="token property">"commission"</span><span class="token operator">:</span> <span class="token number">5124.2</span><span class="token punctuation">,</span> <span class="token property">"campaign_name"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_campaign"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_medium"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_content"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_term"</span><span class="token operator">:</span> <span class="token string">""</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"partner_id"</span><span class="token operator">:</span> <span class="token string">"BqgFtQEmR"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2019-08-14 16:24:12"</span><span class="token punctuation">,</span> <span class="token property">"active_trials"</span><span class="token operator">:</span> <span class="token number">16</span><span class="token punctuation">,</span> <span class="token property">"active_trials_cc_added"</span><span class="token operator">:</span> <span class="token number">4</span><span class="token punctuation">,</span> <span class="token property">"total_trials"</span><span class="token operator">:</span> <span class="token number">51</span><span class="token punctuation">,</span> <span class="token property">"active_paid"</span><span class="token operator">:</span> <span class="token number">19</span><span class="token punctuation">,</span> <span class="token property">"total_paid"</span><span class="token operator">:</span> <span class="token number">20</span><span class="token punctuation">,</span> <span class="token property">"commission"</span><span class="token operator">:</span> <span class="token number">6815</span><span class="token punctuation">,</span> <span class="token property">"campaign_name"</span><span class="token operator">:</span> <span class="token string">"My awesome campaign"</span><span class="token punctuation">,</span> <span class="token property">"utm_campaign"</span><span class="token operator">:</span> <span class="token string">"pp_my_awesome_campaign"</span><span class="token punctuation">,</span> <span class="token property">"utm_medium"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_content"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"utm_term"</span><span class="token operator">:</span> <span class="token string">""</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-affiliate-links" href="#get-affiliate-links" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-affiliate-links"><span class="icon icon-link"></span></a>Get Affiliate Links</a></h3><p><code>GET /v2/partners/affiliates/links</code> - get affiliate links (long and short version) for default campaigns of each product</p><h5 class="heading"><a id="headers-23" href="#headers-23" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-23"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-24" href="#response-24" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-24"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/links <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"livechat"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"url"</span><span class="token operator">:</span> <span class="token string">"https://www.livechat.com/?a=JXkcUIvMR&utm_source=PP"</span><span class="token punctuation">,</span> <span class="token property">"short_url"</span><span class="token operator">:</span> <span class="token string">"https://lc.chat/pTQxp"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"chatbot"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"url"</span><span class="token operator">:</span> <span class="token string">"https://www.chatbot.com/?a=JXkcUIvMR&utm_source=PP"</span><span class="token punctuation">,</span> <span class="token property">"short_url"</span><span class="token operator">:</span> <span class="token string">"https://lc.chat/Xm6qW"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"partner_program"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"url"</span><span class="token operator">:</span> <span class="token string">"https://partners.livechat.com/?a=JXkcUIvMR&utm_source=PP"</span><span class="token punctuation">,</span> <span class="token property">"short_url"</span><span class="token operator">:</span> <span class="token string">"https://lc.chat/xzrKk"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-trials-metrics" href="#get-trials-metrics" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-trials-metrics"><span class="icon icon-link"></span></a>Get Trials Metrics</a></h3><p><code>GET /v2/partners/affiliates/metrics/trials</code> - get number of trials generated from Affiliate campaigns</p><h5 class="heading"><a id="headers-24" href="#headers-24" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-24"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-9" href="#query-parameters-9" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-9"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get trials metrics from a given date</li><li><code>date_to</code> - get trials metrics up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-25" href="#response-25" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-25"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/metrics/trials?date_from<span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">99</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-earnings-metrics" href="#get-earnings-metrics" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-earnings-metrics"><span class="icon icon-link"></span></a>Get Earnings Metrics</a></h3><p><code>GET /v2/partners/affiliates/metrics/earnings</code> - get earnings generated from Affiliate campaigns</p><h5 class="heading"><a id="headers-25" href="#headers-25" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-25"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-10" href="#query-parameters-10" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-10"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get earnings metrics from a given date</li><li><code>date_to</code> - get earnings metrics up to a given date</li><li><code>product</code> - optional - get earnings metrics for a given product (one of: <code>livechat</code>, <code>chatbot</code>, <code>helpdesk</code>)</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-26" href="#response-26" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-26"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/metrics/earnings?date_from<span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">product</span><span class="token operator">=</span>livechat <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">123.45</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-conversions-metrics" href="#get-conversions-metrics" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-conversions-metrics"><span class="icon icon-link"></span></a>Get Conversions Metrics</a></h3><p><code>GET /v2/partners/affiliates/metrics/conversions</code> - get number of trials converted into paid licenses generated from Affiliate campaigns</p><h5 class="heading"><a id="headers-26" href="#headers-26" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-26"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-11" href="#query-parameters-11" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-11"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get conversions metrics from a given date</li><li><code>date_to</code> - get conversions metrics up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-27" href="#response-27" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-27"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/metrics/conversions?date_from<span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">123</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-clicks-metrics" href="#get-clicks-metrics" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-clicks-metrics"><span class="icon icon-link"></span></a>Get Clicks Metrics</a></h3><p><code>GET /v2/partners/affiliates/metrics/clicks</code> - get clicks generated from Affiliate campaigns</p><h5 class="heading"><a id="headers-27" href="#headers-27" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-27"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-12" href="#query-parameters-12" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-12"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get clicks metrics from a given date</li><li><code>date_to</code> - get clicks metrics up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-28" href="#response-28" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-28"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/metrics/clicks?date_from<span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">123</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-referred-partners-commission-metrics" href="#get-referred-partners-commission-metrics" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-referred-partners-commission-metrics"><span class="icon icon-link"></span></a>Get Referred Partners Commission Metrics</a></h3><p><code>GET /v2/partners/partners-referred/metrics/commission</code> - get commission generated from referred partners activity</p><h5 class="heading"><a id="headers-28" href="#headers-28" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-28"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-13" href="#query-parameters-13" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-13"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get commission metrics from a given date</li><li><code>date_to</code> - get commission metrics up to a given date</li><li><code>product</code> - get commission metric for a given product (one of: <code>livechat</code>, <code>chatbot</code>, <code>partner_program</code>, <code>all</code>; default: <code>all</code>)</li><li><code>program</code> - get commission metrics for a given program (one of: <code>solution</code>, <code>affiliate</code>, <code>all</code>; default: <code>all</code>)</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-29" href="#response-29" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-29"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/partners-referred/metrics/commission?date_from<span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">product</span><span class="token operator">=</span>livechat<span class="token operator">&</span><span class="token assign-left variable">program</span><span class="token operator">=</span>solution <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">123.45</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-trials-report" href="#get-trials-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-trials-report"><span class="icon icon-link"></span></a>Get Trials Report</a></h3><p><code>GET /v2/partners/affiliates/reports/trials</code> - get trials report for the Affiliate activity over time (up to last 12 months)</p><h5 class="heading"><a id="headers-29" href="#headers-29" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-29"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-14" href="#query-parameters-14" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-14"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - <strong>required</strong> - get report from a given date</li><li><code>date_to</code> - <strong>required</strong> - get report up to a given date</li><li><code>aggregation</code> - <strong>required</strong> - get report aggregated by a given timespan (one of: <code>day</code>, <code>week</code>, <code>month</code>)</li><li><code>product</code> - get report for a given product (one of: <code>livechat</code>, <code>chatbot</code>, <code>helpdesk</code>, <code>all</code>; default: <code>all</code>)</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-30" href="#response-30" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-30"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/reports/trials?date_from<span class="token operator">=</span><span class="token number">2022</span>-02-15T00:00:00Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2023</span>-02-14T23:59:59Z<span class="token operator">&</span><span class="token assign-left variable">aggregation</span><span class="token operator">=</span>month<span class="token operator">&</span><span class="token assign-left variable">product</span><span class="token operator">=</span>livechat <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-02-12 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-02-12 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">3</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-02-13 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-02-13 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">5</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-02-14 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-02-14 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">0</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-earnings-report" href="#get-earnings-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-earnings-report"><span class="icon icon-link"></span></a>Get Earnings Report</a></h3><p><code>GET /v2/partners/affiliates/reports/earnings</code> - get earnings report for the Affiliate activity over time (up to last 12 months)</p><h5 class="heading"><a id="headers-30" href="#headers-30" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-30"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-15" href="#query-parameters-15" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-15"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - <strong>required</strong> - get report from a given date</li><li><code>date_to</code> - <strong>required</strong> - get report up to a given date</li><li><code>aggregation</code> - <strong>required</strong> - get report aggregated by a given timespan (one of: <code>day</code>, <code>week</code>, <code>month</code>)</li><li><code>product</code> - get report for a given product (one of: <code>livechat</code>, <code>chatbot</code>, <code>helpdesk</code>, <code>all</code>; default: <code>all</code>)</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-31" href="#response-31" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-31"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/reports/earnings?date_from<span class="token operator">=</span><span class="token number">2022</span>-12-15T00:00:00Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2023</span>-02-14T23:59:59Z<span class="token operator">&</span><span class="token assign-left variable">aggregation</span><span class="token operator">=</span>month<span class="token operator">&</span><span class="token assign-left variable">product</span><span class="token operator">=</span>livechat <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2022-12-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2022-12-31 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">6326.39</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-01-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-01-31 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">4949.1</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-02-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-02-28 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">7824.5</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-conversions-report" href="#get-conversions-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-conversions-report"><span class="icon icon-link"></span></a>Get Conversions Report</a></h3><p><code>GET /v2/partners/affiliates/reports/conversions</code> - get conversions report for the Affiliate activity over time (up to last 12 months)</p><h5 class="heading"><a id="headers-31" href="#headers-31" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-31"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-16" href="#query-parameters-16" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-16"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - <strong>required</strong> - get report from a given date</li><li><code>date_to</code> - <strong>required</strong> - get report up to a given date</li><li><code>aggregation</code> - <strong>required</strong> - get report aggregated by a given timespan (one of: <code>day</code>, <code>week</code>, <code>month</code>)</li><li><code>product</code> - get report for a given product (one of: <code>livechat</code>, <code>chatbot</code>, <code>helpdesk</code>, <code>all</code>; default: <code>all</code>)</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-32" href="#response-32" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-32"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/reports/conversions?date_from<span class="token operator">=</span><span class="token number">2023</span>-01-21T00:00:00Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2023</span>-02-11T23:59:59Z<span class="token operator">&</span><span class="token assign-left variable">aggregation</span><span class="token operator">=</span>week<span class="token operator">&</span><span class="token assign-left variable">product</span><span class="token operator">=</span>chatbot <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-01-16 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-01-22 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">6</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-01-23 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-01-29 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">3</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-01-30 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-02-05 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">0</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-02-06 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-02-12 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">1</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-clicks-report" href="#get-clicks-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-clicks-report"><span class="icon icon-link"></span></a>Get Clicks Report</a></h3><p><code>GET /v2/partners/affiliates/reports/clicks</code> - get clicks report for the Affiliate activity over time (up to last 12 months)</p><h5 class="heading"><a id="headers-32" href="#headers-32" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-32"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-17" href="#query-parameters-17" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-17"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - <strong>required</strong> - get report from a given date</li><li><code>date_to</code> - <strong>required</strong> - get report up to a given date</li><li><code>aggregation</code> - <strong>required</strong> - get report aggregated by a given timespan (one of: <code>day</code>, <code>week</code>, <code>month</code>)</li><li><code>product</code> - get report for a given product (one of: <code>livechat</code>, <code>chatbot</code>, <code>helpdesk</code>, <code>all</code>; default: <code>all</code>)</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-33" href="#response-33" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-33"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/reports/clicks?date_from<span class="token operator">=</span><span class="token number">2023</span>-03-25T00:00:00Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2023</span>-03-26T23:59:59Z<span class="token operator">&</span><span class="token assign-left variable">aggregation</span><span class="token operator">=</span>day<span class="token operator">&</span><span class="token assign-left variable">product</span><span class="token operator">=</span>all <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-03-25 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-03-25 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">0</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2023-03-26 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2023-03-26 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">1</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-licenses-by-status" href="#get-licenses-by-status" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-licenses-by-status"><span class="icon icon-link"></span></a>Get Licenses By Status</a></h3><p><code>GET /v2/partners/partners/affiliates/licenses/<status></code> - get affiliate licenses of a certain status</p><h5 class="heading"><a id="headers-33" href="#headers-33" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-33"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-2" href="#path-parameters-2" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-2"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><status></code> - <strong>required</strong> - license status (<code>trial</code> , <code>paid</code> or <code>expired</code>)</li></ul><h5 class="heading"><a id="query-parameters-18" href="#query-parameters-18" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-18"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - <strong>required</strong> - get licenses from a given date</li><li><code>date_to</code> - <strong>required</strong> - get licenses up to a given date</li><li><code>limit</code> - get certain amount of licenses in response (min. 1 , max. 15 - default)</li><li><code>next cursor</code> - cursor for fetching next batch of licenses</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-34" href="#response-34" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-34"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/licenses/paid?date_from<span class="token operator">=</span><span class="token number">2022</span>-01-01<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01<span class="token operator">&</span><span class="token assign-left variable">limit</span><span class="token operator">=</span><span class="token number">1</span> <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"results"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"campaign"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"paid"</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"livechat"</span><span class="token punctuation">,</span> <span class="token property">"commission"</span><span class="token operator">:</span> <span class="token number">10</span><span class="token punctuation">,</span> <span class="token property">"earnings"</span><span class="token operator">:</span> <span class="token number">357.5</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2022-10-06 13:40:46"</span><span class="token punctuation">,</span> <span class="token property">"conversion_timestamp"</span><span class="token operator">:</span> <span class="token string">"2022-10-20 13:41:55"</span><span class="token punctuation">,</span> <span class="token property">"expiration_timestamp"</span><span class="token operator">:</span> <span class="token string">"2023-10-20 11:40:45"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"next_cursor"</span><span class="token operator">:</span> <span class="token string">"MjAyMi0wOC0zMCAxMzowNjozNg=="</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-campaigns-earnings-metric" href="#get-campaigns-earnings-metric" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-campaigns-earnings-metric"><span class="icon icon-link"></span></a>Get Campaigns Earnings Metric</a></h3><p><code>GET /v2/partners/affiliates/campaigns/<campaign_id>/metrics/earnings</code> - get affiliate campaign earnings metric</p><h5 class="heading"><a id="headers-34" href="#headers-34" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-34"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-3" href="#path-parameters-3" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-3"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><campaign_id></code> - <strong>required</strong> - campaign ID</li></ul><h5 class="heading"><a id="query-parameters-19" href="#query-parameters-19" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-19"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get earnings metrics from a given date</li><li><code>date_to</code> - get earnings metrics up to a given date</li><li><code>billing_cycle</code> - <strong>required</strong> - billing cycle, <code>monthly</code> or <code>annual</code></li></ul><h5 class="heading"><a id="response-35" href="#response-35" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-35"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/123/metrics/earnings?date_from<span class="token operator">=</span><span class="token number">2022</span>-01-01<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01<span class="token operator">&</span><span class="token assign-left variable">billing_cycle</span><span class="token operator">=</span>annual <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">37.21</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-campaigns-earnings-report" href="#get-campaigns-earnings-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-campaigns-earnings-report"><span class="icon icon-link"></span></a>Get Campaigns Earnings Report</a></h3><p><code>GET /v2/partners/affiliates/campaigns/<campaign_id>/reports/earnings</code> - get affiliate campaign earnings report</p><h5 class="heading"><a id="headers-35" href="#headers-35" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-35"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-4" href="#path-parameters-4" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-4"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><campaign_id></code> - <strong>required</strong> - campaign ID</li></ul><h5 class="heading"><a id="query-parameters-20" href="#query-parameters-20" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-20"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get earnings metrics from a given date</li><li><code>date_to</code> - get earnings metrics up to a given date</li><li><code>billing_cycle</code> - <strong>required</strong> - billing cycle, <code>monthly</code> or <code>annual</code></li><li><code>aggregation</code> - <strong>required</strong> - get report aggregated by a given timespan (one of: <code>day</code>, <code>week</code>, <code>month</code>)</li></ul><h5 class="heading"><a id="response-36" href="#response-36" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-36"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/123/reports/earnings?date_from<span class="token operator">=</span><span class="token number">2022</span>-01-01<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01<span class="token operator">&</span><span class="token assign-left variable">billing_cycle</span><span class="token operator">=</span>annua<span class="token operator">&</span><span class="token assign-left variable">aggregation</span><span class="token operator">=</span>month <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2022-03-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2022-03-31 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">12</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2022-04-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2022-04-30 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">34</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2022-05-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2022-05-31 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">56</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-campaigns-summary" href="#get-campaigns-summary" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-campaigns-summary"><span class="icon icon-link"></span></a>Get Campaigns Summary</a></h3><p><code>GET /v2/partners/affiliates/campaigns/<campaign_id>/summary</code> - get affiliate campaigns summary</p><h5 class="heading"><a id="headers-36" href="#headers-36" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-36"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-5" href="#path-parameters-5" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-5"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><campaign_id></code> - <strong>required</strong> - campaign ID</li></ul><h5 class="heading"><a id="response-37" href="#response-37" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-37"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/123/summary <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"click"</span><span class="token operator">:</span> <span class="token number">21</span><span class="token punctuation">,</span> <span class="token property">"trial"</span><span class="token operator">:</span> <span class="token number">37</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">42</span><span class="token punctuation">,</span> <span class="token property">"earnings"</span><span class="token operator">:</span> <span class="token number">3127.00</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-best-performing-campaigns-clicks-report" href="#get-best-performing-campaigns-clicks-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-clicks-report"><span class="icon icon-link"></span></a>Get Best Performing Campaigns Clicks Report</a></h3><p><code>GET /v2/partners/affiliates/campaigns/best-performing/reports/clicks</code> - get clicks report for a given number of Best Performing campaigns</p><h5 class="heading"><a id="headers-37" href="#headers-37" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-37"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-21" href="#query-parameters-21" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-21"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>limit</code> - number of campaigns to return</li><li><code>date_from</code> - get clicks report from a given date</li><li><code>date_to</code> - get clicks report up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-38" href="#response-38" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-38"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/reports/clicks?limit<span class="token operator">=</span><span class="token number">2</span><span class="token operator">&</span><span class="token assign-left variable">date_from</span><span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">123</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"campaign_123"</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">300</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"chatbot"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">456</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"campaign_456"</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">400</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"livechat"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-best-performing-campaigns-trials-report" href="#get-best-performing-campaigns-trials-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-trials-report"><span class="icon icon-link"></span></a>Get Best Performing Campaigns Trials Report</a></h3><p><code>GET /v2/partners/affiliates/campaigns/best-performing/reports/trials</code> - get trials report for a given number of Best Performing campaigns</p><h5 class="heading"><a id="headers-38" href="#headers-38" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-38"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-22" href="#query-parameters-22" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-22"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>limit</code> - number of campaigns to return</li><li><code>date_from</code> - get trials report from a given date</li><li><code>date_to</code> - get trials report up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-39" href="#response-39" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-39"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/reports/trials?limit<span class="token operator">=</span><span class="token number">2</span><span class="token operator">&</span><span class="token assign-left variable">date_from</span><span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">123</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"campaign_123"</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">300</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"chatbot"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">456</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"campaign_456"</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">400</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"livechat"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-best-performing-campaigns-conversions-report" href="#get-best-performing-campaigns-conversions-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-conversions-report"><span class="icon icon-link"></span></a>Get Best Performing Campaigns Conversions Report</a></h3><p><code>GET /v2/partners/affiliates/campaigns/best-performing/reports/conversions</code> - get conversions report for a given number of Best Performing campaigns</p><h5 class="heading"><a id="headers-39" href="#headers-39" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-39"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-23" href="#query-parameters-23" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-23"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>limit</code> - number of campaigns to return</li><li><code>date_from</code> - get conversions report from a given date</li><li><code>date_to</code> - get conversions report up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-40" href="#response-40" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-40"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/reports/conversions?limit<span class="token operator">=</span><span class="token number">2</span><span class="token operator">&</span><span class="token assign-left variable">date_from</span><span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">123</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"campaign_123"</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">300</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"chatbot"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">456</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"campaign_456"</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">400</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"livechat"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-best-performing-campaigns-earnings-report" href="#get-best-performing-campaigns-earnings-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-earnings-report"><span class="icon icon-link"></span></a>Get Best Performing Campaigns Earnings Report</a></h3><p><code>GET /v2/partners/affiliates/campaigns/best-performing/reports/conversions</code> - get earnings report for a given number of Best Performing campaigns</p><h5 class="heading"><a id="headers-40" href="#headers-40" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-40"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-24" href="#query-parameters-24" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-24"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>limit</code> - number of campaigns to return</li><li><code>date_from</code> - get earnings report from a given date</li><li><code>date_to</code> - get earnings report up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-41" href="#response-41" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-41"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/reports/earnings?limit<span class="token operator">=</span><span class="token number">2</span><span class="token operator">&</span><span class="token assign-left variable">date_from</span><span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">123</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"campaign_123"</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">300.10</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"chatbot"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">456</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"campaign_456"</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">400.10</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"livechat"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-best-performing-campaigns-clicks-metrics" href="#get-best-performing-campaigns-clicks-metrics" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-clicks-metrics"><span class="icon icon-link"></span></a>Get Best Performing Campaigns Clicks Metrics</a></h3><p><code>GET /v2/partners/affiliates/campaigns/best-performing/metrics/clicks</code> - get summarized number of clicks generated from a given number of Best Performing campaigns</p><h5 class="heading"><a id="headers-41" href="#headers-41" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-41"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-25" href="#query-parameters-25" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-25"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>limit</code> - number of campaigns to return</li><li><code>date_from</code> - get clicks metrics from a given date</li><li><code>date_to</code> - get clicks metrics up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-42" href="#response-42" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-42"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/metrics/clicks?limit<span class="token operator">=</span><span class="token number">2</span><span class="token operator">&</span><span class="token assign-left variable">date_from</span><span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">123</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-best-performing-campaigns-trials-metrics" href="#get-best-performing-campaigns-trials-metrics" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-trials-metrics"><span class="icon icon-link"></span></a>Get Best Performing Campaigns Trials Metrics</a></h3><p><code>GET /v2/partners/affiliates/campaigns/best-performing/metrics/trials</code> - get summarized number of trials generated from a given number of Best Performing campaigns</p><h5 class="heading"><a id="headers-42" href="#headers-42" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-42"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-26" href="#query-parameters-26" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-26"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>limit</code> - number of campaigns to return</li><li><code>date_from</code> - get trials metrics from a given date</li><li><code>date_to</code> - get trials metrics up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-43" href="#response-43" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-43"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/metrics/trials?limit<span class="token operator">=</span><span class="token number">2</span><span class="token operator">&</span><span class="token assign-left variable">date_from</span><span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">123</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-best-performing-campaigns-conversions-metrics" href="#get-best-performing-campaigns-conversions-metrics" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-conversions-metrics"><span class="icon icon-link"></span></a>Get Best Performing Campaigns Conversions Metrics</a></h3><p><code>GET /v2/partners/affiliates/campaigns/best-performing/metrics/conversions</code> - get summarized number of trials converted into paid licenses generated from a given number of Best Performing campaigns</p><h5 class="heading"><a id="headers-43" href="#headers-43" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-43"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-27" href="#query-parameters-27" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-27"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>limit</code> - number of campaigns to return</li><li><code>date_from</code> - get conversions metrics from a given date</li><li><code>date_to</code> - get conversions metrics up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-44" href="#response-44" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-44"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/metrics/conversions?limit<span class="token operator">=</span><span class="token number">2</span><span class="token operator">&</span><span class="token assign-left variable">date_from</span><span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">123</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-best-performing-campaigns-earnings-metrics" href="#get-best-performing-campaigns-earnings-metrics" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-best-performing-campaigns-earnings-metrics"><span class="icon icon-link"></span></a>Get Best Performing Campaigns Earnings Metrics</a></h3><p><code>GET /v2/partners/affiliates/campaigns/best-performing/metrics/earnings</code> - get summarized earnings generated from a given number of Best Performing campaigns</p><h5 class="heading"><a id="headers-44" href="#headers-44" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-44"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-28" href="#query-parameters-28" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-28"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>limit</code> - number of campaigns to return</li><li><code>date_from</code> - get earnings metrics from a given date</li><li><code>date_to</code> - get earnings metrics up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-45" href="#response-45" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-45"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/campaigns/best-performing/metrics/earnings?limit<span class="token operator">=</span><span class="token number">2</span><span class="token operator">&</span><span class="token assign-left variable">date_from</span><span class="token operator">=</span><span class="token number">2022</span>-01-01T10:10:10Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-12-01T10:10:10Z <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token number">123.00</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-summary" href="#get-summary" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-summary"><span class="icon icon-link"></span></a>Get Summary</a></h3><p><code>GET /v2/partners/affiliates/summary</code> - get a number of trial affiliate licenses, paid affiliate licenses, and expired affiliate licenses</p><h5 class="heading"><a id="headers-45" href="#headers-45" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-45"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-46" href="#response-46" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-46"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/affiliates/summary <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"expired"</span><span class="token operator">:</span> <span class="token number">0</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><h2 class="heading css-1679d3t"><a id="solution-partner" href="#solution-partner" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#solution-partner"><span class="icon icon-link"></span></a>Solution Partner</a></h2><ul><li><a href="/docs/monetization/partner-program-api#create-license">Create License</a></li><li><a href="/docs/monetization/partner-program-api#get-solution-licenses">Get Solution Licenses</a></li><li><a href="/docs/monetization/partner-program-api#get-solution-licenses-by-status">Get Solution Licenses by Status</a></li><li><a href="/docs/monetization/partner-program-api#get-solution-licenses-report">Get Solution Licenses Report</a></li><li><a href="/docs/monetization/partner-program-api#get-solution-licenses-csv-report">Get Solution Licenses CSV Report</a></li><li><a href="/docs/monetization/partner-program-api#get-license-details">Get License Details</a></li><li><a href="/docs/monetization/partner-program-api#update-license-details">Update License Details</a></li><li><a href="/docs/monetization/partner-program-api#get-license-operators">Get License Operators</a></li><li><a href="/docs/monetization/partner-program-api#invite-license-operators">Invite License Operators</a></li><li><a href="/docs/monetization/partner-program-api#get-license-invoices">Get License's Invoices</a></li><li><a href="/docs/monetization/partner-program-api#get-license-invoice-pdf">Get License's Invoice PDF</a></li><li><a href="/docs/monetization/partner-program-api#create-subscription">Create Subscription</a></li><li><a href="/docs/monetization/partner-program-api#update-subscription">Update Subscription</a></li><li><a href="/docs/monetization/partner-program-api#close-subscription">Close Subscription</a></li><li><a href="/docs/monetization/partner-program-api#update-license-billing">Update License Billing</a></li><li><a href="/docs/monetization/partner-program-api#transfer-license">Transfer License</a></li><li><a href="/docs/monetization/partner-program-api#get-recurly-token">Get Recurly Token</a></li><li><a href="/docs/monetization/partner-program-api#get-license-metrics">Get License Metrics</a></li><li><a href="/docs/monetization/partner-program-api#get-leads">Get Leads</a></li><li><a href="/docs/monetization/partner-program-api#get-lead-details">Get Lead Details</a></li><li><a href="/docs/monetization/partner-program-api#get-lead-history">Get Lead History</a></li><li><a href="/docs/monetization/partner-program-api#submit-lead">Submit Lead</a></li><li><a href="/docs/monetization/partner-program-api#get-solution-summary">Get Solution Summary</a></li></ul><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="create-license" href="#create-license" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#create-license"><span class="icon icon-link"></span></a>Create License</a></h3><p><code>POST /v2/partners/solutions/licenses</code> - create a new license for a client</p><h5 class="heading"><a id="headers-46" href="#headers-46" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-46"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-29" href="#query-parameters-29" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-29"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>product</code> - <strong>required</strong> - product (<code>livechat</code> or <code>chatbot</code>)</li></ul><h5 class="heading"><a id="body-4" href="#body-4" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-4"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>client_name</code> - <strong>required</strong> - client's full name (min. 5 characters)</li><li><code>client_email</code> - <strong>required</strong> - client's email address</li><li>[<em>only for <code>livechat</code> product</em>] <code>payment_origin</code> - <strong>required</strong> - who would manage subscription: <code>client</code> or <code>partner</code> (you)</li><li><code>purchase_order</code> - a custom parameter</li><li>[<em>only for <code>livechat</code> product</em>] <code>data_center</code> - database location: <code>dal</code> (USA) or <code>fra</code> (EU)</li><li>[<em>only for <code>livechat</code> product</em>] <code>trial_duration</code> - only for the <code>client</code> payment origin - the number of days of a trial period (min. 14 - default, max. 60)</li><li>[<em>only for <code>livechat</code> product</em>] <code>coupon_id</code> - only for the <code>client</code> payment origin - the ID of the coupon assigned to a Partner (will apply a discount)</li></ul><h5 class="heading"><a id="response-47" href="#response-47" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-47"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>201 - Created</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>403 - Forbidden</code> - not allowed to use the given <code>coupon_id</code></li><li><code>409 - Conflict</code> - the given <code>client_email</code> already has a license for the specified <code>product</code></li></ul></div><div class="css-17buymi"><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"license"</span><span class="token operator">:</span> <span class="token string">"123"</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"livechat"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2020-02-11 13:18:53"</span><span class="token punctuation">,</span> <span class="token property">"end_timestamp"</span><span class="token operator">:</span> <span class="token string">"2020-02-25 13:18:53"</span><span class="token punctuation">,</span> <span class="token property">"client_name"</span><span class="token operator">:</span> <span class="token string">"Joe Doe"</span><span class="token punctuation">,</span> <span class="token property">"client_email"</span><span class="token operator">:</span> <span class="token string">"joe@example.com"</span><span class="token punctuation">,</span> <span class="token property">"cc_added"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"payment_origin"</span><span class="token operator">:</span> <span class="token string">"partner"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"trial"</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-solution-licenses" href="#get-solution-licenses" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-solution-licenses"><span class="icon icon-link"></span></a>Get Solution Licenses</a></h3><p><code>GET /v2/partners/solutions/licenses</code> - get the list of licenses</p><h5 class="heading"><a id="headers-47" href="#headers-47" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-47"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-30" href="#query-parameters-30" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-30"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get a report for licenses created from a given date</li><li><code>date_to</code> - get a report for licenses created up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-48" href="#response-48" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-48"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>400 - Bad Request</code> - incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/licenses <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"license"</span><span class="token operator">:</span> <span class="token string">"123"</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"livechat"</span><span class="token punctuation">,</span> <span class="token property">"client_name"</span><span class="token operator">:</span> <span class="token string">"Joe Doe"</span><span class="token punctuation">,</span> <span class="token property">"client_email"</span><span class="token operator">:</span> <span class="token string">"joe@example.com"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2023-02-14 12:39:40"</span><span class="token punctuation">,</span> <span class="token property">"end_timestamp"</span><span class="token operator">:</span> <span class="token string">"2023-06-14 12:39:40"</span><span class="token punctuation">,</span> <span class="token property">"cc_added"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"payment_origin"</span><span class="token operator">:</span> <span class="token string">"partner"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"trial"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"license"</span><span class="token operator">:</span> <span class="token string">"789"</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"chatbot"</span><span class="token punctuation">,</span> <span class="token property">"client_name"</span><span class="token operator">:</span> <span class="token string">"John Doe"</span><span class="token punctuation">,</span> <span class="token property">"client_email"</span><span class="token operator">:</span> <span class="token string">"john@example.com"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2023-05-21 07:39:11"</span><span class="token punctuation">,</span> <span class="token property">"end_timestamp"</span><span class="token operator">:</span> <span class="token string">"2024-05-21 07:39:11"</span><span class="token punctuation">,</span> <span class="token property">"cc_added"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"payment_origin"</span><span class="token operator">:</span> <span class="token string">"client"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"paid"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-solution-licenses-by-status" href="#get-solution-licenses-by-status" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-solution-licenses-by-status"><span class="icon icon-link"></span></a>Get Solution Licenses by Status</a></h3><p><code>GET /v2/partners/solutions/licenses/<status></code> - get the list of licenses by status</p><h5 class="heading"><a id="headers-48" href="#headers-48" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-48"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-6" href="#path-parameters-6" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-6"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><status></code> - <strong>required</strong> - license status, one of: <code>paid</code>, <code>trial</code>, <code>expired</code></li></ul><h5 class="heading"><a id="query-parameters-31" href="#query-parameters-31" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-31"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - <strong>required</strong> - get a report for licenses created from a given date</li><li><code>date_to</code> - <strong>required</strong> - get a report for licenses created up to a given date</li><li><code>limit</code> - the amount of licenses in response (min: 1, max: 15, default: 15)</li><li><code>next_cursor</code> - a next page token received from the previous request's response</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-49" href="#response-49" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-49"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example below</li><li><code>400 - Bad Request</code> - incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/licenses/paid <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"results"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"license_id"</span><span class="token operator">:</span> <span class="token string">"123"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"paid"</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"livechat"</span><span class="token punctuation">,</span> <span class="token property">"client_name"</span><span class="token operator">:</span> <span class="token string">"Joe Doe"</span><span class="token punctuation">,</span> <span class="token property">"client_email"</span><span class="token operator">:</span> <span class="token string">"joe@example.com"</span><span class="token punctuation">,</span> <span class="token property">"payment_origin"</span><span class="token operator">:</span> <span class="token string">"partner"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2023-02-14 12:39:40"</span><span class="token punctuation">,</span> <span class="token property">"conversion_timestamp"</span><span class="token operator">:</span> <span class="token string">"2023-03-01 07:51:11"</span><span class="token punctuation">,</span> <span class="token property">"expiration_timestamp"</span><span class="token operator">:</span> <span class="token string">"2023-03-14 11:19:25"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"license_id"</span><span class="token operator">:</span> <span class="token string">"456"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"paid"</span><span class="token punctuation">,</span> <span class="token property">"product"</span><span class="token operator">:</span> <span class="token string">"chatbot"</span><span class="token punctuation">,</span> <span class="token property">"client_name"</span><span class="token operator">:</span> <span class="token string">"Joe Doe"</span><span class="token punctuation">,</span> <span class="token property">"client_email"</span><span class="token operator">:</span> <span class="token string">"joe@example.com"</span><span class="token punctuation">,</span> <span class="token property">"payment_origin"</span><span class="token operator">:</span> <span class="token string">"client"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2022-03-29 17:11:43"</span><span class="token punctuation">,</span> <span class="token property">"conversion_timestamp"</span><span class="token operator">:</span> <span class="token string">"2022-04-11 05:10:00"</span><span class="token punctuation">,</span> <span class="token property">"expiration_timestamp"</span><span class="token operator">:</span> <span class="token string">"2023-04-11 05:10:00"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"next_cursor"</span><span class="token operator">:</span> <span class="token string">"MDAwMS0wMS0wMSAwMDowMDowMA=="</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-license-details" href="#get-license-details" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-license-details"><span class="icon icon-link"></span></a>Get License Details</a></h3><p><code>GET /v2/partners/solutions/licenses/<product>/<license_id></code> - get the license details</p><h5 class="heading"><a id="headers-49" href="#headers-49" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-49"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-7" href="#path-parameters-7" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-7"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><product></code> - <strong>required</strong> - product (<code>livechat</code> or <code>chatbot</code>)</li><li><code><license_id></code> - <strong>required</strong> - license ID</li></ul><h5 class="heading"><a id="response-50" href="#response-50" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-50"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>404 - Not Found</code> - license not found</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/licenses/livechat/123 <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"license"</span><span class="token operator">:</span> <span class="token string">"123"</span><span class="token punctuation">,</span> <span class="token property">"client_name"</span><span class="token operator">:</span> <span class="token string">"Joe Doe"</span><span class="token punctuation">,</span> <span class="token property">"client_email"</span><span class="token operator">:</span> <span class="token string">"joe@example.com"</span><span class="token punctuation">,</span> <span class="token property">"purchase_order"</span><span class="token operator">:</span> <span class="token string">"Test license"</span><span class="token punctuation">,</span> <span class="token property">"payment_origin"</span><span class="token operator">:</span> <span class="token string">"partner"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-03-06 12:59:13"</span><span class="token punctuation">,</span> <span class="token property">"end_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-04-05 11:59:12"</span><span class="token punctuation">,</span> <span class="token property">"conversations"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"conversations_last_30_days"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"cc_added"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"ql"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"seats"</span><span class="token operator">:</span> <span class="token number">100</span><span class="token punctuation">,</span> <span class="token property">"plan"</span><span class="token operator">:</span> <span class="token string">"team"</span><span class="token punctuation">,</span> <span class="token property">"billing_cycle"</span><span class="token operator">:</span> <span class="token string">"monthly"</span><span class="token punctuation">,</span> <span class="token property">"total_discount"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"discount_percent"</span><span class="token operator">:</span> <span class="token number">20</span><span class="token punctuation">,</span> <span class="token property">"total_commission"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"commission_percent"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"data_center"</span><span class="token operator">:</span> <span class="token string">"dal"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"expired"</span><span class="token punctuation">,</span> <span class="token property">"invited_agents"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> email<span class="token operator">:</span> <span class="token string">"jane@example.com"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="update-license-details" href="#update-license-details" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#update-license-details"><span class="icon icon-link"></span></a>Update License Details</a></h3><p><code>PUT /v2/partners/solutions/licenses/<product>/<license_id></code> - update the license details</p><h5 class="heading"><a id="headers-50" href="#headers-50" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-50"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-8" href="#path-parameters-8" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-8"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><product></code> - <strong>required</strong> - product (<code>livechat</code> or <code>chatbot</code>)</li><li><code><license_id></code> - <strong>required</strong> - license ID</li></ul><h5 class="heading"><a id="body-5" href="#body-5" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-5"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>client_name</code> - client's full name (min. 5 characters)</li><li><code>purchase_order</code> - a custom parameter</li></ul><h5 class="heading"><a id="response-51" href="#response-51" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-51"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>204 - No Content</code> - success</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>404 - Not Found</code> - license not found</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request PUT <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/solutions/licenses/livechat/123 <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> <span class="token punctuation">\</span> --data <span class="token string">'client_name=Jane Doe'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-license-operators" href="#get-license-operators" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-license-operators"><span class="icon icon-link"></span></a>Get License Operators</a></h3><p><code>GET /v2/partners/solutions/licenses/<product>/<license_id>/operators</code> - get the list of a license's operators</p><h5 class="heading"><a id="headers-51" href="#headers-51" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-51"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-9" href="#path-parameters-9" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-9"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><product></code> - <strong>required</strong> - product (<code>livechat</code> or <code>chatbot</code>)</li><li><code><license_id></code> - <strong>required</strong> - license ID</li></ul><h5 class="heading"><a id="response-52" href="#response-52" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-52"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>400 - Bad Request</code> - missing or incorrect <code>license_id</code> parameter</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>404 - Not Found</code> - license not found</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/licenses/livechat/123/operators <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"login"</span><span class="token operator">:</span> <span class="token string">"joe@doe.com"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"Joe"</span><span class="token punctuation">,</span> <span class="token property">"permission"</span><span class="token operator">:</span> <span class="token string">"owner"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"login"</span><span class="token operator">:</span> <span class="token string">"jane@doe.com"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"Jane"</span><span class="token punctuation">,</span> <span class="token property">"permission"</span><span class="token operator">:</span> <span class="token string">"agent"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="invite-license-operators" href="#invite-license-operators" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#invite-license-operators"><span class="icon icon-link"></span></a>Invite License Operators</a></h3><p><code>POST /v2/partners/solutions/licenses/<product>/<license_id>/operators</code> - invite operators to a license</p><h5 class="heading"><a id="headers-52" href="#headers-52" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-52"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-10" href="#path-parameters-10" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-10"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><product></code> - <strong>required</strong> - product (<code>livechat</code> or <code>chatbot</code>)</li><li><code><license_id></code> - <strong>required</strong> - license ID</li></ul><h5 class="heading"><a id="body-6" href="#body-6" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-6"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>operators</code> - <strong>required</strong> - the list of the <strong>users</strong> you want to invite to the license.</li></ul><p>Struct of <strong>user</strong> object:</p><ul><li><code>email</code> - <strong>required</strong> - user email</li><li><code>role</code> - <strong>required</strong> - <code>administrator</code> or <code>agent</code> (<a href="https://www.livechat.com/help/livechat-roles-owner-administrators-and-agents/">learn more about the roles</a>)</li></ul><h5 class="heading"><a id="response-53" href="#response-53" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-53"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success (could be partial, check the <code>status_code</code> of each user in the response body), see the example on the right</li><li><code>400 - Bad Request</code> - missing or incorrect <code>license_id</code> parameter</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>403 - Forbidden</code> - Partner does not manage a subscription</li><li><code>404 - Not Found</code> - license not found</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/licenses/livechat/123/operators <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> <span class="token punctuation">\</span> --data <span class="token string">'{ "operators": [ { "email": "joe@example.com", "role": "agent" }, { "email": "jane@example.com", "role": "administrator" } ] }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"operator"</span><span class="token operator">:</span> <span class="token string">"joe@example.com"</span><span class="token punctuation">,</span> <span class="token property">"status_code"</span><span class="token operator">:</span> <span class="token number">200</span> <span class="token comment">// all good, invitation was sent</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"operator"</span><span class="token operator">:</span> <span class="token string">"jane@example.com"</span><span class="token punctuation">,</span> <span class="token property">"status_code"</span><span class="token operator">:</span> <span class="token number">400</span> <span class="token comment">// email is already taken</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-licenses-invoices" href="#get-licenses-invoices" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-licenses-invoices"><span class="icon icon-link"></span></a>Get License's Invoices</a></h3><p><code>GET /v2/partners/solutions/licenses/<license_id>/invoices</code> - get invoices for a given license</p><h5 class="heading"><a id="headers-53" href="#headers-53" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-53"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-11" href="#path-parameters-11" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-11"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><license_id></code> - <strong>required</strong> - license ID</li></ul><h5 class="heading"><a id="response-54" href="#response-54" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-54"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>400 - Bad Request</code> - missing or incorrect <code>license_id</code> parameter</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>404 - Not Found</code> - license not found</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/licenses/321/invoices <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"invoice_no"</span><span class="token operator">:</span> <span class="token number">123</span><span class="token punctuation">,</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2018-03-03 09:38:33"</span><span class="token punctuation">,</span> <span class="token property">"plan"</span><span class="token operator">:</span> <span class="token string">"team"</span><span class="token punctuation">,</span> <span class="token property">"seats"</span><span class="token operator">:</span> <span class="token number">10</span><span class="token punctuation">,</span> <span class="token property">"billing_cycle"</span><span class="token operator">:</span> <span class="token string">"monthly"</span><span class="token punctuation">,</span> <span class="token property">"amount"</span><span class="token operator">:</span> <span class="token number">312</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"paid"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"invoice_no"</span><span class="token operator">:</span> <span class="token number">122</span><span class="token punctuation">,</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2018-02-01 09:18:13"</span><span class="token punctuation">,</span> <span class="token property">"plan"</span><span class="token operator">:</span> <span class="token string">"team"</span><span class="token punctuation">,</span> <span class="token property">"seats"</span><span class="token operator">:</span> <span class="token number">10</span><span class="token punctuation">,</span> <span class="token property">"billing_cycle"</span><span class="token operator">:</span> <span class="token string">"monthly"</span><span class="token punctuation">,</span> <span class="token property">"amount"</span><span class="token operator">:</span> <span class="token number">312</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"paid"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-licenses-invoice-pdf" href="#get-licenses-invoice-pdf" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-licenses-invoice-pdf"><span class="icon icon-link"></span></a>Get License's Invoice PDF</a></h3><p><code>GET /v2/partners/solutions/licenses/<license_id>/invoices/<invoice_no></code> - get a PDF invoice</p><h5 class="heading"><a id="headers-54" href="#headers-54" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-54"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-12" href="#path-parameters-12" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-12"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><license_id></code> - <strong>required</strong> - license ID</li><li><code><invoice_no></code> - <strong>required</strong> - invoice number</li></ul><h5 class="heading"><a id="response-55" href="#response-55" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-55"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - PDF file (<code>Content-Type: application/pdf</code>)</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>404 - Not Found</code> - license or invoice not found</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/licenses/321/invoices/123 <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="create-subscription" href="#create-subscription" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#create-subscription"><span class="icon icon-link"></span></a>Create Subscription</a></h3><p><code>POST /v2/partners/solutions/licenses/<product>/<license_id>/subscription</code> - create a new subscription for a license</p><h5 class="heading"><a id="headers-55" href="#headers-55" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-55"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-13" href="#path-parameters-13" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-13"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><product></code> - <strong>required</strong> - product (<code>livechat</code> or <code>chatbot</code>)</li><li><code><license_id></code> - <strong>required</strong> - license ID</li></ul><h5 class="heading"><a id="body-7" href="#body-7" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-7"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>token</code> - <strong>required</strong> - Recurly token (<a href="/docs/monetization/partner-program-api#get-recurly-token">get it here</a>)</li><li><code>plan</code> - <strong>required</strong> - sales plan, one of: <code>starter</code>, <code>team</code>, <code>business</code></li><li><code>billing_cycle</code> - <strong>required</strong> - billing cycle, <code>monthly</code> or <code>annual</code></li><li><code>seats</code> - <strong>required</strong> - the number of seats</li></ul><h5 class="heading"><a id="response-56" href="#response-56" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-56"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>201 - Created</code> - success</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>404 - Not Found</code> - license not found</li><li><code>409 - Conflict</code> - subscription already exists</li></ul></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="update-subscription" href="#update-subscription" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#update-subscription"><span class="icon icon-link"></span></a>Update Subscription</a></h3><p><code>PUT /v2/partners/solutions/licenses/<product>/<license_id>/subscription</code> - update a subscription for a license</p><h5 class="heading"><a id="headers-56" href="#headers-56" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-56"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code><product></code> - <strong>required</strong> - product (<code>livechat</code> or <code>chatbot</code>)</li><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-14" href="#path-parameters-14" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-14"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><license_id></code> - <strong>required</strong> - license ID</li></ul><h5 class="heading"><a id="body-8" href="#body-8" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-8"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>plan</code> - <strong>required</strong> - sales plan, one of: <code>starter</code>, <code>team</code>, <code>business</code></li><li><code>billing_cycle</code> - <strong>required</strong> - billing cycle: <code>monthly</code> or <code>annual</code></li><li><code>seats</code> - <strong>required</strong> - the number of seats</li></ul><h5 class="heading"><a id="response-57" href="#response-57" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-57"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>204 - No Content</code> - success</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>404 - Not Found</code> - license not found</li><li><code>409 - Conflict</code> - subscription doesn't exist</li></ul></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="close-subscription" href="#close-subscription" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#close-subscription"><span class="icon icon-link"></span></a>Close Subscription</a></h3><p><code>DELETE /v2/partners/solutions/licenses/<product>/<license_id>/subscription</code> - close a subscription for a license</p><h5 class="heading"><a id="headers-57" href="#headers-57" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-57"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code><product></code> - <strong>required</strong> - product (<code>livechat</code> or <code>chatbot</code>)</li><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-15" href="#path-parameters-15" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-15"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><license_id></code> - <strong>required</strong> - license ID</li></ul><h5 class="heading"><a id="body-9" href="#body-9" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-9"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>password</code> - <strong>required</strong> - your password in Partner Program</li><li><code>expire</code> - <code>boolean</code> value (default: <code>false</code>). When closing a subscription, your license will expire at the end of its billing cycle. To make your subscription expire immediately, set the <code>expire</code> param to <code>true</code>.</li></ul><h5 class="heading"><a id="response-58" href="#response-58" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-58"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>204 - No Content</code> - success</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>403 - Forbidden</code> - password is incorrect</li><li><code>404 - Not Found</code> - license not found</li></ul></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="update-license-billing" href="#update-license-billing" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#update-license-billing"><span class="icon icon-link"></span></a>Update License Billing</a></h3><p><code>PUT /v2/partners/solutions/licenses/<product>/<license_id>/billing</code> - update the subscription billing information for a license</p><h5 class="heading"><a id="headers-58" href="#headers-58" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-58"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code><product></code> - <strong>required</strong> - product (<code>livechat</code> or <code>chatbot</code>)</li><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-16" href="#path-parameters-16" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-16"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><license_id></code> - <strong>required</strong> - license ID</li></ul><h5 class="heading"><a id="body-10" href="#body-10" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-10"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>token</code> - <strong>required</strong> - Recurly token (<a href="/docs/monetization/partner-program-api#get-recurly-token">get it here</a>)</li></ul><h5 class="heading"><a id="response-59" href="#response-59" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-59"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>204 - No Content</code> - success</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>404 - Not Found</code> - license not found</li></ul></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="transfer-license" href="#transfer-license" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#transfer-license"><span class="icon icon-link"></span></a>Transfer License</a></h3><p><code>POST /v2/partners/solutions/licenses/<product>/<license_id>/transfer</code> - transfer a license to the client</p><h5 class="heading"><a id="headers-59" href="#headers-59" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-59"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code><product></code> - <strong>required</strong> - product (<code>livechat</code> or <code>chatbot</code>)</li><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-17" href="#path-parameters-17" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-17"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code><license_id></code> - <strong>required</strong> - license ID</li></ul><h5 class="heading"><a id="body-11" href="#body-11" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-11"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>new_owner</code> - <strong>required</strong> - the new owner's email (one of <a href="/docs/monetization/partner-program-api#get-license-operators">operators</a>)</li><li><code>password</code> - <strong>required</strong> - your password in Partner Program</li></ul><h5 class="heading"><a id="response-60" href="#response-60" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-60"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>400 - Bad Request</code> - missing or incorrect parameter</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>403 - Forbidden</code> - incorrect password or license type</li><li><code>404 - Not Found</code> - license not found</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/licenses/transfer <span class="token punctuation">\</span> --data <span class="token string">'new_owner=joe@doe.com&password=mysecretpassword'</span> <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"license"</span><span class="token operator">:</span> <span class="token string">"987"</span><span class="token punctuation">,</span> <span class="token property">"client_name"</span><span class="token operator">:</span> <span class="token string">"Joe Doe"</span><span class="token punctuation">,</span> <span class="token property">"client_email"</span><span class="token operator">:</span> <span class="token string">"joe@example.com"</span><span class="token punctuation">,</span> <span class="token property">"purchase_order"</span><span class="token operator">:</span> <span class="token string">"Test license"</span><span class="token punctuation">,</span> <span class="token property">"payment_origin"</span><span class="token operator">:</span> <span class="token string">"client"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-03-06 12:59:13"</span><span class="token punctuation">,</span> <span class="token property">"end_timestamp"</span><span class="token operator">:</span> <span class="token string">"2019-04-05 11:59:12"</span><span class="token punctuation">,</span> <span class="token property">"conversations"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"conversations_last_30_days"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"cc_added"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"recurrent"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"seats"</span><span class="token operator">:</span> <span class="token number">100</span><span class="token punctuation">,</span> <span class="token property">"plan"</span><span class="token operator">:</span> <span class="token string">"team"</span><span class="token punctuation">,</span> <span class="token property">"billing_cycle"</span><span class="token operator">:</span> <span class="token string">"monthly"</span><span class="token punctuation">,</span> <span class="token property">"total_discount"</span><span class="token operator">:</span> <span class="token number">4148</span><span class="token punctuation">,</span> <span class="token property">"discount_percent"</span><span class="token operator">:</span> <span class="token number">20</span><span class="token punctuation">,</span> <span class="token property">"total_commission"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"commission_percent"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"expired"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"blocked"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"data_center"</span><span class="token operator">:</span> <span class="token string">"dal"</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-recurly-token" href="#get-recurly-token" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-recurly-token"><span class="icon icon-link"></span></a>Get Recurly Token</a></h3><p><code>GET https://api.recurly.com/js/v1/token</code> - get the token from Recurly. The token is required when creating a new subscription or updating an existing one with the new billing info.</p><h5 class="heading"><a id="parameters" href="#parameters" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#parameters"><span class="icon icon-link"></span></a>Parameters</a></h5><ul><li><code>key</code> - <strong>required</strong> - public key (<code>ewr1-QCXZap10wOSm13fxI4u5Jt</code>)</li><li><code>first_name</code> - <strong>required</strong> - first name</li><li><code>last_name</code> - <strong>required</strong> - last name</li><li><code>number</code> - <strong>required</strong> - credit card number</li><li><code>month</code> - <strong>required</strong> - credit card expiration month (format: <code>MM</code>)</li><li><code>year</code> - <strong>required</strong> - credit card expiration year (format: <code>YYYY</code>)</li><li><code>verification_value</code> - <strong>required</strong> - CVV code</li><li><code>address1</code> - <strong>required</strong> - address</li><li><code>city</code> - <strong>required</strong> - city</li><li><code>state</code> - <strong>required</strong> - state</li><li><code>zip</code> - <strong>required</strong> - ZIP/Postal code</li><li><code>country</code> - <strong>required</strong> - country code, one of <a href="https://api.livechatinc.com/v2/partners/data/countries">these</a></li></ul><h5 class="heading"><a id="response-61" href="#response-61" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-61"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li>everything else - missing or incorrect parameters (please read the error message)</li></ul></div><div class="css-17buymi"><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"C12ibIjbXbqSAhKjxQWERTY"</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-license-metrics" href="#get-license-metrics" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-license-metrics"><span class="icon icon-link"></span></a>Get License Metrics</a></h3><p><code>GET /v2/partners/solutions/licenses/count</code> - get number of trials, paid licenses, and expired licenses from the Solution program.</p><h5 class="heading"><a id="headers-60" href="#headers-60" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-60"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-32" href="#query-parameters-32" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-32"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - get trials metrics from a given date</li><li><code>date_to</code> - get trials metrics up to a given date</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-62" href="#response-62" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-62"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see example</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/licenses/count?date_from<span class="token operator">=</span><span class="token number">2022</span>-09-01<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2023</span>-08-31 <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 201</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token number">150</span><span class="token punctuation">,</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token number">16</span><span class="token punctuation">,</span> <span class="token property">"expired"</span><span class="token operator">:</span> <span class="token number">147</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-solution-licenses-report" href="#get-solution-licenses-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-solution-licenses-report"><span class="icon icon-link"></span></a>Get Solution Licenses Report</a></h3><p><code>GET /v2/partners/solutions/reports/license</code> - get report for licenses by license status.</p><h5 class="heading"><a id="headers-61" href="#headers-61" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-61"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-33" href="#query-parameters-33" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-33"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>date_from</code> - <strong>required</strong> - get report from a given date</li><li><code>date_to</code> - <strong>required</strong> - get report up to a given date</li><li><code>aggregation</code> - <strong>required</strong> - get report aggregated by a given timespan (one of: <code>day</code>, <code>week</code>, <code>month</code>)</li><li><code>license_status</code> - get report for a given licenses status (one of: <code>trial</code>, <code>paid</code>, <code>expired</code>)</li></ul><p><strong>Note:</strong> Date format: <code>YYYY-MM-DDTHH:mm:ssZ</code></p><h5 class="heading"><a id="response-63" href="#response-63" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-63"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example below</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/reports/license?aggregation<span class="token operator">=</span>month<span class="token operator">&</span><span class="token assign-left variable">date_from</span><span class="token operator">=</span><span class="token number">2022</span>-03-25T00:00:00Z<span class="token operator">&</span><span class="token assign-left variable">date_to</span><span class="token operator">=</span><span class="token number">2022</span>-05-04T00:00:00Z<span class="token operator">&</span><span class="token assign-left variable">license_status</span><span class="token operator">=</span>paid <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2022-03-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2022-03-31 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">12</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2022-04-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2022-04-30 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">34</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date_range"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"from"</span><span class="token operator">:</span> <span class="token string">"2022-05-01 00:00:00"</span><span class="token punctuation">,</span> <span class="token property">"to"</span><span class="token operator">:</span> <span class="token string">"2022-05-31 23:59:59"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">56</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-solution-licenses-csv-report" href="#get-solution-licenses-csv-report" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-solution-licenses-csv-report"><span class="icon icon-link"></span></a>Get Solution Licenses CSV Report</a></h3><p><code>GET /v2/partners/solutions/licenses/search/csv</code> - get CSV report for licenses.</p><h5 class="heading"><a id="headers-62" href="#headers-62" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-62"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="query-parameters-34" href="#query-parameters-34" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#query-parameters-34"><span class="icon icon-link"></span></a>Query Parameters</a></h5><ul><li><code>filters</code> - apply filters to narrow down the results (see below)</li></ul><p><strong>Note:</strong></p><ul><li><code>filters</code> is an array of objects, where each object has the following fields:<ul><li><code>field</code> - field name (one of: <code>license_product</code>, <code>license_status</code>, <code>license_details</code>, <code>license_created_at</code>, <code>payment_origin</code>, <code>credit_card</code>)</li><li><code>operator</code> - operator (one of: <code>equals</code>, <code>contains</code>, <code>exists</code>, <code>greater_or_equal</code>, <code>lesser_or_equal</code>)</li><li><code>value</code> - field value</li></ul></li><li>for example: <code>filters=[{"field": "license_product", "operator": "equals", "value": "LiveChat"}, {"field": "credit_card", "operator": "exists", "value": "no"}]</code></li></ul><h5 class="heading"><a id="response-64" href="#response-64" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-64"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, returns the data in CSV format, see the example below</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/licenses/search/csv?filters<span class="token operator">=</span><span class="token punctuation">[</span><span class="token punctuation">{</span><span class="token string">"field"</span><span class="token builtin class-name">:</span><span class="token string">"credit_card"</span>,<span class="token string">"value"</span><span class="token builtin class-name">:</span><span class="token string">"no"</span>,<span class="token string">"operator"</span><span class="token builtin class-name">:</span><span class="token string">"exists"</span><span class="token punctuation">}</span>,<span class="token punctuation">{</span><span class="token string">"field"</span><span class="token builtin class-name">:</span><span class="token string">"payment_origin"</span>,<span class="token string">"value"</span><span class="token builtin class-name">:</span><span class="token string">"partner"</span>,<span class="token string">"operator"</span><span class="token builtin class-name">:</span><span class="token string">"equals"</span><span class="token punctuation">}</span>,<span class="token punctuation">{</span><span class="token string">"field"</span><span class="token builtin class-name">:</span><span class="token string">"license_details"</span>,<span class="token string">"value"</span><span class="token builtin class-name">:</span><span class="token string">"Client Name"</span>,<span class="token string">"operator"</span><span class="token builtin class-name">:</span><span class="token string">"contains"</span><span class="token punctuation">}</span>,<span class="token punctuation">{</span><span class="token string">"field"</span><span class="token builtin class-name">:</span><span class="token string">"license_created_at"</span>,<span class="token string">"value"</span><span class="token builtin class-name">:</span><span class="token string">"2023-11-01 00:00:00"</span>,<span class="token string">"operator"</span><span class="token builtin class-name">:</span><span class="token string">"greater_or_equal"</span><span class="token punctuation">}</span><span class="token punctuation">]</span> <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json">License ID<span class="token punctuation">,</span>Managed by<span class="token punctuation">,</span>Status<span class="token punctuation">,</span>Client name<span class="token punctuation">,</span>Client email<span class="token punctuation">,</span>Client identifier<span class="token punctuation">,</span>Created<span class="token punctuation">,</span>Product<span class="token punctuation">,</span>Credit card<span class="token punctuation">,</span>Card problem<span class="token punctuation">,</span>Commission level<span class="token punctuation">,</span>Discount level<span class="token punctuation">,</span>Total earnings<span class="token punctuation">,</span>Total savings ExampleLicenseID<span class="token punctuation">,</span>partner<span class="token punctuation">,</span>trial<span class="token punctuation">,</span>Client Name<span class="token punctuation">,</span>client@test.com<span class="token punctuation">,</span>client-identifier<span class="token punctuation">,</span><span class="token number">2024</span><span class="token number">-01</span><span class="token number">-22</span> <span class="token number">08</span><span class="token operator">:</span><span class="token number">53</span><span class="token operator">:</span><span class="token number">53</span><span class="token punctuation">,</span>HelpDesk<span class="token punctuation">,</span>no<span class="token punctuation">,</span><span class="token punctuation">,</span><span class="token number">0.00</span><span class="token punctuation">,</span><span class="token number">20.00</span><span class="token punctuation">,</span><span class="token number">0.00</span><span class="token punctuation">,</span><span class="token number">0.00</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-leads" href="#get-leads" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-leads"><span class="icon icon-link"></span></a>Get Leads</a></h3><p><code>GET /v2/partners/solutions/leads</code> - get partner leads</p><h5 class="heading"><a id="headers-63" href="#headers-63" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-63"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-65" href="#response-65" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-65"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example below</li><li><code>400 - Bad Request</code></li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/leads <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"lead_id"</span><span class="token operator">:</span> <span class="token string">"123"</span><span class="token punctuation">,</span> <span class="token property">"company_name"</span><span class="token operator">:</span> <span class="token string">"company-123"</span><span class="token punctuation">,</span> <span class="token property">"contact_email"</span><span class="token operator">:</span> <span class="token string">"company-123@test.com"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"new"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"lead_id"</span><span class="token operator">:</span> <span class="token string">"456"</span><span class="token punctuation">,</span> <span class="token property">"company_name"</span><span class="token operator">:</span> <span class="token string">"company-456"</span><span class="token punctuation">,</span> <span class="token property">"contact_email"</span><span class="token operator">:</span> <span class="token string">"company-456@test.com"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"new"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-lead-details" href="#get-lead-details" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-lead-details"><span class="icon icon-link"></span></a>Get Lead Details</a></h3><p><code>GET /v2/partners/solutions/leads/{leadID}</code> - get lead details</p><h5 class="heading"><a id="headers-64" href="#headers-64" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-64"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-18" href="#path-parameters-18" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-18"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code>leadID</code> - lead ID</li></ul><h5 class="heading"><a id="response-66" href="#response-66" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-66"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example below</li><li><code>400 - Bad Request</code></li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/leads/123 <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"partner_id"</span><span class="token operator">:</span> <span class="token string">"partner-id-123"</span><span class="token punctuation">,</span> <span class="token property">"external_lead_id"</span><span class="token operator">:</span> <span class="token string">"123"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"new"</span><span class="token punctuation">,</span> <span class="token property">"fee_amount"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"company_name"</span><span class="token operator">:</span> <span class="token string">"lead-company-name"</span><span class="token punctuation">,</span> <span class="token property">"contact_email"</span><span class="token operator">:</span> <span class="token string">"contact@test.com"</span><span class="token punctuation">,</span> <span class="token property">"domain"</span><span class="token operator">:</span> <span class="token string">"www.company-test-123.com"</span><span class="token punctuation">,</span> <span class="token property">"first_name"</span><span class="token operator">:</span> <span class="token string">"name"</span><span class="token punctuation">,</span> <span class="token property">"last_name"</span><span class="token operator">:</span> <span class="token string">"last name"</span><span class="token punctuation">,</span> <span class="token property">"region"</span><span class="token operator">:</span> <span class="token string">"USA"</span><span class="token punctuation">,</span> <span class="token property">"job_title"</span><span class="token operator">:</span> <span class="token string">"job title"</span><span class="token punctuation">,</span> <span class="token property">"phone_number"</span><span class="token operator">:</span> <span class="token string">"123 456 789"</span><span class="token punctuation">,</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"updated_at"</span><span class="token operator">:</span> <span class="token string">"2023-10-02 15:44:59"</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-lead-history" href="#get-lead-history" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-lead-history"><span class="icon icon-link"></span></a>Get Lead History</a></h3><p><code>GET /v2/partners/solutions/leads/{leadID}/history</code> - get lead history</p><h5 class="heading"><a id="headers-65" href="#headers-65" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-65"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="path-parameters-19" href="#path-parameters-19" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#path-parameters-19"><span class="icon icon-link"></span></a>Path Parameters</a></h5><ul><li><code>leadID</code> - lead ID</li></ul><h5 class="heading"><a id="response-67" href="#response-67" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-67"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example below</li><li><code>400 - Bad Request</code></li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request GET <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/leads/123/history <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"lead_was_created"</span><span class="token punctuation">,</span> <span class="token property">"created_at"</span><span class="token operator">:</span> <span class="token string">"2023-09-18 11:17:35"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="submit-lead" href="#submit-lead" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#submit-lead"><span class="icon icon-link"></span></a>Submit Lead</a></h3><p><code>POST /v2/partners/solutions/leads</code> - submit lead</p><h5 class="heading"><a id="headers-66" href="#headers-66" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-66"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="body-12" href="#body-12" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-12"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>partner_name</code> - <strong>required</strong> - partner name</li><li><code>partner_email</code> - <strong>required</strong> - partner email</li><li><code>company_name</code> - <strong>required</strong> - lead company name</li><li><code>contact_email</code> - <strong>required</strong> - lead contact email</li><li><code>domain</code> - <strong>required</strong> - domain</li><li><code>first_name</code> - <strong>required</strong> - first name</li><li><code>last_name</code> - <strong>required</strong> - last name</li><li><code>region</code> - region</li><li><code>job_title</code> - job title</li><li><code>phone_number</code> - phone number</li><li><code>description</code> - description</li><li><code>sends_personal_introduction</code> - <code>boolean</code> value, set to <code>true</code> to send personal introduction</li><li><code>is_included_in_communication</code> - <code>boolean</code> value, set to <code>true</code> to be included in communication </li><li><code>accepts_requirements</code> - <strong>required</strong> - <code>boolean</code> value, set to <code>true</code> to accept requirements</li></ul><h5 class="heading"><a id="response-68" href="#response-68" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-68"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example below</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/leads <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"lead_id"</span><span class="token operator">:</span> <span class="token string">"123"</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-solution-summary" href="#get-solution-summary" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-solution-summary"><span class="icon icon-link"></span></a>Get Solution Summary</a></h3><p><code>POST /v2/partners/solutions/summary</code> - get summary from Solution Program</p><h5 class="heading"><a id="headers-67" href="#headers-67" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-67"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-69" href="#response-69" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-69"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example below</li><li><code>400 - Bad Request</code> - missing or incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">EXAMPLE REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> --request POST <span class="token punctuation">\</span> --url https://api.livechatinc.com/v2/partners/solutions/summary <span class="token punctuation">\</span> --header <span class="token string">'Authorization: Bearer <YOUR_API_TOKEN>'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"trials"</span><span class="token operator">:</span> <span class="token string">"12"</span> <span class="token property">"paid"</span><span class="token operator">:</span> <span class="token string">"14"</span> <span class="token property">"expired"</span><span class="token operator">:</span> <span class="token string">"13"</span> <span class="token property">"commission"</span><span class="token operator">:</span> <span class="token string">"12.33"</span> <span class="token property">"discount"</span><span class="token operator">:</span> <span class="token string">"34.11"</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><h2 class="heading css-1679d3t"><a id="expert" href="#expert" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#expert"><span class="icon icon-link"></span></a>Expert</a></h2><ul><li><a href="/docs/monetization/partner-program-api#upload-logo">Upload Logo</a></li><li><a href="/docs/monetization/partner-program-api#create-expert-profile">Create Expert Profile</a></li><li><a href="/docs/monetization/partner-program-api#get-expert-profile">Get Expert Profile</a></li><li><a href="/docs/monetization/partner-program-api#update-expert-profile">Update Expert Profile</a></li><li><a href="/docs/monetization/partner-program-api#get-comments">Get Comments</a></li><li><a href="/docs/monetization/partner-program-api#get-expert-stats">Get Expert Stats</a></li><li><a href="/docs/monetization/partner-program-api#get-expert-history">Get Expert History</a></li></ul><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="upload-logo" href="#upload-logo" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#upload-logo"><span class="icon icon-link"></span></a>Upload Logo</a></h3><p><code>POST /v2/partners/experts/profile/logo</code> - upload the Expert logo</p><h5 class="heading"><a id="headers-68" href="#headers-68" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-68"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="body-13" href="#body-13" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-13"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>.jpg</code> or <code>.png</code> image, min. 350x350px, max. 1000x1000px - <strong>required</strong></li></ul><h5 class="heading"><a id="response-70" href="#response-70" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-70"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>400 - Bad Request</code> - an incorrect file</li><li><code>403 - Forbidden</code> - a missing or incorrect authorization token</li></ul></div><div class="css-17buymi"><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token string">"https://cdn.example.com/expert-logo.png"</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="create-expert-profile" href="#create-expert-profile" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#create-expert-profile"><span class="icon icon-link"></span></a>Create Expert Profile</a></h3><p><code>POST /v2/partners/experts/profile</code> - create the Expert profile</p><h5 class="heading"><a id="headers-69" href="#headers-69" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-69"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="body-14" href="#body-14" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-14"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>company</code> - <strong>required</strong> - company name (min. 4 characters)</li><li><code>phone</code> - <strong>required</strong> - phone number</li><li><code>description</code> - <strong>required</strong> - the description dispalyed in the profile details (min. 10 characters)</li><li><code>short_description</code> - <strong>required</strong> - the description displayed in the Expert tile (min. 10 characters)</li><li><code>country</code> - <strong>required</strong> - country code, one of <a href="https://api.livechatinc.com/v2/partners/data/countries">these</a></li><li><code>website</code> - <strong>required</strong> - website URL</li><li><code>categories</code> - <strong>required</strong> - an array of categories (codes); <a href="https://api.livechatinc.com/v2/partners/data/categories/expert">available categories</a></li><li><code>projects</code> - <strong>required</strong> - an array of projects (URLs)</li><li><code>agents</code> - <strong>required</strong> if one of the categories is <code>outsourcing-customer-service</code> or <code>lead-generation</code> - number of agents, accepted values: <code>1-5</code>, <code>6-15</code>, <code>16-30</code>, <code>31-50</code>, <code>51+</code></li><li><code>languages</code> - <strong>required</strong> if one of the categories is <code>outsourcing-customer-service</code> or <code>lead-generation</code> - an array of languages (codes); <a href="https://api.livechatinc.com/v2/partners/data/languages">available languages</a></li><li><code>hour_rate</code> - optional - minimum hourly rate</li><li><code>project_rate</code> - optional - minimum project rate</li><li><code>facebook</code> - optional - the URL to the Facebook page</li><li><code>twitter</code> - optional - the URL to the Twitter page</li><li><code>linkedin</code> - optional - the URL to the LinkedIn page</li><li><code>googleplus</code> - optional - the URL to the LinkedIn page</li></ul><h5 class="heading"><a id="response-71" href="#response-71" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-71"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>201 - Created</code></li><li><code>400 - Bad Request</code> - incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>403 - Forbidden</code> - missing logo</li></ul></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-expert-profile" href="#get-expert-profile" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-expert-profile"><span class="icon icon-link"></span></a>Get Expert Profile</a></h3><p><code>GET /v2/partners/experts/profile</code> - get the Expert profile details</p><h5 class="heading"><a id="headers-70" href="#headers-70" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-70"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-72" href="#response-72" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-72"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>403 - Forbidden</code> - Partner is not an Expert</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li></ul></div><div class="css-17buymi"><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"expert_id"</span><span class="token operator">:</span> <span class="token string">"acme"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"verified"</span><span class="token punctuation">,</span> <span class="token property">"company"</span><span class="token operator">:</span> <span class="token string">"ACME"</span><span class="token punctuation">,</span> <span class="token property">"phone"</span><span class="token operator">:</span> <span class="token string">"123456789"</span><span class="token punctuation">,</span> <span class="token property">"logo"</span><span class="token operator">:</span> <span class="token string">"https://cdn.example.com/expert-logo.png"</span><span class="token punctuation">,</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"long description goes here"</span><span class="token punctuation">,</span> <span class="token property">"short_description"</span><span class="token operator">:</span> <span class="token string">"short description (visible in Marketplace tile)"</span><span class="token punctuation">,</span> <span class="token property">"agents"</span><span class="token operator">:</span> <span class="token string">"5+"</span><span class="token punctuation">,</span> <span class="token property">"hour_rate"</span><span class="token operator">:</span> <span class="token string">"50"</span><span class="token punctuation">,</span> <span class="token property">"project_rate"</span><span class="token operator">:</span> <span class="token string">"500"</span><span class="token punctuation">,</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"US"</span><span class="token punctuation">,</span> <span class="token property">"website"</span><span class="token operator">:</span> <span class="token string">"https://partners.livechatinc.com"</span><span class="token punctuation">,</span> <span class="token property">"facebook"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"twitter"</span><span class="token operator">:</span> <span class="token string">"https://twitter/LiveChatProgram"</span><span class="token punctuation">,</span> <span class="token property">"linkedin"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"googleplus"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"categories"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"api-and-integrations"</span><span class="token punctuation">,</span> <span class="token string">"chat-customization"</span><span class="token punctuation">,</span> <span class="token string">"chat-strategy-consultancy"</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"languages"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"EN"</span><span class="token punctuation">,</span> <span class="token string">"ES"</span><span class="token punctuation">,</span> <span class="token string">"PL"</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"projects"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"https://example.com"</span><span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="update-expert-profile" href="#update-expert-profile" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#update-expert-profile"><span class="icon icon-link"></span></a>Update Expert Profile</a></h3><p><code>PUT /v2/partners/experts/profile</code> - update the Expert profile details</p><h5 class="heading"><a id="headers-71" href="#headers-71" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-71"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="body-15" href="#body-15" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#body-15"><span class="icon icon-link"></span></a>Body</a></h5><ul><li><code>company</code> - <strong>required</strong> - company name (min. 4 characters)</li><li><code>phone</code> - <strong>required</strong> - phone number</li><li><code>description</code> - <strong>required</strong> - the description displayed in profile details (min. 10 characters)</li><li><code>short_description</code> - <strong>required</strong> - the description displayed in Expert tile (min. 10 characters)</li><li><code>country</code> - <strong>required</strong> - country code, one of <a href="https://api.livechatinc.com/v2/partners/data/countries">these</a></li><li><code>website</code> - <strong>required</strong> - website URL</li><li><code>categories</code> - <strong>required</strong> - array of categories (codes); <a href="https://api.livechatinc.com/v2/partners/data/categories/expert">available categories</a></li><li><code>projects</code> - <strong>required</strong> - array of projects (URLs)</li><li><code>agents</code> - <strong>required</strong> if one of the categories is <code>outsourcing-customer-service</code> or <code>lead-generation</code> - number of agents, accepted values: <code>1-5</code>, <code>6-15</code>, <code>16-30</code>, <code>31-50</code>, <code>51+</code></li><li><code>languages</code> - <strong>required</strong> if one of the categories is <code>outsourcing-customer-service</code> or <code>lead-generation</code> - an array of languages (codes); <a href="https://api.livechatinc.com/v2/partners/data/languages">available languages</a></li><li><code>hour_rate</code> - optional - minimum hourly rate</li><li><code>project_rate</code> - optional - minimum project rate</li><li><code>facebook</code> - optional - the URL to the Facebook page</li><li><code>twitter</code> - optional - the URL to the Twitter page</li><li><code>linkedin</code> - optional - the URL to the LinkedIn page</li><li><code>googleplus</code> - optional - the URL to the LinkedIn page</li></ul><h5 class="heading"><a id="response-73" href="#response-73" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-73"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>204 - No Content</code></li><li><code>400 - Bad Request</code> - incorrect parameters</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>403 - Forbidden</code> - missing logo</li></ul></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-comments" href="#get-comments" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-comments"><span class="icon icon-link"></span></a>Get Comments</a></h3><p><code>GET /v2/partners/experts/comments</code> - get comments on the Expert profile</p><h5 class="heading"><a id="headers-72" href="#headers-72" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-72"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-74" href="#response-74" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-74"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>403 - Forbidden</code> - Partner is not an Expert</li></ul></div><div class="css-17buymi"><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"comment"</span><span class="token operator">:</span> <span class="token string">"This Expert provides a valuable tool to any online business. Very impressed with the speed at which chats are answered and the professional yet personal touch with which they approach each chat."</span><span class="token punctuation">,</span> <span class="token property">"author"</span><span class="token operator">:</span> <span class="token string">"Joe"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-03-06 10:21:50"</span><span class="token punctuation">,</span> <span class="token property">"website"</span><span class="token operator">:</span> <span class="token string">"https://example.com"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"comment"</span><span class="token operator">:</span> <span class="token string">"Great company and great people. They have helped train the team and get the most out of the chat system. Inbounds have increased and process has improved. The product itself is very easy to use. A brilliant service end to end."</span><span class="token punctuation">,</span> <span class="token property">"author"</span><span class="token operator">:</span> <span class="token string">"Jane"</span><span class="token punctuation">,</span> <span class="token property">"creation_timestamp"</span><span class="token operator">:</span> <span class="token string">"2018-02-22 13:32:28"</span><span class="token punctuation">,</span> <span class="token property">"website"</span><span class="token operator">:</span> <span class="token string">""</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-expert-stats" href="#get-expert-stats" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-expert-stats"><span class="icon icon-link"></span></a>Get Expert Stats</a></h3><p><code>GET /v2/partners/experts/stats</code> - get stats (<a href="https://www.livechat.com/marketplace/experts/">Experts Marketplace</a> position, number of comments and messages) for Expert profile</p><h5 class="heading"><a id="headers-73" href="#headers-73" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-73"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-75" href="#response-75" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-75"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>403 - Forbidden</code> - Partner is not an Expert</li></ul></div><div class="css-17buymi"><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"position"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"comments"</span><span class="token operator">:</span> <span class="token number">18</span><span class="token punctuation">,</span> <span class="token property">"messages"</span><span class="token operator">:</span> <span class="token number">132</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="get-expert-history" href="#get-expert-history" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#get-expert-history"><span class="icon icon-link"></span></a>Get Expert History</a></h3><p><code>GET /v2/partners/experts/history</code> - get historical stats for the Expert profile views (up to last 12 months)</p><h5 class="heading"><a id="headers-74" href="#headers-74" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#headers-74"><span class="icon icon-link"></span></a>Headers</a></h5><ul><li><code>Authorization</code> - <strong>required</strong> - <code>Bearer <YOUR_API_TOKEN></code></li></ul><h5 class="heading"><a id="response-76" href="#response-76" class="reference css-180507a"><a href="/docs/monetization/partner-program-api#response-76"><span class="icon icon-link"></span></a>Response</a></h5><ul><li><code>200 - OK</code> - success, see the example on the right</li><li><code>401 - Unauthorized</code> - a missing or incorrect authorization header</li><li><code>403 - Forbidden</code> - Partner is not an Expert</li></ul></div><div class="css-17buymi"><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">EXAMPLE RESPONSE - 200</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2018-03"</span><span class="token punctuation">,</span> <span class="token property">"profile_views"</span><span class="token operator">:</span> <span class="token number">123</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2018-02"</span><span class="token punctuation">,</span> <span class="token property">"profile_views"</span><span class="token operator">:</span> <span class="token number">212</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2018-01"</span><span class="token punctuation">,</span> <span class="token property">"profile_views"</span><span class="token operator">:</span> <span class="token number">286</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><style data-emotion-css="1fsewzh">.css-1fsewzh{margin-top:50px;}.css-1fsewzh > label{margin:0 0 5px 0;}.css-1fsewzh label + div{-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;}</style></article></div><p>...</p></div><style data-emotion-css="1mpu5jj">.css-1mpu5jj{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:space-evenly;-webkit-justify-content:space-evenly;-ms-flex-pack:space-evenly;justify-content:space-evenly;-webkit-align-items:start;-webkit-box-align:start;-ms-flex-align:start;align-items:start;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap;background-color:#f6f6f7;color:#424d57;min-height:248px;margin-bottom:45px;}@media (min-width:768px){.css-1mpu5jj{margin-bottom:0px;}}</style><div class="css-1mpu5jj"><style data-emotion-css="dtzkur">.css-dtzkur{width:100%;padding:20px;}@media (min-width:768px){.css-dtzkur{margin-top:75px;padding:0;width:160px;}}</style><div class="css-dtzkur"><style data-emotion-css="r8rj3w">.css-r8rj3w{font-weight:600;font-size:16px;line-height:24px;color:#424d57;}</style><div class="css-r8rj3w">Join the community</div><style data-emotion-css="1ws0nkq">.css-1ws0nkq{font-weight:400;font-size:12px;line-height:20px;color:#424d57;}</style><div class="css-1ws0nkq">Get in direct contact with us through Discord.</div><style data-emotion-css="652pjx">.css-652pjx:hover{-webkit-text-decoration:none;text-decoration:none;}</style><a href="https://discord.gg/MGFyhbdFxt" target="_blank" rel="noopener noreferrer" class="css-652pjx"><style data-emotion-css="y77wuh">.css-y77wuh{margin-top:5px;}</style><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="20" height="16" viewBox="0 0 20 16" fill="none" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#clip0_613_10386)"><path d="M16.9308 1.63294C15.6561 1.04804 14.2892 0.617109 12.8599 0.370298C12.8339 0.365535 12.8079 0.377439 12.7945 0.401247C12.6187 0.713926 12.4239 1.12184 12.2876 1.44246C10.7503 1.21232 9.22099 1.21232 7.71527 1.44246C7.57887 1.11471 7.37707 0.713926 7.20048 0.401247C7.18707 0.378233 7.16107 0.366329 7.13504 0.370298C5.70659 0.616321 4.33963 1.04725 3.06411 1.63294C3.05307 1.6377 3.04361 1.64564 3.03732 1.65595C0.444493 5.52959 -0.265792 9.30801 0.0826501 13.0396C0.0842267 13.0578 0.0944749 13.0753 0.108665 13.0864C1.81934 14.3427 3.47642 15.1054 5.10273 15.6109C5.12876 15.6188 5.15634 15.6093 5.1729 15.5879C5.55761 15.0625 5.90054 14.5086 6.19456 13.926C6.21192 13.8919 6.19535 13.8514 6.15989 13.838C5.61594 13.6316 5.098 13.38 4.59977 13.0943C4.56037 13.0713 4.55721 13.015 4.59347 12.988C4.69831 12.9094 4.80318 12.8277 4.9033 12.7451C4.92141 12.7301 4.94665 12.7269 4.96794 12.7364C8.24107 14.2308 11.7846 14.2308 15.0191 12.7364C15.0404 12.7261 15.0657 12.7293 15.0846 12.7443C15.1847 12.8269 15.2895 12.9094 15.3952 12.988C15.4314 13.015 15.4291 13.0713 15.3897 13.0943C14.8914 13.3856 14.3735 13.6316 13.8288 13.8372C13.7933 13.8507 13.7775 13.8919 13.7949 13.926C14.0952 14.5078 14.4381 15.0617 14.8157 15.5871C14.8315 15.6093 14.8599 15.6188 14.8859 15.6109C16.5201 15.1054 18.1772 14.3427 19.8879 13.0864C19.9028 13.0753 19.9123 13.0586 19.9139 13.0404C20.3309 8.72626 19.2154 4.97883 16.9568 1.65674C16.9513 1.64564 16.9419 1.6377 16.9308 1.63294ZM6.68335 10.7674C5.69792 10.7674 4.88594 9.86274 4.88594 8.75167C4.88594 7.6406 5.68217 6.7359 6.68335 6.7359C7.69239 6.7359 8.49651 7.64855 8.48073 8.75167C8.48073 9.86274 7.68451 10.7674 6.68335 10.7674ZM13.329 10.7674C12.3435 10.7674 11.5316 9.86274 11.5316 8.75167C11.5316 7.6406 12.3278 6.7359 13.329 6.7359C14.338 6.7359 15.1421 7.64855 15.1264 8.75167C15.1264 9.86274 14.338 10.7674 13.329 10.7674Z" fill="#424D57"></path></g><defs><clipPath id="clip0_613_10386"><rect width="20" height="15.493" fill="white" transform="translate(0 0.25354)"></rect></clipPath></defs></svg></i><div>Discord</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Follow us</div><div class="css-1ws0nkq">Follow our insightful tweets and interact with our content.</div><a href="https://twitter.com/TextPlatform" target="_blank" rel="noopener noreferrer" class="css-652pjx"><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="24" height="24" class="rmi rmi-twitter undefined" viewBox="0 0 24 24"><path d="M22.46 6c-.77.35-1.6.58-2.46.69.88-.53 1.56-1.37 1.88-2.38-.83.5-1.75.85-2.72 1.05C18.37 4.5 17.26 4 16 4c-2.35 0-4.27 1.92-4.27 4.29 0 .34.04.67.11.98C8.28 9.09 5.11 7.38 3 4.79c-.37.63-.58 1.37-.58 2.15 0 1.49.75 2.81 1.91 3.56-.71 0-1.37-.2-1.95-.5v.03c0 2.08 1.48 3.82 3.44 4.21a4.22 4.22 0 0 1-1.93.07 4.28 4.28 0 0 0 4 2.98 8.521 8.521 0 0 1-5.33 1.84c-.34 0-.68-.02-1.02-.06C3.44 20.29 5.7 21 8.12 21 16 21 20.33 14.46 20.33 8.79c0-.19 0-.37-.01-.56.84-.6 1.56-1.36 2.14-2.23z"></path></svg></i><div>Twitter</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Contribute</div><div class="css-1ws0nkq">See something that's wrong or unclear? Submit a pull request.</div><a href="https://github.com/livechat/livechat-public-docs" target="_blank" rel="noopener noreferrer" class="css-652pjx"><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="24" height="24" class="rmi rmi-github undefined" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2z"></path></svg></i><div>GitHub</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Contact us</div><div class="css-1ws0nkq">Want to share feedback? Reach us at: <a href="mailto:developers@text.com">developers@text.com</a></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{}},"page":"/monetization/partner-program-api","query":{},"buildId":"mT926s0W5VyhfFaApGsyO","assetPrefix":"/docs","runtimeConfig":{},"nextExport":true,"autoExport":true,"isFallback":false}</script><script nomodule="" src="/docs/_next/static/chunks/polyfills-c2dc1d9251306528e50c.js"></script><script src="/docs/_next/static/chunks/webpack-af19fbe32e13fc779465.js" async=""></script><script src="/docs/_next/static/chunks/framework.57a22ac5870571c2eff5.js" async=""></script><script src="/docs/_next/static/chunks/commons.0889bf71124535c6c4cd.js" async=""></script><script src="/docs/_next/static/chunks/main-7bb61c4f8d40f1e634e9.js" async=""></script><script src="/docs/_next/static/chunks/pages/_app-cdbe91fdfdbd305577ef.js" async=""></script><script src="/docs/_next/static/chunks/f66b9295.f9eceaafe4216b86326e.js" async=""></script><script src="/docs/_next/static/chunks/b31dc3a52fd33fe1943f491eae223576a0413e10.ac30430b2138b8fefed8.js" async=""></script><script src="/docs/_next/static/chunks/067aff065064306958fa97cea949633bebf95d70.dede6f8249fbb82aff52.js" async=""></script><script src="/docs/_next/static/chunks/pages/monetization/partner-program-api-a4d20582b6fc3c5898db.js" async=""></script><script src="/docs/_next/static/mT926s0W5VyhfFaApGsyO/_buildManifest.js" async=""></script><script src="/docs/_next/static/mT926s0W5VyhfFaApGsyO/_ssgManifest.js" async=""></script></body></html>