Square

Square provides APIs for payment processing, point of sale, and business management solutions enabling developers to build custom commerce applications.

Square publishes 45 API contracts indexed on the APIs.io network, including BookingCustomAttributes API, Bookings API, Cards API, and 42 more. Tagged areas include Booking, Location, Square, Restaurant, and Catalog.

The Square catalog on APIs.io includes 1 event-driven AsyncAPI specification, 1 JSON-LD context, and 4 Spectral governance rulesets.

Square’s developer surface includes signup flow, pricing, authentication, developer portal, documentation, API reference, getting-started guide, and 110 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

78.1/100 exemplar ▬ flat Agent 61/100 agent native Front door AI 4/6 moderate saas Full breakdown ↓
scored 2026-10-17 · rubric v0.24.0

AccessFreemiumSelf serve⚡ Free to try

1 published contract 2 MCP Servers 16 Features 11 Use Cases

Booking Location Square Restaurant Catalog Checkout Customers Disputes E-Commerce Financial Technology Gift Cards Inventory Invoicing Labor Loyalty Merchants Order Payments Point-of-Sale Refunds Retail Subscription Team Webhook Payment ProcessingPayment Terminals

What this lets a business do 10

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Payments & Card Management

BC-1340

CheckoutDisputesPaymentsPayoutsTerminalTransactions

POST /v2/locations/{location_id}/transactions/{transaction_id}/capture POST /v2/locations/{location_id}/transactions/{transaction_id}/void POST /v2/disputes/{dispute_id}/accept POST /v2/disputes/{dispute_id}/submit-evidence

Customer Relationship Management

BC-420

CustomerCustomAttributesCustomerGroupsCustomerSegmentsCustomersLoyalty

POST /v2/loyalty/accounts POST /v2/loyalty/accounts/{account_id}/accumulate GET /v2/loyalty/programs GET /v2/loyalty/programs/{program_id}

Human Capital Management

BC-300

EmployeesLaborTeam

POST /v2/team-members GET /v2/team-members/jobs PUT /v2/team-members/{team_member_id} PUT /v2/team-members/{team_member_id}/wage-setting

Point of Sale Operations Management

BC-2320

CashDrawers

GET /v2/cash-drawers/shifts

Inventory Management

BC-530

Inventory

POST /v2/inventory/counts/batch-retrieve GET /v2/inventory/physical-counts/{physical_count_id} GET /v2/inventory/transfers/{transfer_id}

Developer Platform & API Ecosystem Management

BC-4270

WebhookSubscriptions

GET /v2/webhooks/event-types POST /v2/webhooks/subscriptions POST /v2/webhooks/subscriptions/{subscription_id}/signature-key POST /v2/webhooks/subscriptions/{subscription_id}/test

Financial Management

BC-200

Invoices

POST /v2/invoices POST /v2/invoices/{invoice_id}/publish

Subscription Lifecycle Management

BC-4240

Subscriptions

POST /v2/subscriptions POST /v2/subscriptions/{subscription_id}/billing-anchor POST /v2/subscriptions/{subscription_id}/cancel POST /v2/subscriptions/{subscription_id}/pause

Supplier Management

BC-510

Vendors

POST /v2/vendors/create POST /v2/vendors/search

Product Information Management

BC-2370

Catalog

POST /v2/catalog/batch-upsert POST /v2/catalog/search POST /v2/catalog/search-catalog-items

What people ask Square 42

The questions people put to an LLM, and the jobs they hand an agent, that Square's APIs answer — each one linked to the operation that does it. Generated by API Evangelist

Square Loyalty API Enroll a buyer in the loyalty program “How do I sign a customer up for my Square loyalty program using their phone number?” Find loyalty accounts by phone or customer “Can I look up a loyalty member by their phone number?” Get a loyalty account “How can I see the point balance on one specific loyalty account?” Award points earned from a purchase “How do I give a loyalty member the points they earned on an order?”

Square Labor API List break types for a business “What kinds of breaks have we set up for staff at each location?” Create a break type template “How do I set up a new paid or unpaid break template for employees?” Delete a break type “Can I remove a break type even if shifts already reference it?” Get a single break type “What are the settings of one specific break type?”

Square Terminal API Send an action request to a Terminal device “How do I push a custom action, like a device pairing check, to a Square Terminal?” Search Terminal action requests “Which Terminal action requests did I send in the last 30 days?” Get a Terminal action request “What is the status of an action I sent to a Terminal?” Cancel a Terminal action request “Can I cancel an action request before the device completes it?”

Square Catalog API Delete several catalog objects at once “How do I delete a bunch of catalog items in one request?” Fetch several catalog objects by ID “Can I fetch many catalog items by their IDs in one call?” Create or update catalog objects in bulk “How do I import thousands of products into my Square catalog at once?” Upload a catalog image “How do I add a product photo to an item in my catalog?”

Square Customers API List customer profiles “How do I page through every customer profile in my Square account?” Create a customer profile “What is the minimum info needed to add a new customer?” Create many customer profiles at once “Can I import a batch of new customers in one request?” Delete many customer profiles at once “Can I delete a list of customers in a single call?”

Square Inventory API Get an adjustment (deprecated URL) “Is there an older singular adjustment URL for reading an inventory adjustment?” Get an inventory adjustment “How do I view one inventory adjustment, like a sale or waste record?” Apply stock changes (deprecated URL) “Is the old batch-change inventory URL still usable?” Read stock history (deprecated URL) “Is there a legacy batch-retrieve-changes URL for inventory history?”

Square Bookings API List bookings “How do I see all upcoming appointments for my business?” Book an appointment “How do I schedule a new appointment for a customer in Square?” Find open appointment slots “What time slots are open for a service next week?” Fetch several bookings by ID “Can I get the details of multiple appointments in one request?”

Square Subscriptions API Enroll a customer in a subscription “How do I sign a customer up for a subscription plan?” Move all subscribers to a new plan variation “Can I migrate every active subscriber from one plan variation to another?” Search subscriptions by customer or location “Which subscriptions does a given customer have?” Get one subscription “What is the status and next billing date of a subscription?”

Square Team API Add a team member “How do I add a new employee to my Square team?” Add many team members at once “Can I onboard a whole batch of new staff in one request?” Update many team members at once “Is there a way to update many existing team members together?” List job titles “What job titles exist in my seller account?”

Square BookingCustomAttributes API List booking custom field definitions “What custom fields have been defined for bookings?” Define a new custom field for bookings “How do I add a custom field, like a pet's name, to appointments?” Delete a booking custom field definition “How do I remove a custom field definition from bookings entirely?” Get a booking custom field definition “What is the schema of one booking custom attribute definition?”

Square OrderCustomAttributes API List order custom field definitions “What custom fields have been defined for orders?” Define a new custom field for orders “How do I add a custom field, like a delivery note, to orders?” Delete an order custom field definition “How do I remove a custom field definition from orders entirely?” Get an order custom field definition “What does one order custom attribute definition contain?”

Square LocationCustomAttributes API List location custom field definitions “What custom fields exist for my store locations?” Define a new custom field for locations “How do I add a custom field, like a store manager, to my locations?” Delete a location custom field definition “How do I remove a custom field definition from all my locations?” Get a location custom field definition “What does one location custom attribute definition look like?”

Showing 12 of 42 APIs with phrasing — see every API.

Kin Score

Kin Score How this is scored →
scored 2026-10-17 · rubric v0.24.0

Composite quality — 78.1/100 · exemplar

Contract Quality 13.7 / 19

Developer Ergonomics 12.3 / 15

Access Clarity 13.8 / 15

Operational Transparency 5.1 / 10

Contract Governance 2.9 / 9

Discoverability 4.5 / 8

Regulatory Posture 5.9 / 15

Create-or-Update Ergonomics 6.1 / 10

Agent readiness — 61/100 · agent native

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 6 / 6

MCP Server 12 / 12

Machine-Readable Auth 10 / 10

Idempotency 9 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 6 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 6 / 6

Protected Resource Metadata 5 / 5

Registration Without a Human 6 / 6

Agentic Commerce Well-Known Document 0 / 5

Regulatory Posture applies to this provider. Its tags matched the Payments regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from github.com/api-evangelist/square: open an issue to ask a question, or submit a pull request to add artifacts. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Payments	gravity	52.3	-	-
Restaurants and POS	gravity	52.3	-	-

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

APIs 45

Individual APIs this provider publishes, each with its own machine-readable definition.

Square Reporting API

The Reporting API (Beta) provides a new way to access all of a business's data to build custom reports and integrations, surfacing sales, payments, and operational metrics acros...

Square Channels API

The Channels API lets applications represent and manage the sales channels through which a seller transacts, enabling attribution of orders and payments to specific online or in...

Square Transfer Orders API

The Transfer Orders API lets applications create and manage transfers of inventory stock between a seller's locations, supporting multi-location retail and restaurant operations.

Square BookingCustomAttributes API

