2021-07-21 Changelog

Square Loyalty API Inventory API Subscriptions API Payments API Locations API Orders API

Version Summary

• Square Version: 2021-07-21
• Java: 13.0.0.20210721
• .NET: 13.0.0
• Node.js: 13.0.0
• PHP: 13.0.0.20210721
• Python: 13.0.0.20210721
• Ruby: 13.0.0.20210721

Details

Link to section

API updates

• Orders API:

  • OrderServiceCharge object. Added a new type field that identifies the service charge type.

  • OrderQuantityUnit, OrderLineItem, OrderLineItemDiscount, OrderLineItemModifier, OrderLineItemTax, OrderServiceCharge, OrderReturnLineItem, OrderReturnLineItemModifier, OrderReturnServiceCharge, OrderReturnTax, and OrderReturnDiscount objects. Added a new catalog_version field.

• Locations API:

  • Location object. Added a new tax_ids field of the TaxIds type. In the current implementation, sellers in Ireland and France can configure tax IDs during the onboarding process. They can also provide the information later by updating the location information in the Seller Dashboard. These tax IDs appear in this field.

• Loyalty API:

  • As of July 15, 2021, the country in which the seller’s Square account is activated determines whether Square uses pretax or post-tax purchase amounts to calculate accrued points. This change supports consumption tax models, such as value-added tax (VAT). Previously, point accrual was based on pretax purchase amounts only. This change does not affect the existing point balance of loyalty accounts. For more information, see Availability of Square Loyalty.

• Payments API:

  • UpdatePayment. The endpoint has moved to the general availability (GA) state. Also, you can now update gift card payments (similar to card, cash, and external payments).

• Subscriptions API:

  • The Subscriptions API has moved to the general availability (GA) state.

  • CatalogSubscriptionPlan object. The name and price are now write-once fields. You specify these values at the time of creating a plan. After the plan is created, these fields cannot be updated. This makes a subscription plan immutable.

• Inventory API:

  • RetrieveInventoryTransfer. This new endpoint is introduced to support the retrieval of inventory transfer.

  • RetrieveInventoryChanges. This endpoint is deprecated. Its support ends when it is retired in about 12 months.

  • The following endpoints have updated URLs to conform to the standard REST API convention. For more information about migrating deprecated URLs to updated URLs in your application, see Inventory API: Migrate to Updated API Entities:

    • RetrieveInventoryAdjustment

    • BatchChangeInventory

    • BatchRetrieveInventoryChanges

    • BatchRetrieveInventoryCounts

    • RetrieveInventoryPhysicalCount

Link to section

SDK updates

• Square Java SDK:

The Square Java SDK now lets you customize HttpClient by creating an okhttpclient instance and setting it in HttpClientConfiguration to override the default behavior.

• Square .NET SDK:

The Square .NET SDK now lets you customize HttpClient by creating an HttpClientInstance object and setting it in HttpClientConfiguration to override the default behavior.

• Square Python SDK:

The Square Python SDK now requires Python 3.7 or later, if Python 3 is used. With Python 2, the minimum version remains at 2.7.

Link to section

Documentation updates

• Webhooks. Revised the steps and descriptions for creating and using webhooks. For more information, see Webhooks Overview.