Migrate from Deprecated APIs

Learn about the Square developer platform retirement process and view migration guides for specific deprecated APIs.

Current status

Deprecated

The following Connect v1 and Square endpoints are currently deprecated and scheduled to be retired as noted.

Retired

The following Connect v1 and Square endpoints have been retired and are no longer supported by documentation. If you have not migrated your code to use Square API endpoints, refer to the migration guides in the table to learn about the needed migrations.

Work in progress

The following Connect v1 endpoints will be deprecated when corresponding functionality is available in the Square API.

Why is Square retiring Connect v1?

The Connect v1 APIs were introduced in 2014. Since then, Square has collected developer feedback which is used to build more robust APIs. The result is an improved Square API data model that supports versioning, lays the foundation for a unified development platform, and establishes scalable patterns for future functionality.

Retiring the Connect v1 APIs allows Square to expand interoperability with first-party and third-party products, implement consistent versioning policies, and support regular iteration on functionality in response to developer feedback.

What will happen?

As gaps between the Square API model and Connect v1 are filled, the corresponding Connect v1 APIs are deprecated. Square strongly recommends against using Connect v1 APIs for new applications. Deprecated endpoints are clearly flagged in the Technical Reference and Square provides migration guides for affected developers.

When will my code break?

Connect v1 APIs are being deprecated as their replacements become publicly available. When a given API is deprecated, existing users have 12 months to update their code before the functionality is retired and permanently disabled. For more information about how Square handles API deprecation and retirement, see Square API Lifecycle .

Where can I get help?

If you have questions about Connect v1 retirement or need help migrating to the Square API model, contact Developer Support, join our Slack, or reach out to your Square Account Manager.

How do I update my code?

Consult the following Connect v1 migration guides to update your application:

• Connect v1 Items API

• Connect v1 Locations API

• Connect v1 Timecards API

• Connect v1 CashDrawerShifts API

• Connect v1 BankAccounts API

What happens if I call an API after the retired date?

Your code will break.

Retired functionality cannot be used, regardless of the Square-Version provided during the API call. Square SDKs released on or after the retirement date do not include retired features and REST calls that attempt to use retired functionality return errors.