Square Online API

Platform fees

A call that renders the page in a browser adds the browser fee to the route price: routes with render mode js, routes with render mode auto when the call switches to the browser (pre-charged, refunded when it does not), and calls sent with `X-ApiClay-Render: js`.

ApiClay proxy paid by the vendor: GET /stores (data cap 2 MB per call), GET /menus (data cap 2 MB per call), GET /products (data cap 2 MB per call), GET /customizations (data cap 2 MB per call), GET /availability (data cap 2 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

Trial and plan requests still pay the browser, CAPTCHA and ApiClay proxy fees. The response headers state each charge and how many attempts the call took: X-ApiClay-Browser-Fee (credits charged for rendering the call in a browser), X-ApiClay-Captcha-Fee (credits charged for the CAPTCHAs solved during the call (the CAPTCHA fee once per solve)), X-ApiClay-Captcha-Solves (number of CAPTCHAs solved and charged), X-ApiClay-Proxy-Fee (credits charged for the data of an ApiClay proxy you chose), X-ApiClay-Data-Bytes (bytes of ApiClay proxy data you were charged for (the data in X-ApiClay-Proxy-Fee)), X-ApiClay-Proxy-Fallback ("used" when the vendor's proxy was used up or failed and the one retry through an ApiClay proxy succeeded (its data, charged only then, is in X-ApiClay-Proxy-Fee)), X-ApiClay-Attempts (how many attempts the call took).