The BookingCustomAttributes API from Square — 6 operation(s) for bookingcustomattributes.

Square Bookings API

The Bookings API from Square — 11 operation(s) for bookings.

Square Cards API

The Cards API from Square — 3 operation(s) for cards.

Square Catalog API

The Catalog API from Square — 13 operation(s) for catalog.

Square Checkout API

The Checkout API from Square — 5 operation(s) for checkout.

Square CustomerCustomAttributes API

The CustomerCustomAttributes API from Square — 5 operation(s) for customercustomattributes.

Square Customers API

The Customers API from Square — 10 operation(s) for customers.

Square Devices API

The Devices API from Square — 4 operation(s) for devices.

Square Disputes API

The Disputes API from Square — 8 operation(s) for disputes.

Square Employees API

The Employees API from Square — 2 operation(s) for employees.

Square Events API

The Events API from Square — 4 operation(s) for events.

Square GiftCardActivities API

The GiftCardActivities API from Square — 1 operation(s) for giftcardactivities.

Square Inventory API

The Inventory API from Square — 13 operation(s) for inventory.

Square Invoices API

The Invoices API from Square — 7 operation(s) for invoices.

Square Labor API

The Labor API from Square — 11 operation(s) for labor.

Square LocationCustomAttributes API

The LocationCustomAttributes API from Square — 6 operation(s) for locationcustomattributes.

Square Locations API

The Locations API from Square — 2 operation(s) for locations.

Square Loyalty API

The Loyalty API from Square — 16 operation(s) for loyalty.

Square MerchantCustomAttributes API

The MerchantCustomAttributes API from Square — 6 operation(s) for merchantcustomattributes.

Square Merchants API

The Merchants API from Square — 2 operation(s) for merchants.

Square MobileAuthorization API

The MobileAuthorization API from Square — 1 operation(s) for mobileauthorization.

Square OrderCustomAttributes API

The OrderCustomAttributes API from Square — 6 operation(s) for ordercustomattributes.

Square Orders API

The Orders API from Square — 7 operation(s) for orders.

Square Payments API

The Payments API from Square — 5 operation(s) for payments.

Square Payouts API

The Payouts API from Square — 3 operation(s) for payouts.

Square Refunds API

The Refunds API from Square — 2 operation(s) for refunds.

Square Sites API

The Sites API from Square — 1 operation(s) for sites.

Square Snippets API

The Snippets API from Square — 1 operation(s) for snippets.

Square Subscriptions API

The Subscriptions API from Square — 11 operation(s) for subscriptions.

Square Team API

The Team API from Square — 8 operation(s) for team.

Square Terminal API

The Terminal API from Square — 15 operation(s) for terminal.

Square Transactions API

The Transactions API from Square — 4 operation(s) for transactions.

Square V1Transactions API

The V1Transactions API from Square — 2 operation(s) for v1transactions.

Square Vendors API

The Vendors API from Square — 6 operation(s) for vendors.

Square O Auth API

The OAuth API from Square — 3 operation(s) for oauth.

Square Apple Pay API

The Apple Pay API from Square — 1 operation(s) for apple pay.

Square Bank Accounts API

The Bank Accounts API from Square — 3 operation(s) for bank accounts.

Square Cash Drawers API

The Cash Drawers API from Square — 3 operation(s) for cash drawers.

Square Customer Groups API

The Customer Groups API from Square — 2 operation(s) for customer groups.

Square Customer Segments API

The Customer Segments API from Square — 2 operation(s) for customer segments.

Square Gift Cards API

The Gift Cards API from Square — 6 operation(s) for gift cards.

Square Webhook Subscriptions API

The Webhook Subscriptions API from Square — 5 operation(s) for webhook subscriptions.

Scroll for all 45

Postman Collections 42

Ready-to-run Postman collections for exercising this provider's APIs.

Square ApplePay API

POSTMAN

Square ApplePay BankAccounts API

POSTMAN

Square ApplePay BookingCustomAttributes API

POSTMAN

Square ApplePay Bookings API

POSTMAN

Square ApplePay Cards API

POSTMAN

Square ApplePay CashDrawers API

POSTMAN

Square ApplePay Catalog API

POSTMAN

Square ApplePay Checkout API

POSTMAN

Square ApplePay CustomerCustomAttributes API

POSTMAN

Square ApplePay CustomerGroups API

POSTMAN

Square ApplePay Customers API

POSTMAN

Square ApplePay CustomerSegments API

POSTMAN

Square ApplePay Devices API

POSTMAN

Square ApplePay Disputes API

POSTMAN

Square ApplePay Employees API

POSTMAN

Square ApplePay Events API

POSTMAN

Square ApplePay GiftCardActivities API

POSTMAN

Square ApplePay GiftCards API

POSTMAN

Square ApplePay Inventory API

POSTMAN

Square ApplePay Invoices API

POSTMAN

Square ApplePay Labor API

POSTMAN

Square ApplePay LocationCustomAttributes API

POSTMAN

Square ApplePay Locations API

POSTMAN

Square ApplePay Loyalty API

POSTMAN

Square ApplePay MerchantCustomAttributes API

POSTMAN

Square ApplePay Merchants API

POSTMAN

Square ApplePay MobileAuthorization API

POSTMAN

Square ApplePay OAuth API

POSTMAN

Square ApplePay OrderCustomAttributes API

POSTMAN

Square ApplePay Orders API

POSTMAN

Square ApplePay Payments API

POSTMAN

Square ApplePay Payouts API

POSTMAN

Square ApplePay Refunds API

POSTMAN

Square ApplePay Sites API

POSTMAN

Square ApplePay Snippets API

POSTMAN

Square ApplePay Subscriptions API

POSTMAN

Square ApplePay Team API

POSTMAN

Square ApplePay Terminal API

POSTMAN

Square ApplePay Transactions API

POSTMAN

Square ApplePay V1Transactions API

POSTMAN

Square ApplePay Vendors API

POSTMAN

Square ApplePay WebhookSubscriptions API

POSTMAN

Scroll for all 42

Open Collections 44

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

API Collection

OPEN COLLECTION

Square ApplePay API

OPEN COLLECTION

Square ApplePay BankAccounts API

OPEN COLLECTION

Square ApplePay BookingCustomAttributes API

OPEN COLLECTION

Square ApplePay Bookings API

OPEN COLLECTION

Square ApplePay Cards API

OPEN COLLECTION

Square ApplePay CashDrawers API

OPEN COLLECTION

Square ApplePay Catalog API

OPEN COLLECTION

Square ApplePay Checkout API

OPEN COLLECTION

Square ApplePay CustomerCustomAttributes API

OPEN COLLECTION

Square ApplePay CustomerGroups API

OPEN COLLECTION

Square ApplePay Customers API

OPEN COLLECTION

Square ApplePay CustomerSegments API

OPEN COLLECTION

Square ApplePay Devices API

OPEN COLLECTION

Square ApplePay Disputes API

OPEN COLLECTION

Square ApplePay Employees API

OPEN COLLECTION

Square ApplePay Events API

OPEN COLLECTION

Square ApplePay GiftCardActivities API

OPEN COLLECTION

Square ApplePay GiftCards API

OPEN COLLECTION

Square ApplePay Inventory API

OPEN COLLECTION

Square ApplePay Invoices API

OPEN COLLECTION

Square ApplePay Labor API

OPEN COLLECTION

Square ApplePay LocationCustomAttributes API

OPEN COLLECTION

Square ApplePay Locations API

OPEN COLLECTION

Square ApplePay Loyalty API

OPEN COLLECTION

Square ApplePay MerchantCustomAttributes API

OPEN COLLECTION

Square ApplePay Merchants API

OPEN COLLECTION

Square ApplePay MobileAuthorization API

OPEN COLLECTION

Square ApplePay OAuth API

OPEN COLLECTION

Square ApplePay OrderCustomAttributes API

OPEN COLLECTION

Square ApplePay Orders API

OPEN COLLECTION

Square ApplePay Payments API

OPEN COLLECTION

Square ApplePay Payouts API

OPEN COLLECTION

Square ApplePay Refunds API

OPEN COLLECTION

Square ApplePay Sites API

OPEN COLLECTION

Square ApplePay Snippets API

OPEN COLLECTION

Square ApplePay Subscriptions API

OPEN COLLECTION

Square ApplePay Team API

OPEN COLLECTION

Square ApplePay Terminal API

OPEN COLLECTION

Square ApplePay Transactions API

OPEN COLLECTION

Square ApplePay V1Transactions API

OPEN COLLECTION

Square ApplePay Vendors API

OPEN COLLECTION

Square ApplePay WebhookSubscriptions API

OPEN COLLECTION

Square

OPEN COLLECTION

Scroll for all 44

MCP Servers 2

Model Context Protocol servers that expose these APIs to AI agents.

MCP Server

MCP SERVER

Square MCP Server

Remote MCP server at mcp.squareup.com over HTTP.

