Node.js SDK

The Square Node.js library supports Square APIs in a language-idiomatic way that reduces complexity without sacrificing API functionality.


Latest SDK Version: 40.0.0

Each SDK version is tied to a specific Square API version. As features are added, Square releases a new Square API version and a new SDK version. To use new features, you must update the SDK version in your application. Review the release notes to learn about changes in each API version.

An increase in the SDK major version number indicates a breaking change. You should always test your application before deploying a change to production.

Important

Version 40.0.0 of the Node.js SDK represents a full rewrite of the SDK, with a number of breaking changes, including client construction and parameter names. When upgrading from version 39.1.0 or earlier, read the migration guide to learn what to update and how to use the new SDK and the legacy version side by side.

Link to section

Installation

Install the latest version with your choice of package manager.

npm install square
Link to section

Quickstart

  • Follow along with the Quickstart guide to set up and test the Square Node.js SDK in your own project.