2025-04-16 Changelog

• Catalog API:

  • CatalogItem object - Added the is_alcoholic field that indicates whether the item is alcoholic.

• Invoices API:

  • Invoice object - After an invoice is published and reaches the scheduled date (if one is defined), Square adds the public_url field to the invoice. This field contains the link to the Square-hosted payment page where customers can pay the invoice.

    Invoice payment links are now temporary and expire after a certain period. Customers can provide the email address or phone number associated with the invoice and request a new link directly from the expired payment page, so no action is required from the developer. However, developers who need to share a payment link with the customer a few days or more after it was generated should retrieve the invoice first to automatically generate a new, up-to-date link.

    These changes apply across all Square API versions. Current invoice payment links will follow the same expiration process. Note that link expiry and dynamic link generation don't trigger invoice.updated webhook events.

• Locations API:

  • Location object - Additional validation on address fields. Emojis, control characters, and special symbols are not allowed in address fields.

• Square SDKs:

  • Python SDK - The Square Python SDK has been rewritten. The new version provides the same access to Square APIs, along with:

    • Auto-pagination - With the SDK, you can easily paginate through long responses.
    • Simplified classes and method names.
    • API errors represented as Exceptions, inherited form the ApiError class.
    • Support for the Pydantic validation library.
    • Python 3.8 is now the minimum required version.

    Previous versions of the SDK continue to work, but to take advantage of these new features and API updates moving forward, you should migrate your code to use the new version of the SDK.

• Terminal API:

  • CreateTerminalCheckout endpoint - Added support for the following payment features in Australia, Canada, Japan, and the United Kingdom:
    • App fees
    • Delayed capture
    • Statement descriptor
    • Team member ID
    • Tip money

  For more information, see Additional Payment and Checkout Features.

• Webhooks:

  • The retry schedule for Square webhooks is changed. Square now makes a maximum of 11 retry attempts for up to 24 hours after the event. This change applies to webhook subscriptions for all Square API versions.

• Square App Marketplace:

  • New requirement - As of March 27, 2025, applications must have a minimum of five active Square sellers to be eligible for listing in the Square App Marketplace.

• International Development:

  • International Development - Consolidated information on international development into a single topic.
  • Develop for Japan - Organized Japan-specific development information into a new topic.

Learn about versioning for the Square API and SDKs.