MCP SERVER

Pricing Plans 2

Published pricing tiers and plan structures.

Square Plans Pricing

4 plans

PLANS

Square Price Estimates

0 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Square Rate Limits

0 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Square Finops

FINOPS

Features 16

Notable capabilities this provider offers.

Tap/dip/swipe: 2.6%+15¢ Free, 2.5%+15¢ Plus, 2.4%+15¢ Premium

Online (Square site): 3.3%+30¢ Free, 2.9%+30¢ Plus/Premium

Online API: 2.9%+30¢ all plans

Manual entry/card on file: 3.5%+15¢ all plans

ACH (invoice): 1% $1 min ($10 cap on Plus/Premium)

ACH (API): 1% $1 min, $5 cap

Afterpay BNPL: 6%+30¢

Cash/check: free

Bitcoin: 0% until 2027

International cards: +1.50% on top

Square Payments, POS, Online, Invoices, Subscriptions APIs

Square Reader/Stand/Terminal/Register hardware

Webhooks for transactions, customers, orders

OAuth 2.0 + Personal access tokens

Catalog API for items, categories, taxes, modifiers

Customer Directory API

Scroll for all 16

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Square Webhooks

AsyncAPI 2.6 description of the Square webhook event surface. Square delivers HTTPS POST notifications to a subscriber-provided `notification_url` whenever an event occurs on a ...

ASYNCAPI

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Square Context

0 classes · 10 properties

JSON-LD

Spectral Rules 4

Spectral governance rulesets for linting and validating these APIs.

Square — asyncapi rules

7 rules · 1 errors 6 warnings

SPECTRAL

Square — jsonschema rules

5 rules · 4 warnings 1 info

SPECTRAL

Square API Rules

17 rules · 11 errors 2 warnings 4 info

SPECTRAL

Square API Rules

36 rules · 8 errors 19 warnings 9 info

SPECTRAL

OpenAPI Overlays 42

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Square Apple Pay Api Phrasing Overlay

2 actions · phrasing · square-apple-pay-api-openapi.yml

GENERATED

Square Bank Accounts Api Phrasing Overlay

4 actions · phrasing · square-bank-accounts-api-openapi.yml

GENERATED

Square Bookingcustomattributes Api Phrasing Overlay

12 actions · phrasing · square-bookingcustomattributes-api-openapi.yml

GENERATED

Square Bookings Api Phrasing Overlay

14 actions · phrasing · square-bookings-api-openapi.yml

GENERATED

Square Cards Api Phrasing Overlay

5 actions · phrasing · square-cards-api-openapi.yml

GENERATED

Square Cash Drawers Api Phrasing Overlay

4 actions · phrasing · square-cash-drawers-api-openapi.yml

GENERATED

Square Catalog Api Phrasing Overlay

15 actions · phrasing · square-catalog-api-openapi.yml

GENERATED

Square Checkout Api Phrasing Overlay

11 actions · phrasing · square-checkout-api-openapi.yml

GENERATED

Square Customer Groups Api Phrasing Overlay

6 actions · phrasing · square-customer-groups-api-openapi.yml

GENERATED

Square Customer Segments Api Phrasing Overlay

3 actions · phrasing · square-customer-segments-api-openapi.yml

GENERATED

Square Customercustomattributes Api Phrasing Overlay

11 actions · phrasing · square-customercustomattributes-api-openapi.yml

GENERATED

Square Customers Api Phrasing Overlay

15 actions · phrasing · square-customers-api-openapi.yml

GENERATED

Square Devices Api Phrasing Overlay

6 actions · phrasing · square-devices-api-openapi.yml

GENERATED

Square Disputes Api Phrasing Overlay

10 actions · phrasing · square-disputes-api-openapi.yml

GENERATED

Square Employees Api Phrasing Overlay

3 actions · phrasing · square-employees-api-openapi.yml

GENERATED

Square Events Api Phrasing Overlay

5 actions · phrasing · square-events-api-openapi.yml

GENERATED

Square Gift Cards Api Phrasing Overlay

8 actions · phrasing · square-gift-cards-api-openapi.yml

GENERATED

Square Giftcardactivities Api Phrasing Overlay

3 actions · phrasing · square-giftcardactivities-api-openapi.yml

GENERATED

Square Inventory Api Phrasing Overlay

14 actions · phrasing · square-inventory-api-openapi.yml

GENERATED

Square Invoices Api Phrasing Overlay

11 actions · phrasing · square-invoices-api-openapi.yml

GENERATED

Square Labor Api Phrasing Overlay

17 actions · phrasing · square-labor-api-openapi.yml

GENERATED

Square Locationcustomattributes Api Phrasing Overlay

12 actions · phrasing · square-locationcustomattributes-api-openapi.yml

GENERATED

Square Locations Api Phrasing Overlay

5 actions · phrasing · square-locations-api-openapi.yml

GENERATED

Square Loyalty Api Phrasing Overlay

19 actions · phrasing · square-loyalty-api-openapi.yml

GENERATED

Square Merchantcustomattributes Api Phrasing Overlay

12 actions · phrasing · square-merchantcustomattributes-api-openapi.yml

GENERATED

Square Merchants Api Phrasing Overlay

3 actions · phrasing · square-merchants-api-openapi.yml

GENERATED

Square Mobileauthorization Api Phrasing Overlay

2 actions · phrasing · square-mobileauthorization-api-openapi.yml

GENERATED

Square Oauth Api Phrasing Overlay

4 actions · phrasing · square-oauth-api-openapi.yml

GENERATED

Square Ordercustomattributes Api Phrasing Overlay

12 actions · phrasing · square-ordercustomattributes-api-openapi.yml

GENERATED

Square Orders Api Phrasing Overlay

9 actions · phrasing · square-orders-api-openapi.yml

GENERATED

Square Payments Api Phrasing Overlay

8 actions · phrasing · square-payments-api-openapi.yml

GENERATED

Square Payouts Api Phrasing Overlay

4 actions · phrasing · square-payouts-api-openapi.yml

GENERATED

Square Refunds Api Phrasing Overlay

4 actions · phrasing · square-refunds-api-openapi.yml

GENERATED

Square Sites Api Phrasing Overlay

2 actions · phrasing · square-sites-api-openapi.yml

GENERATED

Square Snippets Api Phrasing Overlay

4 actions · phrasing · square-snippets-api-openapi.yml

GENERATED

Square Subscriptions Api Phrasing Overlay

13 actions · phrasing · square-subscriptions-api-openapi.yml

GENERATED

Square Team Api Phrasing Overlay

13 actions · phrasing · square-team-api-openapi.yml

GENERATED

Square Terminal Api Phrasing Overlay

16 actions · phrasing · square-terminal-api-openapi.yml

GENERATED

Square Transactions Api Phrasing Overlay

5 actions · phrasing · square-transactions-api-openapi.yml

GENERATED

Square V1Transactions Api Phrasing Overlay

4 actions · phrasing · square-v1transactions-api-openapi.yml

GENERATED

Square Vendors Api Phrasing Overlay

8 actions · phrasing · square-vendors-api-openapi.yml

GENERATED

Square Webhook Subscriptions Api Phrasing Overlay

9 actions · phrasing · square-webhook-subscriptions-api-openapi.yml

GENERATED

Scroll for all 42

JSON Schema 207

Standalone JSON Schema definitions for this provider's data models.

Square Catalog Item

19 properties

JSON SCHEMA

Square Customer

19 properties

JSON SCHEMA

Square Location

27 properties

JSON SCHEMA

Square Money

2 properties

JSON SCHEMA

Square Order

29 properties

JSON SCHEMA

Square Payment

38 properties

JSON SCHEMA

AcceptDisputeResponse

2 properties

JSON SCHEMA

BatchChangeInventoryRequest

3 properties

JSON SCHEMA

BatchRetrieveCatalogObjectsResponse

3 properties

JSON SCHEMA

BatchRetrieveInventoryChangesRequest

8 properties

JSON SCHEMA

BatchRetrieveInventoryChangesResponse

3 properties

JSON SCHEMA

BatchRetrieveInventoryCountsRequest

6 properties

JSON SCHEMA

BatchUpsertCatalogObjectsRequest

2 properties

JSON SCHEMA

BatchUpsertCatalogObjectsResponse

4 properties

JSON SCHEMA

BulkCreateVendorsRequest

1 properties

JSON SCHEMA

BulkCreateVendorsResponse

2 properties

JSON SCHEMA

BulkRetrieveBookingsResponse

2 properties

JSON SCHEMA

BulkRetrieveTeamMemberBookingProfilesResponse

2 properties

JSON SCHEMA

BulkRetrieveVendorsResponse

2 properties

JSON SCHEMA

BulkUpdateTeamMembersRequest

1 properties

JSON SCHEMA

BulkUpdateTeamMembersResponse

2 properties

JSON SCHEMA

BulkUpdateVendorsResponse

