2023-07-20 Changelog

Square Documentation Customers API Invoices API Terminal API Webhooks DEPRECATED

Version Summary

• Square Version: 2023-07-20
• Java: 31.0.0.20230720
• .NET: 29.0.0
• Node.js: 29.0.0
• PHP: 29.1.0.20230720
• Python: 29.0.0.20230720
• Ruby: 30.0.0.20230720

Details

Link to section

API updates

• Customers API:

  • The ListCustomers and SearchCustomers endpoints now optionally return the total number of results for the request:

    • For ListCustomers, set the count query parameter to true. The returned value also represents the total number of customers for the Square seller.

    • For SearchCustomers, set the count field to true in the request body.

    When count is set to true in the request, the response includes a count field that contains the total number of customers. This change applies to all Square API versions. However, to access count using a Square SDK, you must use a version of the SDK that supports Square API version 2023-07-20 or later.

• Invoices API:

  • InvoiceAcceptedPaymentMethods object - Added the cash_app_pay field, which lets customers make invoice payments using Cash App (US only). For Square API versions 2021-04-21 and later, Square now accepts cash_app_pay in CreateInvoice and UpdateInvoice requests and includes it in returned invoices. For more information, including SDK version support, see Cash App Pay.

• Terminal API:

  • TerminalCheckout object - The deadline_duration field is now deprecated. Use the CancelTerminalCheckout endpoint instead to cancel pending or in-progress Terminal checkouts when needed. For more information, see Cancel a Terminal checkout.

• Webhooks:

  • Added a helper method to the PHP SDK for webhook signature validation. For the code sample, see Webhook event notification validation - PHP.

Link to section

Documentation updates

• Afterpay monthly payments - Added a maximum payment amount. For more information, see Afterpay minimums and maximums.