2024-11-20 Changelog

Square
Documentation
Customers API
Mobile Payments SDK
Refunds API
Web Payments SDK
Link to section

Version summary

Link to section

Details

Link to section

API updates

  • Customers API:

    • Customer object - The cards field will be retired in Square API version 2025-01-23. This field is replaced by the ListCards and ListGiftCards endpoints with the customer_id query parameter.

      Note that the retirement date for the deprecated CreateCustomerCard and DeleteCustomerCard endpoints isn't currently scheduled, but you should migrate to the Cards API and Gift Cards API as soon as possible. For more information, see Migration notes.

  • Mobile Payments SDK:

  • Refunds API:

    • RefundPayment endpoint - New error code PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE for a 400 bad request on a payment that cannot be refunded due to a dispute.
Link to section

Documentation updates

  • Subscriptions API:

    • Subscriptions API - INVOICES_READ is a required permission when working with invoices and webhooks related to subscriptions.
    • Subscription Billing and Invoices - When changing the billing anchor date for a subscription, the default behavior is to not prorate the next invoice, which can result in billing customers twice in quick succession. To prorate subscription charges, the can_prorate field on the SubscriptionPlanVariation must be set to true.
  • Take Payments on Hardware:

    • Added a decision matrix to help developers determine the best APIs and SDKs for their application.
    • Revised the content to focus on three in-person payment use cases:
      • Processing payments over the counter
      • Processing payments on the go
      • Processing payments at a self-service kiosk
  • Web Payments SDK:

    • (Beta) Support for CHARGE_AND_STORE card payments on file with the new payment method flow that uses additional parameters for tokenize() to initiate SCA and buyer verification without calling verifyBuyer() in payment requests.

Learn about versioning for the Square API and SDKs.