2 properties

JSON SCHEMA

BulkUpsertBookingCustomAttributesResponse

2 properties

JSON SCHEMA

BulkUpsertCustomerCustomAttributesRequest

1 properties

JSON SCHEMA

BulkUpsertCustomerCustomAttributesResponse

2 properties

JSON SCHEMA

BulkUpsertLocationCustomAttributesResponse

2 properties

JSON SCHEMA

BulkUpsertMerchantCustomAttributesResponse

2 properties

JSON SCHEMA

BulkUpsertOrderCustomAttributesResponse

2 properties

JSON SCHEMA

CalculateLoyaltyPointsRequest

3 properties

JSON SCHEMA

CalculateOrderResponse

2 properties

JSON SCHEMA

CancelInvoiceResponse

2 properties

JSON SCHEMA

CaptureTransactionResponse

1 properties

JSON SCHEMA

ChangeBillingAnchorDateResponse

3 properties

JSON SCHEMA

CloneOrderResponse

2 properties

JSON SCHEMA

CompletePaymentResponse

2 properties

JSON SCHEMA

CreateBookingCustomAttributeDefinitionRequest

2 properties

JSON SCHEMA

CreateCardRequest

4 properties

JSON SCHEMA

CreateCardResponse

2 properties

JSON SCHEMA

CreateCheckoutRequest

9 properties

JSON SCHEMA

CreateCheckoutResponse

2 properties

JSON SCHEMA

CreateCustomerCardRequest

4 properties

JSON SCHEMA

CreateCustomerCustomAttributeDefinitionRequest

2 properties

JSON SCHEMA

CreateCustomerGroupRequest

2 properties

JSON SCHEMA

CreateCustomerGroupResponse

2 properties

JSON SCHEMA

CreateCustomerRequest

12 properties

JSON SCHEMA

CreateDeviceCodeRequest

2 properties

JSON SCHEMA

CreateDeviceCodeResponse

2 properties

JSON SCHEMA

CreateDisputeEvidenceTextRequest

3 properties

JSON SCHEMA

CreateGiftCardActivityRequest

2 properties

JSON SCHEMA

CreateGiftCardActivityResponse

2 properties

JSON SCHEMA

CreateGiftCardRequest

3 properties

JSON SCHEMA

CreateInvoiceResponse

2 properties

JSON SCHEMA

CreateLocationCustomAttributeDefinitionRequest

2 properties

JSON SCHEMA

CreateLocationRequest

1 properties

JSON SCHEMA

CreateLocationResponse

2 properties

JSON SCHEMA

CreateMerchantCustomAttributeDefinitionRequest

2 properties

JSON SCHEMA

CreateMobileAuthorizationCodeRequest

1 properties

JSON SCHEMA

CreateMobileAuthorizationCodeResponse

3 properties

JSON SCHEMA

CreateOrderCustomAttributeDefinitionRequest

2 properties

JSON SCHEMA

CreateOrderResponse

2 properties

JSON SCHEMA

CreatePaymentLinkRequest

7 properties

JSON SCHEMA

CreatePaymentLinkResponse

3 properties

JSON SCHEMA

CreatePaymentRequest

25 properties

JSON SCHEMA

CreatePaymentResponse

2 properties

JSON SCHEMA

CreateShiftResponse

2 properties

JSON SCHEMA

CreateSubscriptionRequest

13 properties

JSON SCHEMA

CreateTeamMemberRequest

2 properties

JSON SCHEMA

CreateTeamMemberResponse

2 properties

JSON SCHEMA

CreateVendorRequest

2 properties

JSON SCHEMA

CreateWebhookSubscriptionResponse

2 properties

JSON SCHEMA

DeleteSnippetResponse

1 properties

JSON SCHEMA

DisableCardResponse

2 properties

JSON SCHEMA

DisableEventsResponse

1 properties

JSON SCHEMA

DismissTerminalCheckoutResponse

2 properties

JSON SCHEMA

DismissTerminalRefundResponse

2 properties

JSON SCHEMA

EnableEventsResponse

1 properties

JSON SCHEMA

GetBankAccountByV1IdResponse

2 properties

JSON SCHEMA

GetBankAccountResponse

2 properties

JSON SCHEMA

GetDeviceCodeResponse

2 properties

JSON SCHEMA

GetDeviceResponse

2 properties

JSON SCHEMA

GetInvoiceResponse

2 properties

JSON SCHEMA

GetPaymentRefundResponse

2 properties

JSON SCHEMA

GetPaymentResponse

2 properties

JSON SCHEMA

GetPayoutResponse

2 properties

JSON SCHEMA

GetShiftResponse

2 properties

JSON SCHEMA

GetTerminalRefundResponse

2 properties

JSON SCHEMA

LinkCustomerToGiftCardResponse

2 properties

JSON SCHEMA

ListBankAccountsResponse

3 properties

JSON SCHEMA

ListBookingCustomAttributeDefinitionsResponse

3 properties

JSON SCHEMA

ListBookingCustomAttributesResponse

3 properties

JSON SCHEMA

ListBookingsResponse

3 properties

JSON SCHEMA

ListCardsResponse

3 properties

JSON SCHEMA

ListCashDrawerShiftEventsResponse

3 properties

JSON SCHEMA

ListCustomerCustomAttributeDefinitionsResponse

3 properties

JSON SCHEMA

ListCustomerCustomAttributesResponse

3 properties

JSON SCHEMA

ListCustomerGroupsResponse

3 properties

JSON SCHEMA

ListCustomerSegmentsResponse

3 properties

JSON SCHEMA

ListCustomersResponse

4 properties

JSON SCHEMA

ListDeviceCodesResponse

3 properties

JSON SCHEMA

ListDevicesResponse

3 properties

JSON SCHEMA

ListDisputeEvidenceResponse

3 properties

JSON SCHEMA

ListDisputesResponse

3 properties

JSON SCHEMA

ListEmployeeWagesResponse

3 properties

JSON SCHEMA

ListEmployeesResponse

3 properties

JSON SCHEMA

ListEventTypesResponse

3 properties

JSON SCHEMA

ListGiftCardActivitiesResponse

3 properties

JSON SCHEMA

ListGiftCardsResponse

3 properties

JSON SCHEMA

ListInvoicesResponse

3 properties

JSON SCHEMA

ListLocationCustomAttributeDefinitionsResponse

3 properties

JSON SCHEMA

ListLocationCustomAttributesResponse

3 properties

JSON SCHEMA

ListLocationsResponse

2 properties

JSON SCHEMA

ListLoyaltyProgramsResponse

2 properties

JSON SCHEMA

ListLoyaltyPromotionsResponse

3 properties

JSON SCHEMA

ListMerchantCustomAttributeDefinitionsResponse

3 properties

JSON SCHEMA

ListMerchantCustomAttributesResponse

3 properties

JSON SCHEMA

ListMerchantsResponse

3 properties

JSON SCHEMA

ListOrderCustomAttributeDefinitionsResponse

3 properties

JSON SCHEMA

ListOrderCustomAttributesResponse

3 properties

JSON SCHEMA

ListPaymentLinksResponse

3 properties

JSON SCHEMA

ListPaymentRefundsResponse

3 properties

JSON SCHEMA

ListPaymentsResponse

3 properties

JSON SCHEMA

ListPayoutEntriesResponse

3 properties

JSON SCHEMA

ListPayoutsResponse

3 properties

JSON SCHEMA

ListSitesResponse

2 properties

JSON SCHEMA

ListSubscriptionEventsResponse

3 properties

JSON SCHEMA

ListTeamMemberBookingProfilesResponse

3 properties

JSON SCHEMA

ListTeamMemberWagesResponse

3 properties

JSON SCHEMA

ListTransactionsResponse

3 properties

JSON SCHEMA

ListWebhookEventTypesResponse

3 properties

JSON SCHEMA

ListWebhookSubscriptionsResponse

3 properties

JSON SCHEMA

ObtainTokenRequest

10 properties

JSON SCHEMA

ObtainTokenResponse

11 properties

JSON SCHEMA

PauseSubscriptionRequest

5 properties

JSON SCHEMA

PayOrderResponse

2 properties

JSON SCHEMA

PublishInvoiceResponse

2 properties

JSON SCHEMA

RefundPaymentRequest

13 properties

JSON SCHEMA

RefundPaymentResponse

2 properties

JSON SCHEMA

RegisterDomainRequest

1 properties

JSON SCHEMA

RegisterDomainResponse

2 properties

JSON SCHEMA

RetrieveCardResponse

2 properties

JSON SCHEMA

RetrieveCashDrawerShiftResponse

2 properties

JSON SCHEMA

RetrieveCustomerGroupResponse

2 properties

JSON SCHEMA

RetrieveCustomerSegmentResponse

2 properties

JSON SCHEMA

RetrieveDisputeResponse

2 properties

JSON SCHEMA

RetrieveEmployeeResponse

2 properties

