Migrate from Deprecated APIs
Learn about the Square Developer Platform retirement process and view migration guides for specific deprecated APIs.
The following Connect v1 and Square endpoints are currently deprecated and scheduled to be retired as noted.
Collection | Replacements | Deprecation | Retirement |
|---|---|---|---|
| Square API Transactions | Payments API Migration guide | 2019-08-15 | TBD |
| Connect v1 Transactions.Payments | Payments Migration Guide | 2021-05-13 | 2023-06-20 |
| Connect v1 Transactions.Refunds | Refunds Migration Guide | 2021-05-13 | 2023-06-20 |
| Connect v1 Transactions.Settlements | Payouts API Migration guide | 2022-04-20 | 2023-06-20 |
The following Connect v1 and Square endpoints have been retired and are no longer supported by documentation. If you haven't 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 |
|---|---|---|---|
| Square API Employees | Team API Migration guide | 2020-08-26 | 2021-09-15 |
| Connect v1 Employees.Employees | Team API | 2020-08-26 | 2021-09-15 |
| Connect v1 Employees.EmployeeRoles | Team API | 2020-08-26 | 2021-09-15 |
| Connect v1 Employees.Timecards | Labor API | 2020-02-26 | 2021-02-26 |
| Connect v1 Employees.CashDrawers | Cash Drawers API | 2020-02-26 | 2021-02-26 |
| Connect v1 Items | Catalog API Inventory API | 2019-11-20 | 2021-02-26 |
| Connect v1 Locations | Locations API | 2019-11-20 | 2020-11-18 |
| Connect v1 Transactions.BankAccounts | Bank Accounts API | 2020-02-26 | 2021-02-26 |
| Square API Reporting | Payments API Migration guide | 2019-08-15 | 2020-08-26 |
The following Connect v1 endpoints will be deprecated when corresponding functionality is available in the Square API.
Collection | Replacements | Deprecation | Retirement |
|---|---|---|---|
| Connect v1 Batching | Various Migration guide | 2019-11-20 | TBD |
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 Square and partner developer products, implement consistent versioning policies, and support regular iteration on functionality in response to developer feedback.
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 isn't implemented in the Square API due to low usage. Where possible, the applicable migration guide provides an alternative approach.
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.
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.
Your code will break.
Retired functionality can't be used, regardless of the Square-Version provided during the API call. Square SDKs released on or after the retirement date don't 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.