Square logo

Square Python SDK

Build PyPi version Apache-2 license

Use this library to integrate Square payments into your app and grow your business with Square APIs including Catalog, Customers, Employees, Inventory, Labor, Locations, and Orders.

Requirements

Use of the Python SDK requires:

  • Python 3 version 3.7 or higher

Installation

For more information, see Set Up Your Square SDK for a Python Project.

Quickstart

For more information, see Square Python SDK Quickstart.

Usage

For more information, see Using the Square Python SDK.

Tests

First, clone the repo locally and cd into the directory.

git clone https://github.com/square/square-python-sdk.git
cd square-python-sdk

Next, install dependencies.

python3 -m pip install .

Before running the tests, find a sandbox token in your Developer Dashboard and set a SQUARE_SANDBOX_TOKEN environment variable.

export SQUARE_SANDBOX_TOKEN="YOUR SANDBOX TOKEN HERE"

Ensure you have pytest installed:

python3 -m pip install pytest

And lastly, run the tests.

pytest

SDK Reference

Payments

Terminal

Orders

Subscriptions

Invoices

Items

Customers

Loyalty

Gift Cards

Bookings

Business

Team

Financials

Online

Authorization

Webhook Subscriptions

Deprecated APIs

The following Square APIs are deprecated:

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (45.1.0.20260819)

5 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for bzou from gravatar.com bzou Avatar for jessiedlcs from gravatar.com jessiedlcs Avatar for mikekono1 from gravatar.com mikekono1
+2 more Avatar for square-developers from gravatar.com square-developers Avatar for tredshaw-squareup from gravatar.com tredshaw-squareup

Credits

Author: Square Developer Platform

Requires

Python >=3.7

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

squareup-31.0.0.20230925-py3-none-any.whl (125.9 kB view details)

Uploaded Python 3

File details

Details for the file squareup-31.0.0.20230925-py3-none-any.whl.

File metadata

File hashes

Hashes for squareup-31.0.0.20230925-py3-none-any.whl
Algorithm Hash digest
SHA256 69af34d2eb64f8dcb5720980404ee2c646dde9c642ee94df4d9b4b6297907c71
MD5 d4148e27290fc0997625ee41b17032fb
BLAKE2b-256 dc0e992f26cb0882f545847b6a0ed55b99779172e2b6bfbb2afbed1bec1cf940

See more details on using hashes here.

Release history Release notifications | RSS feed

45.1.0.20260819

2 files

45.0.1.20260715

2 files

Pre-release

44.2.0rc0

2 files

44.1.0.20260520

2 files

44.0.1.20260122

2 files

44.0.0.20260122

2 files

43.2.0.20251016

2 files

43.1.2.20250924

2 files

43.0.2.20250820

2 files

43.0.1.20250716

2 files

43.0.0.20250618

2 files

42.1.0.20250521

2 files

42.1.0.20250416

1 file

42.0.0.20250416

2 files

41.0.0.20250319

1 file

40.1.0.220250220

1 file

40.0.0.220250123

1 file

39.1.0.20241218

1 file

39.0.0.20241120

1 file

38.2.0.20241017

1 file

38.1.0.20240919

1 file

38.0.0.20240821

1 file

37.1.1.20240717

1 file

37.1.0.20240604

1 file

37.0.0.20240515

1 file

36.0.0.20240417

1 file

35.1.0.20240320

1 file

35.0.0.20240222

1 file

34.0.1.20240118

1 file

34.0.0.20240118

1 file

33.1.0.20231213

1 file

33.0.0.20231115

1 file

32.0.0.20231018

1 file

This release

31.0.0.20230925 This release

1 file

30.0.0.20230816

1 file

29.0.0.20230720

1 file

28.0.1.20230608

1 file

28.0.0.20230608

1 file

27.0.0.20230517

1 file

26.0.0.20230419

1 file

25.2.0.20230315

1 file

25.1.0.20230119

1 file

25.0.0.20221214

1 file

24.0.0.20221116

1 file

23.0.0.20221019

2 files

22.0.0.20220921

2 files

21.1.0.20220823

2 files

21.0.0.20220817

2 files

20.1.0.20220720

2 files

20.0.0.20220720

2 files

19.1.0.20220616

2 files

19.0.0.20220512

2 files

18.0.0.20220420

2 files

17.3.0.20220316

2 files

17.2.0.20220216

2 files

17.1.0.20220120

2 files

17.0.0.20211215

2 files

16.0.0.20211117

2 files

15.0.0.20211020

2 files

14.1.1.20210915

2 files

14.1.0.20210915

2 files

Yanked

14.0.0.20210915

2 files

Yanked reason: This version was released with stale data from 13.1.0.20210818 and is an invalid release. Please upgrade to 14.1.0.20210915

13.1.0.20210818

2 files

13.0.0.20210721

2 files

12.0.0.20210616

2 files

11.0.0.20210513

2 files

10.0.0.20210421

2 files

9.1.0.20210317

2 files

9.0.0.20210226

2 files

8.1.0.20210121

2 files

8.0.0.20201216

2 files

7.0.0.20201118

2 files

6.5.0.20201028

2 files

6.4.0.20200923

1 file

6.3.0.20200826

1 file

6.2.0.20200812

1 file

6.1.0.20200722

1 file

6.0.0.20200625

1 file

5.3.0.20200528

1 file

5.2.2.20200422

1 file

5.2.1.20200422

1 file

5.2.0.20200422

1 file

5.1.0.20200325

1 file

5.0.0.20200226

1 file

4.1.0.20200122

1 file

4.0.0.20191217

1 file

3.20191120.0

1 file

3.20191023.0

1 file

3.20190925.0

1 file

3.20190814.0

2 files

3.3.0.20191217

1 file

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page