BANK\_ACCOUNTS\_READ CUSTOMERS\_READ CUSTOMERS\_WRITE DISPUTES\_READ DISPUTES\_WRITE EMPLOYEES\_READ EMPLOYEES\_WRITE GIFTCARDS\_READ GIFTCARDS\_WRITE INVENTORY\_READ INVENTORY\_WRITE INVOICES\_READ INVOICES\_WRITE ITEMS\_READ ITEMS\_WRITE MERCHANT\_PROFILE\_READ MERCHANT\_PROFILE\_WRITE ORDERS\_READ ORDERS\_WRITE PAYMENTS\_READ PAYMENTS\_WRITE PAYOUTS\_READ SUBSCRIPTIONS\_READ SUBSCRIPTIONS\_WRITE TIMECARDS\_READ TIMECARDS\_SETTINGS\_READ TIMECARDS\_SETTINGS\_WRITE TIMECARDS\_WRITE

137 actions

Action

Description

Required scopes

List Payments

Retrieve a paginated list of payments taken by the account

Create Payment

Create a payment using a payment source such as a card or gift card

Get Payment

Retrieve details for a specific payment by ID

Update Payment

Update a payment with APPROVED status to modify tip or amount

Cancel Payment

Cancel (void) a payment by its ID

Cancel Payment By Idempotency Key

Cancel a payment using the original idempotency key when the payment ID is unknown

Complete Payment

Complete (capture) a payment that was created with autocomplete set to false

List Payment Refunds

Retrieve a paginated list of refunds for the account

Refund Payment

Refund a payment, either fully or partially

Get Payment Refund

Retrieve details of a specific refund by ID

Create Order

Create a new order for a location

Search Orders

Search for orders across one or more locations with filters

Retrieve Order

Retrieve an order by its ID

Update Order

Update an open order by adding, replacing, or deleting fields

Pay Order

Pay for an order using one or more approved payments

Calculate Order

Preview order pricing without creating an order

Batch Retrieve Orders

Retrieve multiple orders by their IDs in a single request

Clone Order

Create a new order by cloning an existing order

List Customers

Retrieve a paginated list of all customer profiles for the account

Create Customer

Create a new customer profile for the business

Search Customers

Search customer profiles by phone, email, name, or custom attributes

Retrieve Customer

Retrieve a specific customer profile by ID

Update Customer

Update an existing customer profile

Delete Customer

Delete a customer profile from the business

Add Group To Customer

Add a group membership to a customer profile

Remove Group From Customer

Remove a group membership from a customer profile

List Customer Groups

Retrieve a list of all customer groups for the business

Create Customer Group

Create a new customer group for the business

Retrieve Customer Group

Retrieve a specific customer group by ID

Update Customer Group

Update an existing customer group's name

Delete Customer Group

Delete a customer group from the business

Bulk Create Customers

Create up to 100 customer profiles in a single request

Bulk Retrieve Customers

Retrieve up to 100 customer profiles by ID in a single request

Bulk Update Customers

Update up to 100 customer profiles in a single request

Bulk Delete Customers

Delete up to 100 customer profiles in a single request

List Customer Segments

Retrieve a list of all customer segments for the business

Retrieve Customer Segment

Retrieve a specific customer segment by ID

List Catalog

Retrieve a paginated list of all catalog objects for the account

Search Catalog Objects

Search for catalog objects of any type (items, categories, taxes, discounts, etc.) using advanced query filters

Search Catalog Items

Search specifically for catalog items and item variations only (not taxes, categories, or discounts) by text, category,...

Retrieve Catalog Object

Retrieve a single catalog object by ID

Upsert Catalog Object

Create or update a single catalog object

Delete Catalog Object

Delete a single catalog object and its children

Batch Upsert Catalog Objects

Create or update up to 10,000 catalog objects in a single request

Batch Retrieve Catalog Objects

Retrieve multiple catalog objects by their IDs in a single request

Batch Delete Catalog Objects

Delete multiple catalog objects in a single request

Retrieve Inventory Count

Retrieve current inventory counts for a specific catalog object

Batch Retrieve Inventory Counts

Retrieve current inventory counts for multiple catalog objects at specific locations

Batch Retrieve Inventory Changes

Retrieve a list of inventory changes for catalog objects at specific locations

Retrieve Inventory Adjustment

Retrieve a specific inventory adjustment by its ID

Retrieve Inventory Physical Count

Retrieve a specific inventory physical count record by its ID

Batch Change Inventory

Apply adjustments and counts to catalog object quantities

List Locations

Retrieve all seller locations for the account

Create Location

Create a new location for the seller account

Retrieve Location

Retrieve details of a specific location by ID

Update Location

Update an existing location's settings and information

List Merchants

Retrieve the merchant profile for the account

Retrieve Merchant

Retrieve a specific merchant's profile by ID

List Payouts

Retrieve a paginated list of all payouts for the seller's default or specified location

Get Payout

Retrieve details of a specific payout by its ID

List Payout Entries

Retrieve all payout entries for a specific payout

List Invoices

Retrieve a list of invoices for a given location

Create Invoice

Create a draft invoice for an order

Search Invoices

Search for invoices by location, customer, or status

Get Invoice

Retrieve an invoice by its ID

Update Invoice

Update a draft or scheduled invoice

Delete Invoice

Delete a draft invoice

Publish Invoice