JSON SCHEMA

RetrieveGiftCardFromGANResponse

2 properties

JSON SCHEMA

RetrieveGiftCardFromNonceResponse

2 properties

JSON SCHEMA

RetrieveInventoryAdjustmentResponse

2 properties

JSON SCHEMA

RetrieveInventoryChangesResponse

3 properties

JSON SCHEMA

RetrieveLocationResponse

2 properties

JSON SCHEMA

RetrieveLoyaltyProgramResponse

2 properties

JSON SCHEMA

RetrieveMerchantResponse

2 properties

JSON SCHEMA

RetrieveOrderResponse

2 properties

JSON SCHEMA

RetrieveSnippetResponse

2 properties

JSON SCHEMA

RetrieveTokenStatusResponse

5 properties

JSON SCHEMA

RetrieveTransactionResponse

2 properties

JSON SCHEMA

RetrieveWebhookSubscriptionResponse

2 properties

JSON SCHEMA

RevokeTokenRequest

4 properties

JSON SCHEMA

RevokeTokenResponse

2 properties

JSON SCHEMA

SearchAvailabilityResponse

2 properties

JSON SCHEMA

SearchCatalogItemsRequest

10 properties

JSON SCHEMA

SearchCatalogObjectsRequest

8 properties

JSON SCHEMA

SearchCatalogObjectsResponse

5 properties

JSON SCHEMA

SearchCustomersRequest

4 properties

JSON SCHEMA

SearchCustomersResponse

4 properties

JSON SCHEMA

SearchEventsRequest

3 properties

JSON SCHEMA

SearchEventsResponse

4 properties

JSON SCHEMA

SearchInvoicesResponse

3 properties

JSON SCHEMA

SearchLoyaltyEventsResponse

3 properties

JSON SCHEMA

SearchLoyaltyRewardsResponse

3 properties

JSON SCHEMA

SearchShiftsResponse

3 properties

JSON SCHEMA

SearchSubscriptionsRequest

4 properties

JSON SCHEMA

SearchSubscriptionsResponse

3 properties

JSON SCHEMA

SearchTeamMembersResponse

3 properties

JSON SCHEMA

SearchTerminalActionsResponse

3 properties

JSON SCHEMA

SearchTerminalCheckoutsResponse

3 properties

JSON SCHEMA

SearchTerminalRefundsResponse

3 properties

JSON SCHEMA

SearchVendorsResponse

3 properties

JSON SCHEMA

SubmitEvidenceResponse

2 properties

JSON SCHEMA

TestWebhookSubscriptionResponse

2 properties

JSON SCHEMA

UnlinkCustomerFromGiftCardResponse

2 properties

JSON SCHEMA

UpdateBookingCustomAttributeDefinitionRequest

2 properties

JSON SCHEMA

UpdateBookingResponse

2 properties

JSON SCHEMA

UpdateCustomerCustomAttributeDefinitionRequest

2 properties

JSON SCHEMA

UpdateCustomerGroupRequest

1 properties

JSON SCHEMA

UpdateCustomerGroupResponse

2 properties

JSON SCHEMA

UpdateCustomerRequest

12 properties

JSON SCHEMA

UpdateLocationCustomAttributeDefinitionRequest

2 properties

JSON SCHEMA

UpdateLocationRequest

1 properties

JSON SCHEMA

UpdateLocationResponse

2 properties

JSON SCHEMA

UpdateLocationSettingsResponse

2 properties

JSON SCHEMA

UpdateMerchantCustomAttributeDefinitionRequest

2 properties

JSON SCHEMA

UpdateOrderCustomAttributeDefinitionRequest

2 properties

JSON SCHEMA

UpdatePaymentResponse

2 properties

JSON SCHEMA

UpdateShiftResponse

2 properties

JSON SCHEMA

UpdateTeamMemberResponse

2 properties

JSON SCHEMA

UpdateWebhookSubscriptionResponse

2 properties

JSON SCHEMA

UpsertBookingCustomAttributeRequest

2 properties

JSON SCHEMA

UpsertLocationCustomAttributeRequest

2 properties

JSON SCHEMA

UpsertMerchantCustomAttributeRequest

2 properties

JSON SCHEMA

UpsertOrderCustomAttributeRequest

2 properties

JSON SCHEMA

UpsertSnippetRequest

1 properties

JSON SCHEMA

UpsertSnippetResponse

2 properties

JSON SCHEMA

V1Order

25 properties

JSON SCHEMA

V1UpdateOrderRequest

5 properties

JSON SCHEMA

VoidTransactionResponse

1 properties

JSON SCHEMA

Square Subscription

19 properties

JSON SCHEMA

Scroll for all 207

JSON Structure 7

JSON Structure definitions describing this provider's data shapes.

Catalog Item Structure

19 properties

JSON STRUCTURE

Customer Structure

19 properties

JSON STRUCTURE

Location Structure

27 properties

JSON STRUCTURE

Money Structure

2 properties

JSON STRUCTURE

Order Structure

29 properties

JSON STRUCTURE

Payment Structure

38 properties

JSON STRUCTURE

Subscription Structure

19 properties

JSON STRUCTURE

Scroll for all 7

Examples 7

Example request and response payloads for these APIs.

Catalog Item Example

19 fields

EXAMPLE

Customer Example

19 fields

EXAMPLE

Location Example

27 fields

EXAMPLE

Money Example

2 fields

EXAMPLE

Order Example

29 fields

EXAMPLE

Payment Example

38 fields

EXAMPLE

Subscription Example

19 fields

EXAMPLE

Scroll for all 7

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Square Authentication

apiKey/oauth2 · 2 schemes

SECURITY

Square Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Square Trust Center

PCI DSS, PCI SAQ A, ISO 27001, EMVCo

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Square Scopes

58 scopes · authorizationCode

58 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Square Agentic Access

305 operations · 170 acting · 3 human-in-the-loop

305 operations · 170 acting

AGENTIC

Use Cases 11

What developers build with this provider.

Accept Payments Online

Build Custom POS Systems

Manage Product Catalogs

Track Inventory Across Locations

Create Loyalty and Rewards Programs

Send and Manage Invoices

Schedule Appointments and Bookings

Manage Team Members and Labor

Process Refunds and Disputes

Sell Gift Cards

Set Up Recurring Subscriptions

Scroll for all 11

Integrations 8

Pre-built integrations with other platforms and tools.

Apple Pay

Google Pay

Cash App Pay

Afterpay

QuickBooks

WooCommerce

Wix

BigCommerce

Scroll for all 8

Resources

Get Started 9

Portal, sign-up, and the first successful call

SignUp

Portal

GettingStarted

Sandbox

GettingStarted

Console

Console

Signup

Sandbox

Scroll for all 9

Documentation 15

Reference material describing how the API behaves

Documentation

APIReference

AsyncAPI

Documentation

Documentation

OpenAPI

JSONSchema

JSONSchema

JSONSchema

JSONSchema

JSONSchema

JSONSchema

JSONSchema

OpenAPI

MCP Server Documentation

Documentation

Scroll for all 15

Agent Surfaces 5

MCP servers, agent skills, and machine-readable catalogs

LLMsTxt

WellKnown

AgenticAccess

MCPServer

LlmsText

Design & Contract 23

Pagination, idempotency, versioning, errors, and events

Lifecycle

Spectral

Spectral

Spectral

Spectral

Vocabulary

Webhooks

Idempotency

Conformance

Webhooks

JSONLD

Rules

Vocabulary

JSONStructure

JSONStructure

JSONStructure

JSONStructure

JSONStructure

JSONStructure

JSONStructure

Conventions

Components

DataModel

Scroll for all 23

Build 33

SDKs, sample code, and the tooling you integrate with

IntegrationEdges

Packages

PostmanWorkspace

SDKs

SDKs

GitHubOrganization

SDKs

SDKs

SDKs

SDKs

SDKs

SDKs

SDKs

SDKs

CodeExamples

SDKs

SDKs

SDKs

SDKs

SDKs

CodeExamples

CodeExamples

MCP Server

Remote MCP Server (Hosted)

MCP Server (npm)

Examples

Examples

Examples

Examples

Examples

Examples

Examples

DeclineCodes

Scroll for all 33

Access & Security 6

Authentication, authorization, and security posture

Compliance

DomainSecurity

Authentication

OAuthScopes

Authentication

TrustCenter

Operate 10

Status, limits, changes, and where to get help

DeprecationPolicy

ChangeLog

RateLimits

Support

Support

StatusPage

StackOverflow

Support

RateLimits

ChangeLog

Scroll for all 10

Commercial 6

Pricing, plans, and the legal terms of use

Pricing

Pricing

TermsOfService

PrivacyPolicy

Plans

FinOps

Company 5

The organization behind the API

Newsroom

Newsroom

Website

Website

LinkedIn

Blog

Blog

Partners

Partners

Other 5

Properties that don't map to a standard resource type

Overlay

