The Square Ruby library supports Square APIs in a language-idiomatic way that reduces complexity without sacrificing API functionality.
Latest SDK Version: 44.0.0.20250820
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 44.0.0.20250820 of the Ruby SDK represents a full rewrite of the SDK, with a number of breaking changes, outlined in the following sections. When upgrading to this version or later versions, take note of the changes in the SDK, including client construction and parameter names. If necessary, you can use the legacy version of the SDK along with the latest version.
SDK versions 43.0.1.20250716 and earlier continue to function as expected, but you should plan to update your integration as soon as possible to ensure continued support.
To install the Square Ruby SDK, use the gem command:
gem install square.rb