Migrate from Deprecated APIs
This topic lists the APIs in the Square Developer Platform that are deprecated and scheduled for retirement. For information about the path from API deprecation to retirement, see Square API Lifecycle.
The following Square APIs and Connect v1 APIs are deprecated and scheduled for retirement or retired and no longer supported. For general information that applies when migrating from Connect v1 APIs to Square APIs, see General Guidance for Migrating from Connect v1 APIs. For detailed guidance about migrating your code to use the replacement Square API, refer to the migration guide provided in the table for the deprecated API.
The following Square APIs are deprecated.
| API | Replacement | Deprecation | Retirement |
|---|---|---|---|
| Transactions | Payments API Migration guide | 2019-08-15 | TBD |
The following Connect v1 APIs are deprecated.
| API | Replacement | Deprecation | Retirement |
|---|---|---|---|
| Transactions.Payments | Payments API Migration guide | 2021-05-13 | 2023-06-20 |
| Transactions.Refunds | Refunds API Migration guide | 2021-05-13 | 2023-06-20 |
| Transactions.Settlements | Payouts API Migration guide | 2022-04-20 | 2023-06-20 |
| Batching | Various Migration guide | 2019-11-20 | TBD |
The following Square APIs are retired.
| API | Replacement | Deprecation | Retirement |
|---|---|---|---|
| Employees | Team API Migration guide | 2020-08-26 | 2021-09-15 |
| Reporting | Payments API Migration guide | 2019-08-15 | 2020-08-26 |
The following Connect v1 APIs are retired.
| API | Replacement | Deprecation | Retirement |
|---|---|---|---|
| Employees.Employees | Team API | 2020-08-26 | 2021-09-15 |
| Employees.EmployeeRoles | Team API | 2020-08-26 | 2021-09-15 |
| Employees.Timecards | Labor API | 2020-02-26 | 2021-02-26 |
| Employees.CashDrawers | Cash Drawers API | 2020-02-26 | 2021-02-26 |
| Items | Catalog API Inventory API | 2019-11-20 | 2021-02-26 |
| Locations | Locations API | 2019-11-20 | 2020-11-18 |
| Transactions.BankAccounts | Bank Accounts API | 2020-02-26 | 2021-02-26 |
Note
The preceding tables lists API sets that are deprecated or retired. The Square Development Platform also includes deprecated endpoints and deprecated objects, fields, enums, and values.
If you have questions or need help migrating from deprecated APIs, contact Developer Support, join our Discord community, or reach out to your Square account manager.
Your code will break.
Retired functionality cannot be used, regardless of the Square-Version provided during the API call. REST calls that attempt to use retired functionality return errors. Square SDKs released on or after retirement don't include retired features.
If you need more assistance, contact Developer Support or ask for help in the Developer Forums.