Learn about the current status of deprecated Square objects, fields, enums, and values.
To provide new features or improved functionality, Square might deprecate objects, fields, enums, or values in the data model. When items are deprecated, you should migrate to the replacement as soon as possible to avoid disruption when the item is retired in a future Square API version. The Square Developer Platform attempts to minimize changes that require code updates.
Note
All Connect v1 objects and enums are deprecated or retired.
The Deprecated page in the Square API Reference lists all deprecated endpoints and webhooks. Each deprecated endpoint documents its deprecation date and, where applicable, the replacement endpoint, estimated retirement date, and migration guide.
The following objects are deprecated, along with all of their fields:
The following deprecated fields belong to objects that are not deprecated:
- AccumulateLoyaltyPointsResponse.event
- CardPaymentDetails.device_details
- CatalogItem.category_id
- CatalogItem.description
- CatalogPricingRule.apply_products_id
- Checkout.additional_recipients
- Dispute.dispute_id
- Dispute.evidence_ids
- Dispute.reported_date
- DisputeEvidence.evidence_id
- InvoicePaymentRequest.request_method
- LoyaltyProgramRewardTier.definition
- LoyaltyPromotionIncentivePointsMultiplierData.points_multiplier
- ObtainTokenResponse.id_token
- Payment.employee_id
- Refund.additional_recipients
- Shift.employee_id
- ShiftFilter.employee_ids
- Tender.additional_recipients
- TerminalCheckout.deadline_duration
The following enums are deprecated, along with all of their values:
- EmployeeStatus
- InvoiceRequestMethod
- LoyaltyProgramRewardDefinitionScope
- LoyaltyProgramRewardDefinitionType
- TransactionProduct
The following deprecated values belong to enums that are not deprecated:
- CatalogItemProductType.GIFT_CARD
- CheckoutOptionsPaymentType.PAYPAY
- DestinationType.SQUARE_BALANCE
- InventoryState.IN_TRANSIT_TO