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.

Link to section

Current status

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.

Link to section

Deprecated

The following Square APIs are deprecated.

APIReplacementDeprecationRetirement
TransactionsPayments API
Migration guide
2019-08-15TBD

The following Connect v1 APIs are deprecated.

APIReplacementDeprecationRetirement
Transactions.PaymentsPayments API
Migration guide
2021-05-132023-06-20
Transactions.RefundsRefunds API
Migration guide
2021-05-132023-06-20
Transactions.SettlementsPayouts API
Migration guide
2022-04-202023-06-20
BatchingVarious
Migration guide
2019-11-20TBD
Link to section

Retired

The following Square APIs are retired.

APIReplacementDeprecationRetirement
EmployeesTeam API
Migration guide
2020-08-262021-09-15
ReportingPayments API
Migration guide
2019-08-152020-08-26

The following Connect v1 APIs are retired.

APIReplacementDeprecationRetirement
Employees.EmployeesTeam API2020-08-262021-09-15
Employees.EmployeeRolesTeam API2020-08-262021-09-15
Employees.TimecardsLabor API2020-02-262021-02-26
Employees.CashDrawersCash Drawers API2020-02-262021-02-26
ItemsCatalog API
Inventory API
2019-11-202021-02-26
LocationsLocations API2019-11-202020-11-18
Transactions.BankAccountsBank Accounts API2020-02-262021-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.

Link to section

Where can I get help?

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.

Link to section

What happens if I call an API after retirement?

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.