Hosts

Vendors

CapabilityMap

Source (apis.yml)

aid: square
url: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/apis.yml
name: Square
tags:
- Booking
- Location
- Square
- Restaurant
- Catalog
- Checkout
- Customers
- Disputes
- E-Commerce
- Financial Technology
- Gift Cards
- Inventory
- Invoicing
- Labor
- Loyalty
- Merchants
- Order
- Payments
- Point-of-Sale
- Refunds
- Retail
- Subscription
- Team
- Webhook
- Payment Processing
- Payment Terminals
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://images.squarespace-cdn.com/content/v1/5e3b09f5e4e7d30f0b8c8e8f/square-logo.png
access: 3rd-Party
created: '2025-02-08'
modified: '2026-06-03'
position: Consuming
description: Square provides APIs for payment processing, point of sale, and business management solutions enabling developers
  to build custom commerce applications.
maintainers:
- name: Kin Lane
  email: kin@apievangelist.com
- name: Square, Inc.
  email: developers@squareup.com
  url: https://squareup.com
specificationVersion: '0.23'
common:
- type: Lifecycle
  url: lifecycle/square-lifecycle.yml
- type: Spectral
  url: rules/square-spectral-rules.yml
- type: Spectral
  url: rules/square-rules.yml
- type: Spectral
  url: rules/square-jsonschema-spectral-rules.yml
- type: Spectral
  url: rules/square-asyncapi-spectral-rules.yml
- type: Vocabulary
  url: vocabulary/square-vocabulary.yml
- type: Webhooks
  url: asyncapi/square-webhooks-asyncapi.yml
- type: Idempotency
  url: conventions/square-conventions.yml
- type: Compliance
  url: https://squareup.com/us/en/payments/secure
- type: Conformance
  url: conformance/square-conformance.yml
- type: Overlay
  url: overlays/square-apple-pay-api-phrasing-overlay.yaml
- type: LLMsTxt
  url: llms/square-llms.txt
- type: WellKnown
  url: well-known/square-well-known.yml
- type: Hosts
  url: hosts/square-hosts.yml
- type: IntegrationEdges
  url: integrations/square-integration-edges.yml
- type: Vendors
  url: vendors/square-vendors.yml
- type: Packages
  url: packages/square-packages.yml
- type: SignUp
  url: https://squareup.com/signup
- type: Newsroom
  url: https://community.squareup.com/t5/News/ct-p/news
- type: Pricing
  url: https://squareup.com/us/en/pricing
- type: Website
  url: https://www.squareup.com/
- type: CapabilityMap
  url: capabilities/square-capability-edges.yml
  name: Square Business Capability Map
- type: DeprecationPolicy
  url: https://developer.squareup.com/reference/square/deprecated
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/square/overview
- type: AgenticAccess
  url: agentic-access/square-agentic-access.yml
- type: DomainSecurity
  url: security/square-domain-security.yml
- type: Authentication
  url: authentication/square-authentication.yml
- type: OAuthScopes
  url: scopes/square-scopes.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/joinsquare
- url: https://developer.squareup.com/us/en
  type: Portal
- url: https://developer.squareup.com/docs
  type: Documentation
- url: https://developer.squareup.com/reference/square
  type: APIReference
- url: https://developer.squareup.com/docs/square-get-started
  type: GettingStarted
- url: https://developer.squareup.com/docs/oauth-api/overview
  type: Authentication
- url: https://developer.squareup.com/docs/changelog/connect
  type: ChangeLog
- url: https://developer.squareup.com/docs/sdks
  type: SDKs
- url: https://developer.squareup.com/docs/devtools/postman
  type: SDKs
- url: https://developer.squareup.com/docs/webhooks/webhook-subscriptions-api
  type: Webhooks
- url: asyncapi/square-webhooks-asyncapi.yml
  type: AsyncAPI
- url: https://developer.squareup.com/docs/devtools/sandbox/overview
  type: Sandbox
- url: https://developer.squareup.com/docs/build-basics/api-rate-limits
  type: RateLimits
- url: https://developer.squareup.com/docs/build-basics/api-lifecycle
  type: Documentation
- url: https://developer.squareup.com/docs/buildbasics
  type: GettingStarted
- url: https://developer.squareup.com/docs/development-essentials
  type: Documentation
- url: https://developer.squareup.com/explorer/square
  type: Console
- url: https://developer.squareup.com/docs/devtools/developer-dashboard
  type: Console
- url: https://developer.squareup.com/apps
  type: Signup
- url: https://developer.squareup.com/blog/
  type: Blog
- url: https://developer.squareup.com/forums/
  type: Support
- url: https://squareup.com/us/en/pricing
  type: Pricing
- url: https://squareup.com/us/en/legal/general/ua
  type: TermsOfService
- url: https://squareup.com/us/en/legal/general/privacy
  type: PrivacyPolicy
- url: https://squareup.com/help/us/en
  type: Support
- url: https://squareup.com/us/en/partnerships
  type: Partners
- url: https://www.issquareup.com/
  type: StatusPage
- url: https://github.com/square
  type: GitHubOrganization
- url: https://github.com/square/connect-api-specification
  type: OpenAPI
- url: https://stackoverflow.com/questions/tagged/square-connect
  type: StackOverflow
- url: https://x.com/SquareDev
  type: X
- url: https://discord.com/invite/squaredev
  type: Support
- url: json-schema/payment.json
  type: JSONSchema
- url: json-schema/money.json
  type: JSONSchema
- url: json-schema/order.json
  type: JSONSchema
- url: json-schema/catalog-item.json
  type: JSONSchema
- url: json-schema/customer.json
  type: JSONSchema
- url: json-schema/location.json
  type: JSONSchema
- url: json-schema/subscription.json
  type: JSONSchema
- url: json-ld/square-context.jsonld
  type: JSONLD
- name: Features
  type: Features
  data:
  - 'Tap/dip/swipe: 2.6%+15¢ Free, 2.5%+15¢ Plus, 2.4%+15¢ Premium'
  - 'Online (Square site): 3.3%+30¢ Free, 2.9%+30¢ Plus/Premium'
  - 'Online API: 2.9%+30¢ all plans'
  - 'Manual entry/card on file: 3.5%+15¢ all plans'
  - 'ACH (invoice): 1% $1 min ($10 cap on Plus/Premium)'
  - 'ACH (API): 1% $1 min, $5 cap'
  - 'Afterpay BNPL: 6%+30¢'
  - 'Cash/check: free'
  - 'Bitcoin: 0% until 2027'
  - 'International cards: +1.50% on top'
  - Square Payments, POS, Online, Invoices, Subscriptions APIs
  - Square Reader/Stand/Terminal/Register hardware
  - Webhooks for transactions, customers, orders
  - OAuth 2.0 + Personal access tokens
  - Catalog API for items, categories, taxes, modifiers
  - Customer Directory API
  sources:
  - https://squareup.com/us/en/payments/our-fees
  updated: '2026-05-04'
- name: Use Cases
  type: UseCases
  data:
  - name: Accept Payments Online
  - name: Build Custom POS Systems
  - name: Manage Product Catalogs
  - name: Track Inventory Across Locations
  - name: Create Loyalty and Rewards Programs
  - name: Send and Manage Invoices
  - name: Schedule Appointments and Bookings
  - name: Manage Team Members and Labor
  - name: Process Refunds and Disputes
  - name: Sell Gift Cards
  - name: Set Up Recurring Subscriptions
- name: Integrations
  type: Integrations
  data:
  - name: Apple Pay
  - name: Google Pay
  - name: Cash App Pay
  - name: Afterpay
  - name: QuickBooks
  - name: WooCommerce
  - name: Wix
  - name: BigCommerce
- name: Square Python SDK
  type: SDKs
  url: https://github.com/square/square-python-sdk
- name: Square Node.js SDK
  type: SDKs
  url: https://github.com/square/square-nodejs-sdk
- name: Square Java SDK
  type: SDKs
  url: https://github.com/square/square-java-sdk
- name: Square .NET SDK
  type: SDKs
  url: https://github.com/square/square-dotnet-sdk
- name: Square Ruby SDK
  type: SDKs
  url: https://github.com/square/square-ruby-sdk
- name: Square PHP SDK
  type: SDKs
  url: https://github.com/square/square-php-sdk
- name: Square Go SDK
  type: SDKs
  url: https://github.com/square/square-go-sdk
- name: Square Web SDK
  type: SDKs
  url: https://github.com/square/web-sdk
- name: Square Web Payments SDK Quickstart
  type: CodeExamples
  url: https://github.com/square/web-payments-quickstart
- name: Square Mobile Payments SDK (iOS)
  type: SDKs
  url: https://github.com/square/mobile-payments-sdk-ios
- name: Square Mobile Payments SDK (Android)
  type: SDKs
  url: https://github.com/square/mobile-payments-sdk-android
