Migrate from Deprecated APIs

Migrate from Deprecated APIs

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

Current status Permalink Get a link to this section

Deprecated Permalink Get a link to this section

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

Collection
Replacements
Deprecation
Retirement
Square API Employees Team API
Migration guide
2020-08-262021-09-15
Square API Transactions Payments API
Migration guide
2019-08-15TBD
Connect v1 Transactions.Payments Payments Migration Guide 2021-05-13TBD
Connect v1 Transactions.Refunds Refunds Migration Guide 2021-05-13TBD

Retired Permalink Get a link to this section

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.

Collection
Replacements
Deprecation
Retirement
Connect v1 Employees.Employees Team API
Migration guide
2020-08-262021-09-15
Connect v1 Employees.EmployeeRoles Team API
Migration guide
2020-08-262021-09-15
Connect v1 Employees.Timecards Labor API
Migration guide
2020-02-262021-02-26
Connect v1 Employees.CashDrawers Cash Drawers API
Migration guide
2020-02-262021-02-26
Connect v1 Items Catalog API
Inventory API
Migration guide
2019-11-202021-02-26
Connect v1 Locations Locations API
Migration guide
2019-11-202020-11-18
Connect v1 Transactions.BankAccounts Bank Accounts API
Migration guide
2020-02-262021-02-26
Square API Reporting Payments API
Migration guide
2019-08-152020-08-26

Work in progress Permalink Get a link to this section

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

Collection
Replacements
Deprecation
Retirement
Connect v1 BatchingVarious
Migration guide
2019-11-20TBD
Connect v1 Transactions.SettlementspendingTBDTBD

Why is Square retiring Connect v1? Permalink Get a link to this section

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? Permalink Get a link to this section

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.

Important

Some Connect v1 functionality is not implemented in the Square API due to low usage. Where possible, the applicable migration guide provides an alternative approach.

When will my code break? Permalink Get a link to this section

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? Permalink Get a link to this section

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.

What happens if I call an API after the retired date? Permalink Get a link to this section

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.

If you need more assistance, contact Developer Support or ask for help in the Developer Forums.