Publish a draft invoice to send it to the customer

Cancel Invoice

Cancel a published invoice

Create Subscription

Enroll a customer in a subscription plan

Search Subscriptions

Search for subscriptions by customer, location, or plan

Retrieve Subscription

Retrieve a specific subscription by ID

Update Subscription

Modify or clear field values on an active subscription

Cancel Subscription

Schedule a cancellation for an active subscription

List Subscription Events

Retrieve a paginated list of events for a specific subscription

Resume Subscription

Resume a paused or canceled subscription

List Cards

Retrieve a list of saved payment cards (credit/debit cards on file, not gift cards) for the account

Create Card

Add a card on file to an existing customer or merchant

Retrieve Card

Retrieve details of a specific card on file by ID

Disable Card

Disable a card on file to prevent further charges

List Gift Cards

Retrieve a list of gift cards for the account

Create Gift Card

Create a digital gift card or register a physical gift card

Retrieve Gift Card

Retrieve a gift card by its ID

Retrieve Gift Card From GAN

Retrieve a gift card using the gift card account number (GAN)

Link Customer To Gift Card

Link a customer to a gift card to associate it with their account

Unlink Customer From Gift Card

Unlink a customer from a gift card to remove the association

Create Gift Card Activity

Create an activity (activate, load, redeem, adjust, etc.) on a gift card

List Gift Card Activities

Retrieve a list of gift card activities for a specific gift card or across all gift cards

Create Team Member

Create a new team member for the seller account

Search Team Members

Search for team members by location, status, or other criteria

Retrieve Team Member

Retrieve a team member by ID

Update Team Member

Update an existing team member's information

List Jobs

Retrieve a list of all jobs defined for the seller account

Create Job

Create a new job definition for the seller account

Retrieve Job

Retrieve a specific job definition by its ID

Update Job

Update an existing job definition by its ID

Retrieve Wage Setting

Retrieve the wage setting for a team member

Update Wage Setting

Create or update the wage setting for a team member

Bulk Create Team Members

Create multiple team members in a single request

Bulk Update Team Members

Update multiple team members in a single request

List Break Types

Retrieve a list of all break types for the seller account

Create Break Type

Create a new break type for team member shifts

Retrieve Break Type

Retrieve a specific break type by ID

Search Timecards

Search for timecard records with filters for team member and date range

Retrieve Timecard

Retrieve a specific timecard by ID

Create Timecard

Create a new timecard for a team member at a location

Update Break Type

Update an existing break type by ID

Delete Break Type

Delete a break type by ID

Update Timecard

Update an existing timecard by ID

Delete Timecard

Delete a timecard by ID

List Disputes

Retrieve a list of disputes associated with the account

Retrieve Dispute

Retrieve details about a specific dispute by ID

Accept Dispute

Accept the loss on a dispute without submitting evidence

List Dispute Evidence

Retrieve all evidence submitted for a dispute

Submit Evidence

Submit collected evidence to contest a dispute

List Bank Accounts

Retrieve a list of bank accounts linked to the Square account

Get Bank Account

Retrieve details of a specific bank account by ID

Create Dispute Evidence Text

Upload text-based evidence to contest a dispute

Retrieve Dispute Evidence

Retrieve metadata for a specific piece of dispute evidence

Delete Dispute Evidence

Remove a specific piece of evidence from a dispute before submission

List Payment Links

Retrieve a list of all payment links for the account

Create Payment Link

Create a Square-hosted checkout page with a shareable payment link

Retrieve Payment Link

Retrieve a specific payment link by its token ID

Update Payment Link

Update an existing payment link's settings

Delete Payment Link

Delete a payment link permanently

Get Unified Credentials

Return the authenticated Square connection's identity (merchant business name), granted OAuth scopes, and auth\_type ("oa...

IAM Auth Test

Validate the current Square OAuth access token and return the raw, unmapped token status payload (scopes\[], expires\_at,...

List Unified Groups

List Square locations mapped to the IAM unified group schema. Each location represents a physical workplace (store, mobi...

Get Unified Group

Retrieve a single Square location by id, mapped to the IAM unified group schema. Field coverage matches unified\_list\_gro...

List Unified Organizations

Return the Square merchant for the current connection mapped to the IAM unified organization schema. Square is single-te...

Get Unified Organization

Retrieve a single Square merchant by id, mapped to the IAM unified organization schema. Square is single-tenant per OAut...

List Unified Resource Types

List unified resource types in Square.

List Unified Resource Users

List Square team members assigned to a specific location (resource\_type="location"), mapped to the IAM unified user sche...

List Unified Roles

Return the two stable workspace-level IAM roles (owner / team\_member) synthesized from Square's is\_owner flag on team me...

Get Unified Role

Retrieve a single synthesized Square IAM role by its stable key. Known keys are "owner" and "team\_member"; any other id...

List Unified Users

List Square team members mapped to the IAM unified user schema. Each member is annotated with a workspace-scoped role sy...

Get Unified User

Retrieve a single Square team member by team member id, mapped to the IAM unified user schema. Field coverage matches un...

## Events

Authorization Bank Accounts Bookings Cards Catalog Checkout Custom Attributes Customers Devices Disputes Gift Cards Inventory Invoices Jobs Locations Loyalty Orders Payments Payouts Refunds Scheduled Shifts Subscriptions Team Members Terminal Timecards Webhooks

96 events

Event

Description