2021-08-18 Changelog

Square Customers API Invoices API Loyalty API

Version Summary

• Square Version: 2021-08-18
• Java: 14.0.0.20210818
• .NET: 13.1.0
• Node.js: 13.1.0
• PHP: 13.1.0.20210818
• Python: 13.1.0.20210818
• Ruby: 13.1.0.20210818

Details

Link to section

API updates

• Customers API:

  • Customer object. The version field has moved to the general availability (GA) state. This field represents the current version of the customer profile and enables optimistic concurrency control. For more information, see Customer profile versions and optimistic concurrency support.

  • ListCustomers endpoint. The new, optional limit query parameter can be used to specify the maximum number of results in a paginated response.

• Customer Groups API:

  • ListCustomerGroups endpoint. The new, optional limit query parameter can be used to specify the maximum number of results in a paginated response.

• Customer Segments API:

  • ListCustomerSegments endpoint. The new, optional limit query parameter can be used to specify the maximum number of results in a paginated response.

• Invoices API:

  • Square Invoices Plus is a monthly subscription plan that allows access to premium invoice features. After Invoices Plus is launched in September 2021, a subscription will be required to create invoices with custom fields and installment payments. For more information, including how to handle new errors, see Premium features available with Invoices Plus.

• Loyalty API:

  • LoyaltyAccount object. Added a new expiring_point_deadlines field that specifies when points in the account balance are scheduled to expire. This field contains a list of LoyaltyAccountExpiringPointDeadline objects. For more information, see Expiring points.

Link to section

Documentation updates

• App Marketplace. Added the following topics:

  • How to apply. Documented the process to list an application on the Square App Marketplace.

  • App Marketplace API Usage Requirements. Added a topic that describes a set of API usage requirements and recommendations for partner applications.

• Automatic communications from Square about invoices. Documented the invoice-related communications sent from Square to customers and sellers.

• Snippets best practices. Documented best practices and additional requirements for snippets and applications that integrate with the Snippets API.