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.
Deprecated endpoints
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 name | Replacement | Deprecated | Retirement |
|---|---|---|---|
| RenewToken | OAuth.ObtainToken Migration guide | 2021-05-13 | 2022-05-13 |
| ListEmployeeWages | ListTeamMemberWages Migration Guide | 2020-08-26 | 2021-08-26 |
| GetEmployeeWage | GetTeamMemberWage Migration Guide | 2020-08-26 | 2021-08-26 |
| ListLoyaltyPrograms | RetrieveLoyaltyProgram Migration Guide | 2021-05-13 | 2022-05-13 |
| CreateCustomerCard | CreateCard or CreateGiftCard Migration Guide | 2021-06-16 | 2022-06-16 |
| DeleteCustomerCard | DisableCard or UnlinkCustomerFromGiftCard Migration Guide | 2021-06-01 | 2022-06-01 |
Deprecated fields
The following fields are deprecated and replaced:
Field name | Replacement | Deprecated | Retirement |
|---|---|---|---|
| CreateOrderRequest.reference_id | Order.reference_id | 2018-07-12 | 2020-11-18 |
| CreateOrderRequest.line_items | Order.line_items | 2018-07-12 | 2020-11-18 |
| CreateOrderRequest.taxes | Order.taxes | 2018-07-12 | 2020-11-18 |
| CreateOrderRequest.discounts | Order.discounts | 2018-07-12 | 2020-11-18 |
| Customer.cards | ListCards ListGiftCards Migration notes | 2021-06-16 | 2022-06-16 |
| InvoicePaymentRequest.request_method | Invoice.delivery_method InvoicePaymentRequest.automatic_payment_source Migration notes | 2021-01-21 | TBD |
| LoyaltyProgramRewardTier.definition | LoyaltyProgramRewardTier.pricing_rule_definition | 2020-12-16 | TBD |
| OrderLineItem.taxes | OrderLineItem.applied_taxes | 2018-07-12 | 2020-11-18 |
| OrderLineItem.discounts | OrderLineItem.applied_discounts | 2018-07-12 | 2020-11-18 |
| shift.employee_id | Shift.team_member_id | 2020-08-28 | 2021-08-26 |
| ShiftFilter.employee_ids | ShiftFilter.team_member_ids | 2020-08-28 | 2021-08-26 |