Square

Beta

Accept in-person and online payments, and manage orders, inventory, and customers with Square.

Create Payment

Charge a card and take a payment

Action

Get Payment

Retrieve a payment by ID

Action

List Payments

List payments taken by the account, most recent first

Action

Cancel Payment

Cancel a payment that has not been captured yet

Action

Complete Payment

Capture an approved payment

Action

Refund Payment

Refund a completed payment, in full or in part

Action

List Refunds

List refunds for the account, most recent first

Action

Get Refund

Retrieve a refund by ID

Action

Create Order

Create an order with line items for a location

Action

Retrieve Order

Retrieve an order by ID

Action

Update Order

Change line items on an open order

Action

Search Orders

Search orders across locations by state

Action

Pay Order

Settle an order with approved payments

Action

Upsert Catalog Object

Create or update an item, category, tax, discount, or plan

Action

Delete Catalog Object

Delete a catalog object and its children

Action

Retrieve Catalog Object

Retrieve a catalog object by ID

Action

List Catalog

List catalog objects of the given types

Action

Search Catalog Objects

Search catalog objects by name or keyword

Action

Create Customer

Create a customer profile

Action

List Customers

List customer profiles on the account

Action

Get Customer

Retrieve a customer by ID

Action

Update Customer

Update a customer's details

Action

Delete Customer

Delete a customer profile

Action

Search Customers

Search customers by email, phone, or reference

Action

Retrieve Inventory Count

Retrieve stock levels for an item variation

Action

Batch Change Inventory

Adjust or recount stock for item variations

Action

Batch Retrieve Inventory Counts

Retrieve stock levels for several item variations at once

Action

Create Loyalty Account

Enroll a buyer in the loyalty program

Action

Retrieve Loyalty Account

Retrieve a loyalty account and its point balance

Action

Search Loyalty Accounts

Search loyalty accounts by customer

Action

Accumulate Loyalty Points

Add earned points to a loyalty account

Action

Create Loyalty Reward

Create a reward from a loyalty account's points

Action

Redeem Loyalty Reward

Redeem a loyalty reward against an order

Action

Create Subscription

Enroll a customer in a subscription plan

Action

Retrieve Subscription

Retrieve a subscription by ID

Action

Update Subscription

Change a subscription's plan or billing card

Action

Cancel Subscription

Cancel a subscription at the end of its billing cycle

Action

Search Subscriptions

Search subscriptions by customer or location

Action

Create Invoice

Create a draft invoice for an existing order

Action

Get Invoice

Retrieve an invoice by ID

Action

List Invoices

List invoices for a location

Action

Publish Invoice

Send a draft invoice to the customer

Action

Cancel Invoice

Cancel an invoice

Action

Create Payment Link

Create a hosted checkout link for a buyer to pay

Action

Payment Created

Fires when a payment is created

Trigger

Payment Updated

Fires when a payment changes

Trigger

Refund Created

Fires when a refund is created

Trigger

Refund Updated

Fires when a refund changes

Trigger

Order Created

Fires when an order is created

Trigger

Order Updated

Fires when an order changes

Trigger

Order Fulfillment Updated

Fires when an order's fulfillment state changes

Trigger

Customer Created

Fires when a customer profile is created

Trigger

Customer Updated

Fires when a customer profile changes

Trigger

Customer Deleted

Fires when a customer profile is deleted

Trigger

Invoice Created

Fires when an invoice is created

Trigger

Invoice Published

Fires when an invoice is sent to the customer

Trigger

Invoice Updated

Fires when an invoice changes

Trigger

Invoice Payment Made

Fires when a payment is made against an invoice

Trigger

Invoice Canceled

Fires when an invoice is canceled

Trigger

Invoice Refunded

Fires when an invoice is refunded in full or in part

Trigger

Catalog Version Updated

Fires when anything in the catalog changes

Trigger

Inventory Count Updated

Fires when stock levels change for an item variation

Trigger

Loyalty Account Created

Fires when a buyer is enrolled in the loyalty program

Trigger

Loyalty Event Created

Fires when a loyalty point balance changes

Trigger

Subscription Created

Fires when a subscription is created

Trigger

Subscription Updated

Fires when a subscription changes

Trigger

Dispute Created

Fires when a dispute is opened against a payment

Trigger

Dispute State Updated

Fires when a dispute's state changes

Trigger