Skip to content

Releases: square/square-python-sdk

Version 17.0.0.20211215

15 Dec 18:19
dee4a02
Compare
Choose a tag to compare

Version 17.0.0.20211215 (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:

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.20211117

17 Nov 01:33
c5b6084
Compare
Choose a tag to compare

Version 16.0.0.20211117 (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.

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

Version 15.0.0.20211020

20 Oct 16:02
15193d0
Compare
Choose a tag to compare

Version 15.0.0.20211020 (2021-10-20)

API updates

  • Transactions API. Three previously deprecated endpoints (ListRefunds, Charge, and CreateRefund) in the Transactions API are removed from Square API version 2021-10-20 and later. These endpoints will work if you are using Square API versions prior to 2021-10-20. However, these endpoints will eventually be retired from all Square versions.

    • Instead of the Transactions API Charge endpoint, use the Payments API CreatePayment endpoint.
    • Instead of the Transactions API CreateRefund endpoint, use the Refunds API RefundPayment endpoint.
    • Instead of the Transactions API ListRefunds endpoint, use the Refunds API ListPaymentRefund endpoint.
  • Payments API:

  • Refunds API:

    • RefundPayment endpoint.
      • Added the team_member_id request field to record the ID of the team member associated with the refund.
      • Added the payment_version_token request field to support optimistic concurrency. For more information, see Refund Payment.
  • Customers API:

    • Customer object. Added a new tax_ids field of the CustomerTaxIds type, which can contain the EU VAT ID of the customer. This field is available only for customers of sellers in France, Ireland, or the United Kingdom. For more information, see Customer tax IDs.

    • UpdateCustomer endpoint. The Customers API now returns a 400 BAD_REQUEST error if the request body does not contain any fields. For earlier Square versions, the Customers API will continue to return a 200 OK response along with the customer profile. For more information, see Migration notes.

  • Invoices API:

    • InvoiceRecipient object. Added a new, read-only tax_ids field of the InvoiceRecipientTaxIds type, which can contain the EU VAT ID of the invoice recipient. This field is available only for customers of sellers in Ireland or the United Kingdom. If defined, tax_ids is returned for all Square API versions. For more information, see Invoice recipient tax IDs.
    • Square now sends emails for test invoices that are published in the Sandbox environment.
  • Catalog API:

    • CatalogSubscriptionPlan.name can be updated after the subscription plan is created. The change is retroactively applicable to prior versions of the Square API.
  • Subscriptions API:

    • The new SubscriptionSource data type is introduced to encapsulate the source where a subscription is created. The new SubscriptionSource.name value is propagated to the Order.source attribute when an order is made on the subscription. The new feature is retroactively applicable to prior versions of the Square API.
    • The new Subscription.source attribute is introduced to indicate the source where the subscription was created. This new feature is retroactively applicable to prior versions of the Square API.
    • The new SearchSubscriptionsFilter.source_names query expression is introduced to enable search for subscriptions by the subscription source name. This new feature is retroactively applicable to prior versions of the

Version 14.1.1.20210915

30 Sep 16:52
64b1180
Compare
Choose a tag to compare

Version 14.1.1.20210915 (2021-09-15)

SDK updates

  • Upgraded josnpick

Version 14.1.0.20210915

16 Sep 18:58
dc9750c
Compare
Choose a tag to compare

Version 14.1.0.20210915 (2021-09-15)

API updates

  • Invoices API:

    • Invoice object. Added a new, optional sale_or_service_date field used to specify the date of the sale or the date that the service is rendered. If specified, this date is displayed on the invoice.
  • Orders API:

  • Team API:

    • SearchTeamMembersFilter object now has an is_owner field that when set, causes a team member search to return only the seller who owns a Square account.
  • Terminal API:

Documentation updates

  • OAuth API:
    • Revised API descriptions for the ObtainToken and Authorize endpoints. Clarified that the Authorize endpoint is not a callable API but is used to direct the seller to the Square authorization page. For more information about the Authorize endpoint, see [Create the Redirect URL and Square Authorization Page URL.](https://developer.squareup.com/docs/oauth-api/create-urls-for-square-au

Version 14.0.0.20210915

16 Sep 01:11
cc1f910
Compare
Choose a tag to compare

Version 14.0.0.20210915 (2021-09-15)

This version was released with stale data from v13.1.0.20210818 and is an invalid release.
We advise you to upgrade to v14.1.0.20210915 to get all the API updates.

Version 13.1.0.20210818

18 Aug 17:17
bc9dad3
Compare
Choose a tag to compare

Version 13.1.0.20210818 (2021-08-18)

API updates

  • Customers API:

  • 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:

Documentation updates

Version 13.0.0.20210721

21 Jul 15:56
68ae7a2
Compare
Choose a tag to compare

Version 13.0.0.20210721 (2021-07-21)

SDK updates

  • 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.

API updates

Documentation updates

Version 12.0.0.20210616

16 Jun 17:31
119649c
Compare
Choose a tag to compare

Version 12.0.0.20210616 (2021-06-16)

New API releases

API updates

  • Catalog API:

  • Customers API:

  • Disputes API:

    • The Disputes API is now GA.
    • RemoveDisputeEvidence. Renamed to DeleteDisputeEvidence.
    • CreateDisputeEvidenceFile. The URL is changed from /v2/disputes/{dispute_id}/evidence_file to /v2/disputes/{dispute_id}/evidence-files.
    • CreateDisputeEvidenceText. The URL is changed from /v2/disputes/{dispute_id}/evidence_text to /v2/disputes/{dispute_id}/evidence-text.
    • ListDisputeEvidence. The endpoint now returns a pagination cursor and accepts a pagination cursor in requests.
    • DISPUTES_READ and DISPUTES_WRITE permissions are required for all Disputes API endpoints instead of PAYMENTS_READ and PAYMENTS_WRITE.
    • DisputeEvidence. The evidence_id field is deprecated and replaced by the id field.
    • The dispute.state.changed webhook is renamed to dispute.state.updated.
    • Dispute object. The following breaking changes are made:
      • The dispute_id field is deprecated and replaced by the id field.
      • The reported_date field is deprecated and replaced by the reported_at field.
      • The evidence_ids field is deprecated with no replacement.

    For more information about the GA release of the Disputes API, see Disputes Overview.

  • Inventory API:

    • CatalogStockConversion (Beta). Enables selling a product in multiple measurement units and lets Square sellers manage inventory counts of the product's stockable and a non-stockable variations in a self-consistent manner. For more information, see Enable Stock Conversion.
  • Invoices API:

    • CreateInvoice. The location_id field is now optional and defaults to the location ID of the associated order. If specified in the request, the value must match the location ID of the associated order. This is a service-level change that applies to all Square API versions.
  • Loyalty API:

    • LoyaltyProgramAccrualRule object. New excluded_category_ids and excluded_item_variation_ids fields that represent any categories and items that are excluded from accruing points in spend-based loyalty programs.
  • Subscriptions API:

    • Subscription. The paid_until_date field is renamed to charge_through_date.

    • UpdateSubscription. The version field is now optional because it can update only the latest version of a subscription.

    • CreateSubscription. The idempotency_key field is now optional in the request. If you do not provide it, each CreateSubscription assumes a unique (never used before) value and creates a subscription for each call.

Documentation updates

  • Order fee structure. Documented the transaction fee related to using the Orders API with a non-Square paymen

Version 11.0.0.20210513

13 May 15:53
5d30eea
Compare
Choose a tag to compare

Version 11.0.0.20210513 (2021-05-13)

New API releases

  • Sites API. The Sites API lets you retrieve basic details about the Square Online sites that belong to a Square seller. For more information, see Sites API Overview.

  • Snippets API. The Snippets API lets you manage snippets that provide custom functionality on Square Online sites. A snippet is a script that is injected into all pages on a site, except for checkout pages. For more information, see Snippets API Overview.

The Sites API and Snippets API are publicly available to all developers as part of an early access program (EAP). For more information, see Early access program for Square Online APIs.

API updates

  • Payments API.

  • Loyalty API:

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

    • The ListLoyaltyPrograms endpoint is deprecated and replaced by the RetrieveLoyaltyProgram endpoint when used with the main keyword.

    • LoyaltyAccount  object. The mappings field is retired and replaced by mapping.

    • LoyaltyAccountMapping object. The type and value fields are retired and replaced by phone_number.

      Starting in Square version 2021-05-13:

      • mappings is not accepted in CreateLoyaltyAccount requests or returned in responses.
      • type and value are not accepted in CreateLoyaltyAccount or SearchLoyaltyAccounts requests or returned in responses.

      For more information, see Migration notes.

Documentation updates

  • Getting Started Added step that shows how to use the API Logs to examine a t