- name: Square Mobile Payments SDK (Flutter)
  type: SDKs
  url: https://github.com/square/mobile-payments-sdk-flutter
- name: Square Mobile Payments SDK (React Native)
  type: SDKs
  url: https://github.com/square/mobile-payments-sdk-react-native
- name: Square In-App Payments React Native Plugin
  type: SDKs
  url: https://github.com/square/in-app-payments-react-native-plugin
- name: Square In-App Payments Quickstart (iOS)
  type: CodeExamples
  url: https://github.com/square/in-app-payments-ios-quickstart
- name: Square In-App Payments Quickstart (Android)
  type: CodeExamples
  url: https://github.com/square/in-app-payments-android-quickstart
- name: Connect API Specification
  type: OpenAPI
  url: https://github.com/square/connect-api-specification
- url: rules/square-spectral-rules.yml
  type: Rules
- url: vocabulary/square-vocabulary.yaml
  type: Vocabulary
- name: MCP Server
  url: https://github.com/square/square-mcp-server
  type: MCPServer
- type: Tools
  title: MCP Server
  url: https://github.com/square/square-mcp-server
- type: Tools
  title: Remote MCP Server (Hosted)
  url: https://mcp.squareup.com/sse
- type: Documentation
  title: MCP Server Documentation
  url: https://developer.squareup.com/docs/mcp
- type: SDKs
  title: MCP Server (npm)
  url: https://www.npmjs.com/package/square-mcp-server
- type: LlmsText
  url: https://developer.squareup.com/llms.txt
- url: json-structure/catalog-item-structure.json
  type: JSONStructure
- url: json-structure/customer-structure.json
  type: JSONStructure
- url: json-structure/location-structure.json
  type: JSONStructure
- url: json-structure/money-structure.json
  type: JSONStructure
- url: json-structure/order-structure.json
  type: JSONStructure
- url: json-structure/payment-structure.json
  type: JSONStructure
- url: json-structure/subscription-structure.json
  type: JSONStructure
- url: examples/catalog-item-example.json
  type: Examples
- url: examples/customer-example.json
  type: Examples
- url: examples/location-example.json
  type: Examples
- url: examples/money-example.json
  type: Examples
- url: examples/order-example.json
  type: Examples
- url: examples/payment-example.json
  type: Examples
- url: examples/subscription-example.json
  type: Examples
- url: plans/square-plans-pricing.yml
  type: Plans
- url: rate-limits/square-rate-limits.yml
  type: RateLimits
- url: finops/square-finops.yml
  type: FinOps
- url: sandbox/square-sandbox.yml
  type: Sandbox
- url: conventions/square-conventions.yml
  type: Conventions
- url: changelog/square-changelog.yml
  type: ChangeLog
- url: components/square-components.yml
  type: Components
- url: data-model/square-data-model.yml
  type: DataModel
- url: errors/square-decline-codes.yml
  type: DeclineCodes
- url: security/square-trust-center.yml
  type: TrustCenter
apis:
- aid: square:reporting-api
  name: Square Reporting API
  tags:
  - Analytics
  - Business Intelligence
  - Reporting
  humanURL: https://developer.squareup.com/docs/reporting-api
  properties:
  - url: https://developer.squareup.com/docs/reporting-api
    type: Documentation
  - url: https://developer.squareup.com/reference/square/reporting-api
    type: APIReference
  description: The Reporting API (Beta) provides a new way to access all of a business's data to build custom reports and
    integrations, surfacing sales, payments, and operational metrics across a seller's Square account.
- aid: square:channels-api
  name: Square Channels API
  tags:
  - Commerce
  - Omnichannel
  - Sales Channels
  humanURL: https://developer.squareup.com/docs/channels-api/overview
  properties:
  - url: https://developer.squareup.com/docs/channels-api/overview
    type: Documentation
  - url: https://developer.squareup.com/reference/square/channels-api
    type: APIReference
  description: The Channels API lets applications represent and manage the sales channels through which a seller transacts,
    enabling attribution of orders and payments to specific online or in-person channels.
- aid: square:transfer-orders-api
  name: Square Transfer Orders API
  tags:
  - Commerce
  - Inventory
  - Transfer Orders
  humanURL: https://developer.squareup.com/docs/transfer-orders-api/overview
  properties:
  - url: https://developer.squareup.com/docs/transfer-orders-api/overview
    type: Documentation
  - url: https://developer.squareup.com/reference/square/transfer-orders-api
    type: APIReference
  description: The Transfer Orders API lets applications create and manage transfers of inventory stock between a seller's
    locations, supporting multi-location retail and restaurant operations.
- aid: square:square-bookingcustomattributes-api
  name: Square BookingCustomAttributes API
  description: The BookingCustomAttributes API from Square — 6 operation(s) for bookingcustomattributes.
  humanURL: https://developer.squareup.com/docs/payments-overview
  tags:
  - BookingCustomAttributes
  properties:
  - type: OpenAPI
    url: openapi/square-bookingcustomattributes-api-openapi.yml
  - type: Documentation
    url: https://developer.squareup.com/docs/payments-overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/payments-api
  - type: Documentation
    url: https://developer.squareup.com/docs/orders-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/orders-api
  - type: Documentation
    url: https://developer.squareup.com/docs/catalog-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/catalog-api
  - type: Documentation
    url: https://developer.squareup.com/docs/inventory-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/inventory-api
  - type: Documentation
    url: https://developer.squareup.com/docs/customers
  - type: APIReference
    url: https://developer.squareup.com/reference/square/customers-api
  - type: Documentation
    url: https://developer.squareup.com/docs/locations-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/locations-api
  - type: Documentation
    url: https://developer.squareup.com/docs/team/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/team-api
  - type: Documentation
    url: https://developer.squareup.com/docs/labor-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/labor-api
  - type: Documentation
    url: https://developer.squareup.com/docs/bookings-api/what-it-is
  - type: APIReference
    url: https://developer.squareup.com/reference/square/bookings-api
  - type: Documentation
    url: https://developer.squareup.com/docs/loyalty-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/loyalty-api
  - type: Documentation
    url: https://developer.squareup.com/docs/gift-cards/using-gift-cards-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/gift-cards-api
  - type: Documentation
    url: https://developer.squareup.com/docs/invoices-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/invoices-api
  - type: Documentation
    url: https://developer.squareup.com/docs/subscriptions-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/subscriptions-api
  - type: Documentation
    url: https://developer.squareup.com/docs/checkout-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/checkout-api
  - type: Documentation
    url: https://developer.squareup.com/docs/terminal-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/terminal-api
  - type: Documentation
    url: https://developer.squareup.com/docs/payments-refunds
  - type: APIReference
    url: https://developer.squareup.com/reference/square/refunds-api
  - type: Documentation
    url: https://developer.squareup.com/docs/disputes-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/disputes-api
  - type: Documentation
    url: https://developer.squareup.com/docs/merchants-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/merchants-api
  - type: Documentation
    url: https://developer.squareup.com/docs/cards-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/cards-api
  - type: Documentation
    url: https://developer.squareup.com/docs/vendors-api/manage-vendors-in-apps
  - type: APIReference
    url: https://developer.squareup.com/reference/square/vendors-api
  - type: Documentation
    url: https://developer.squareup.com/docs/cashdrawershift-api/reporting
  - type: APIReference
    url: https://developer.squareup.com/reference/square/cash-drawers-api
  - type: Documentation
    url: https://developer.squareup.com/docs/bank-accounts-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/bank-accounts-api
  - type: Documentation
    url: https://developer.squareup.com/docs/payouts-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/payouts-api
  - type: Documentation
    url: https://developer.squareup.com/docs/web-payments/apple-pay
  - type: APIReference
    url: https://developer.squareup.com/reference/square/apple-pay-api
  - type: Documentation
    url: https://developer.squareup.com/docs/sites-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/sites-api
  - type: Documentation
    url: https://developer.squareup.com/docs/snippets-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/snippets-api
  - type: Documentation
    url: https://developer.squareup.com/docs/oauth-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/oauth-api
  - type: Documentation
    url: https://developer.squareup.com/docs/webhooks/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/webhook-subscriptions-api
  - type: AsyncAPI
    url: asyncapi/square-webhooks-asyncapi.yml
  - type: Documentation
    url: https://developer.squareup.com/docs/events-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/events-api
  - type: Documentation
    url: https://developer.squareup.com/docs/devices-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/devices-api
  - type: Documentation
    url: https://developer.squareup.com/docs/customer-groups-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/customer-groups-api
  - type: Documentation
    url: https://developer.squareup.com/docs/customer-segments-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/customer-segments-api
  - type: Documentation
    url: https://developer.squareup.com/docs/gift-cards/using-gift-card-activities-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/gift-card-activities-api
  - type: Documentation
    url: https://developer.squareup.com/docs/customer-custom-attributes-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/customer-custom-attributes-api
  - type: JSONSchema
    url: json-schema/square-bulk-upsert-booking-custom-attributes-response-schema.json
  - type: JSONSchema
    url: json-schema/square-list-booking-custom-attribute-definitions-response-schema.json
  - type: JSONSchema
    url: json-schema/square-list-booking-custom-attributes-response-schema.json
  - type: JSONSchema
    url: json-schema/square-update-booking-custom-attribute-definition-request-schema.json
  - type: JSONSchema
    url: json-schema/square-create-booking-custom-attribute-definition-request-schema.json
  - type: JSONSchema
    url: json-schema/square-upsert-booking-custom-attribute-request-schema.json
