2022-11-16 Changelog

Square BookingCustomAttributes API Catalog API Checkout API Customers API Loyalty API OrderCustomAttributes API Orders API Square Payment Form Terminal API

Version Summary

• Square Version: 2022-11-16
• Java: 26.0.0.20221116
• .NET: 24.0.0
• Node.js: 24.0.0
• PHP: 24.0.0.20221116
• Python: 24.0.0.20221116
• Ruby: 25.0.0.20221116

Details

Link to section

New API releases

• Booking Custom Attributes API: (beta)

  • The Booking Custom Attributes API enables applications to create and manage custom attributes for bookings. For more information, see Custom Attributes for Bookings.

• Order Custom Attributes API: (beta)

  • The Order Custom Attributes API enables applications to create and manage custom attributes for orders. For more information, see Custom Attributes for Orders.

Link to section

API updates

• Catalog API:

  • CatalogModifier object (beta). The image_ids field is replaced by image_id. This object no longer supports multiple images.

• Checkout API:

  • CreatePaymentLink endpoint. Cash App Pay and Afterpay are no longer supported for subscription payments. For more information, see Guidelines and Limitations.

• Customers API:

  • UpdateCustomer endpoint. The following changes apply:

    • The address field supports sparse updates.

    • To remove the address field, you must set the value to null and include the X-Clear-Null header in the request.

    For more information, see Migration notes.

• Loyalty API:

  • LoyaltyPromotion object. Added the qualifying_category_ids and qualifying_item_variation_ids fields to support category-based and item-based promotions for VISIT and SPEND program types. For more information, see Qualifying items.

• Orders API:

  • Added support for the DELIVERY fulfillment type (beta). For more information, see Manage Order Fulfillments.

• Terminal API:

  • TerminalAction object (beta). Added the receipt_options Terminal action type to support printing and issuing receipts. For more information, see Print or Issue Receipts for Cash Payments and Previous Transactions.

  • TerminalCheckout object. Application fees, delayed capture, orders and itemizations, and partial authorization are moved to general availability (GA). For more information about setting these payment options for Terminal checkout requests, see Take Payments with the Terminal API.

  • Added support for card dipping to save a card on file (US-based sellers). For more information, see Save a Card on File with the Terminal API.

Link to section

SDK Updates

• SqPaymentForm:

  • SqPaymentForm was retired on October 31, 2022. Developers must migrate to the Web Payments SDK client-side library. For more information, see Migrate to the Web Payments SDK.

Link to section

Documentation updates

• Catalog API:

  • The UpsertCatalogObject, BatchUpsertCatalogObjects, DeleteCatalogObject, and BatchDeleteCatalogObjects descriptions are updated to include the following previously undocumented behavior:

    • Only one update request (including deletion) is processed at a time per seller account. While a request is being processed, all requests sent to any of these endpoints receive a 429 error response.