Migrate from Deprecated APIs
Learn about the Square API retirement process and view migration guides for specific deprecated APIs.
Current status
Deprecated
The following endpoints are currently deprecated and scheduled to be retired as noted.
Collection | Replacements | Deprecation | Retirement |
|---|---|---|---|
| V2 Employees | Team API Migration guide | 2020-08-26 | 2021-09-15 |
| V2 Transactions | Payments API Migration guide | 2019-08-15 | TBD |
Retired
The following 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 |
|---|---|---|---|
| V1 Employees.Employees | Team API Migration guide | 2020-08-26 | 2021-09-15 |
| V1 Employees.EmployeeRoles | Team API Migration guide | 2020-08-26 | 2021-09-15 |
| V1 Employees.Timecards | Labor API Migration guide | 2020-02-26 | 2021-02-26 |
| V1 Employees.CashDrawers | Cash Drawers API Migration guide | 2020-02-26 | 2021-02-26 |
| V1Items | Catalog API Inventory API Migration guide | 2019-11-20 | 2021-02-26 |
| V1 Locations | Locations API Migration guide | 2019-11-20 | 2020-11-18 |
| V1 Transactions.BankAccounts | Bank Accounts API Migration guide | 2020-02-26 | 2021-02-26 |
| V2 Reporting | Payments API Migration guide | 2019-08-15 | 2020-08-26 |
Work in progress
The following endpoints will be deprecated when corresponding functionality is available in the Square API.
Collection | Replacements | Deprecation | Retirement |
|---|---|---|---|
| V1 Batching | Various Migration guide | 2019-11-20 | TBD |
| V1 Transactions.Payments | pending | TBD | TBD |
| V1 Transactions.Refunds | pending | TBD | TBD |
| V1 Transactions.Settlements | pending | TBD | TBD |
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.
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?
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.
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.