- aid: square:square-bookings-api
  name: Square Bookings API
  description: The Bookings API from Square — 11 operation(s) for bookings.
  humanURL: https://developer.squareup.com/docs/payments-overview
  tags:
  - Booking
  tags_raw:
  - Bookings
  properties:
  - type: OpenAPI
    url: openapi/square-bookings-api-openapi.yml
  - type: Documentation
    url: https://developer.squareup.com/docs/payments-overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/payments-api
  - type: Documentation
    url: https://developer.squareup.com/docs/orders-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/orders-api
  - type: Documentation
    url: https://developer.squareup.com/docs/catalog-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/catalog-api
  - type: Documentation
    url: https://developer.squareup.com/docs/inventory-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/inventory-api
  - type: Documentation
    url: https://developer.squareup.com/docs/customers
  - type: APIReference
    url: https://developer.squareup.com/reference/square/customers-api
  - type: Documentation
    url: https://developer.squareup.com/docs/locations-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/locations-api
  - type: Documentation
    url: https://developer.squareup.com/docs/team/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/team-api
  - type: Documentation
    url: https://developer.squareup.com/docs/labor-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/labor-api
  - type: Documentation
    url: https://developer.squareup.com/docs/bookings-api/what-it-is
  - type: APIReference
    url: https://developer.squareup.com/reference/square/bookings-api
  - type: Documentation
    url: https://developer.squareup.com/docs/loyalty-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/loyalty-api
  - type: Documentation
    url: https://developer.squareup.com/docs/gift-cards/using-gift-cards-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/gift-cards-api
  - type: Documentation
    url: https://developer.squareup.com/docs/invoices-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/invoices-api
  - type: Documentation
    url: https://developer.squareup.com/docs/subscriptions-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/subscriptions-api
  - type: Documentation
    url: https://developer.squareup.com/docs/checkout-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/checkout-api
  - type: Documentation
    url: https://developer.squareup.com/docs/terminal-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/terminal-api
  - type: Documentation
    url: https://developer.squareup.com/docs/payments-refunds
  - type: APIReference
    url: https://developer.squareup.com/reference/square/refunds-api
  - type: Documentation
    url: https://developer.squareup.com/docs/disputes-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/disputes-api
  - type: Documentation
    url: https://developer.squareup.com/docs/merchants-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/merchants-api
  - type: Documentation
    url: https://developer.squareup.com/docs/cards-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/cards-api
  - type: Documentation
    url: https://developer.squareup.com/docs/vendors-api/manage-vendors-in-apps
  - type: APIReference
    url: https://developer.squareup.com/reference/square/vendors-api
  - type: Documentation
    url: https://developer.squareup.com/docs/cashdrawershift-api/reporting
  - type: APIReference
    url: https://developer.squareup.com/reference/square/cash-drawers-api
  - type: Documentation
    url: https://developer.squareup.com/docs/bank-accounts-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/bank-accounts-api
  - type: Documentation
    url: https://developer.squareup.com/docs/payouts-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/payouts-api
  - type: Documentation
    url: https://developer.squareup.com/docs/web-payments/apple-pay
  - type: APIReference
    url: https://developer.squareup.com/reference/square/apple-pay-api
  - type: Documentation
    url: https://developer.squareup.com/docs/sites-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/sites-api
  - type: Documentation
    url: https://developer.squareup.com/docs/snippets-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/snippets-api
  - type: Documentation
    url: https://developer.squareup.com/docs/oauth-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/oauth-api
  - type: Documentation
    url: https://developer.squareup.com/docs/webhooks/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/webhook-subscriptions-api
  - type: AsyncAPI
    url: asyncapi/square-webhooks-asyncapi.yml
  - type: Documentation
    url: https://developer.squareup.com/docs/events-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/events-api
  - type: Documentation
    url: https://developer.squareup.com/docs/devices-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/devices-api
  - type: Documentation
    url: https://developer.squareup.com/docs/customer-groups-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/customer-groups-api
  - type: Documentation
    url: https://developer.squareup.com/docs/customer-segments-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/customer-segments-api
  - type: Documentation
    url: https://developer.squareup.com/docs/gift-cards/using-gift-card-activities-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/gift-card-activities-api
  - type: Documentation
    url: https://developer.squareup.com/docs/customer-custom-attributes-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/customer-custom-attributes-api
  - type: JSONSchema
    url: json-schema/square-search-availability-response-schema.json
  - type: JSONSchema
    url: json-schema/square-bulk-retrieve-bookings-response-schema.json
  - type: JSONSchema
    url: json-schema/square-bulk-retrieve-team-member-booking-profiles-response-schema.json
  - type: JSONSchema
    url: json-schema/square-list-bookings-response-schema.json
  - type: JSONSchema
    url: json-schema/square-list-team-member-booking-profiles-response-schema.json
  - type: JSONSchema
    url: json-schema/square-update-booking-response-schema.json
- aid: square:square-cards-api
  name: Square Cards API
  description: The Cards API from Square — 3 operation(s) for cards.
  humanURL: https://developer.squareup.com/docs/payments-overview
  tags:
  - Cards
  properties:
  - type: OpenAPI
    url: openapi/square-cards-api-openapi.yml
  - type: Documentation
    url: https://developer.squareup.com/docs/payments-overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/payments-api
  - type: Documentation
    url: https://developer.squareup.com/docs/orders-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/orders-api
  - type: Documentation
    url: https://developer.squareup.com/docs/catalog-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/catalog-api
  - type: Documentation
    url: https://developer.squareup.com/docs/inventory-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/inventory-api
  - type: Documentation
    url: https://developer.squareup.com/docs/customers
  - type: APIReference
    url: https://developer.squareup.com/reference/square/customers-api
  - type: Documentation
    url: https://developer.squareup.com/docs/locations-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/locations-api
  - type: Documentation
    url: https://developer.squareup.com/docs/team/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/team-api
  - type: Documentation
    url: https://developer.squareup.com/docs/labor-api/what-it-does
  - type: APIReference
    url: https://developer.squareup.com/reference/square/labor-api
  - type: Documentation
    url: https://developer.squareup.com/docs/bookings-api/what-it-is
  - type: APIReference
    url: https://developer.squareup.com/reference/square/bookings-api
  - type: Documentation
    url: https://developer.squareup.com/docs/loyalty-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/loyalty-api
  - type: Documentation
    url: https://developer.squareup.com/docs/gift-cards/using-gift-cards-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/gift-cards-api
  - type: Documentation
    url: https://developer.squareup.com/docs/invoices-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/invoices-api
  - type: Documentation
    url: https://developer.squareup.com/docs/subscriptions-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/subscriptions-api
  - type: Documentation
    url: https://developer.squareup.com/docs/checkout-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/checkout-api
  - type: Documentation
    url: https://developer.squareup.com/docs/terminal-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/terminal-api
  - type: Documentation
    url: https://developer.squareup.com/docs/payments-refunds
  - type: APIReference
    url: https://developer.squareup.com/reference/square/refunds-api
  - type: Documentation
    url: https://developer.squareup.com/docs/disputes-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/disputes-api
  - type: Documentation
    url: https://developer.squareup.com/docs/merchants-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/merchants-api
  - type: Documentation
    url: https://developer.squareup.com/docs/cards-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/cards-api
  - type: Documentation
    url: https://developer.squareup.com/docs/vendors-api/manage-vendors-in-apps
  - type: APIReference
    url: https://developer.squareup.com/reference/square/vendors-api
  - type: Documentation
    url: https://developer.squareup.com/docs/cashdrawershift-api/reporting
  - type: APIReference
    url: https://developer.squareup.com/reference/square/cash-drawers-api
  - type: Documentation
    url: https://developer.squareup.com/docs/bank-accounts-api
  - type: APIReference
    url: https://developer.squareup.com/reference/square/bank-accounts-api
  - type: Documentation
    url: https://developer.squareup.com/docs/payouts-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/payouts-api
  - type: Documentation
    url: https://developer.squareup.com/docs/web-payments/apple-pay
  - type: APIReference
    url: https://developer.squareup.com/reference/square/apple-pay-api
  - type: Documentation
    url: https://developer.squareup.com/docs/sites-api/overview
  - type: APIReference
    url: https://developer.squareup.com/reference/square/sites-api


# --- truncated at 32 KB (322 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/apis.yml

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/square"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/square/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/square/evidence"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.