Learn about the current status of deprecated Square APIs.
Migrate from Deprecated APIs

Current Status of Deprecated API Objects

Square API and Connect v1 API endpoints and fields can be deprecated, retired, and replaced by improved functionality provided by new replacement endpoints and fields. The Square developer platform keeps these code breaking changes to a minimum and only makes them when a critical new feature requires such a change. When an API object is deprecated and scheduled to be retired, Square provides a migration guide to give developers step-by-step guidance to update their code to use replacement objects.

The following endpoints are deprecated and currently scheduled for retirement, but the associated APIs are still generally available. For more information, see the associated migration guide or relevant Technical Reference entry.

Endpoint nameReplacementDeprecatedRetirement
RenewTokenOAuth.ObtainToken
Migration guide
2021-05-132022-05-13
ListEmployeesListTeamMembers
Migration Guide
2020-08-262021-08-26
RetrieveEmployeeRetrieveEmployee
Migration Guide
2020-08-262021-08-26
ListEmployeeWagesListTeamMemberWages
Migration Guide
2020-08-262021-08-26
GetEmployeeWageGetTeamMemberWage
Migration Guide
2020-08-262021-08-26
ListLoyaltyProgramsRetrieveLoyaltyProgram
Migration Guide
2021-05-13TBD
CreateCustomerCardCreateCard or LinkCustomerToGiftCard
Migration Guide
2021-06-16TBD
DeleteCustomerCardDisableCard or UnlinkCustomerFromGiftCard
Migration Guide
2021-06-16TBD
ListSettlementsListPayouts
Migration Guide
2019-11-152023-06-16
RetrieveSettlementGetPayout or ListPayoutEntries
Migration Guide
2019-11-152023-06-16
CreateCheckoutCreatePaymentLink
Migration Guide
2022-08-172023-04-02

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