Version 20.1.0

This release of the nodejs SDK includes support for Square API version 2022-07-20. For more information about the changes to this API version, see https://developer.squareup.com/docs/changelog/connect-logs/2022-07-20.

Version 20.0.0

This release of the nodejs SDK includes support for Square API version 2022-07-20. For more information about the changes to this API version, see https://developer.squareup.com/docs/changelog/connect-logs/2022-07-20.

Version 19.1.0

This release of the nodejs SDK includes support for Square API version 2022-06-16. For more information about the changes to this API version, see https://developer.squareup.com/docs/changelog/connect-logs/2022-06-16.

Version 19.0.0

This release of the nodejs SDK includes support for Square API version 2022-05-12. For more information about the changes to this API version, see https://developer.squareup.com/docs/changelog/connect-logs/2022-05-12.

Version 18.0.0

This release of the nodejs SDK includes support for Square API version 2022-04-20. For more information about the changes to this API version, see https://developer.squareup.com/docs/changelog/connect-logs/2022-04-20.

Version 17.3.0

This release of the nodejs SDK includes support for Square API version 2022-03-16. For more information about the changes to this API version, see https://developer.squareup.com/docs/changelog/connect-logs/2022-03-16.

Version 17.2.0

This release of the nodejs SDK includes support for Square API version 2022-02-16. For more information about the changes to this API version, see https://developer.squareup.com/docs/changelog/connect-logs/2022-02-16.

Version 17.1.0

This release of the NodeJS SDK includes support for Square API version 2022-01-20. For more information about the changes to this API version, see https://developer.squareup.com/docs/changelog/connect-logs/2022-01-20.

Version 17.0.0

Version 17.0.0 (2021-12-15)

API updates

• Invoices API:

  • The Invoices API now supports seller accounts in France. For more information, see International availability and considerations.

  • France only: Invoice object. Added a new payment_conditions field, which contains payment terms and conditions that are displayed on the invoice. This field is available only for sellers in France. For more information, see Payment conditions.

    Square version 2021-12-15 or higher is required to set this field, but it is returned in ListInvoices and RetrieveInvoice requests for all Square versions.

• Cards API

  • Added the CARD_DECLINED_VERIFICATION_REQUIRED error code to the list of error codes returned by CreateCard.

• Catalog API:

  • CreateCatalogImage endpoint

    • Updated to support attaching multiple images to a Catalogbject instance.
    • Added is_primary option to let the caller choose to attach an image as the primary image on the object for display with the Square Point of Sale and other first-party Square applications. For more information, see Upload and Attach Images.

  • CatalogObject object

    • Retired the image_id field, used to hold a single image object attached to an image-supporting object of the ITEM, ITEM_VARIATION, CATEGORY, or MODIFIER_LIST type, in Square API version 2021-12-15 and later, which supports attachment of multiple images. The image_id field is still supported in Square API version prior to 2021-12-15. For more information, see Work with Images: Overview.

  • CatalogItem, CatalogItemVariation, CatalogCategory or CatalogModifierList object

    • Added image_ids list to hold attached image objects. The first element of image_ids list refers to the primary image attached to the catalog object. For more information, see Work with Images: Overview.

  • UpdateCatalogImage endpoint

    • Added to support replacing the image file encapsulated by an existing CatalogImage object. For more information, see Replace image file on a CatalogImage object.

  • CatalogPricingRule object

    • Added minimum_order_subtotal_money field to require that the minimum order subtotal be reached before the pricing rule may be applied.

Documentation updates

• Added a new top-level node for Developer Tools. This node includes such features as Sandbox, API Logs, and Webhooks.
• Added Webhook Event Logs (beta) documentation to the Developer

Version 16.0.0

Version 16.0.0 (2021-11-17)

API updates

• Cards API. The Card object and webhook response body for all webhooks are updated updated with fields.

  • Added the Card.merchant_id field to identify the Square seller that stored the payment card on file.
  • Added a Card object to the response bodies of all Cards API webhooks. The Card is added as a child of the data.object field in all webhook responses.

• Bookings API. The new ListBookings endpoint supports browsing a collection of bookings of a seller. For more information, see Use the Bookings API: list bookings.

• Subscriptions API. Introduced the new actions framework representing scheduled, future changes to subscriptions.

  • The new PauseSubscription endpoint supports temporarily pausing a subscription. Calling this endpoint schedules a new PAUSE action.
  • The new SwapPlan endpoint supports changing the subscription plan associated with a single customer. Calling this endpoint schedules a new SWAP_PLAN action.
  • The new DeleteSubscriptionAction endpoint supports deleting a scheduled action.
  • The ResumeSubscription endpoint has been updated to support resuming a paused subscription. Calling this endpoint schedules a new RESUME action.
  • The CancelSubscription endpoint now schedules a new CANCEL action.
  • Added an optional include body parameter to the SearchSubscriptions endpoint. Include actions in the request to return all actions associated with the subscriptions.

Documentation Update

• Migration Guides.

  • Migrate from the Connect V1 Refunds API. The topic is updated to include information to migrate from the v1 ListRefunds endpoint to the appropriate Square API counterparts.
  • Migrate from the Connect V1 Payments API. The topic provides developers information to migrate from the Connect V1 Payments API to the appropriate Square API counterparts.

  Code that relies on these V1 API endpoints must be updated to avoid breaking when these APIs reach