- Category: payment processing
- Auth: OAUTH2
- Composio-managed OAuth available? Yes
- Tools: 122
- Triggers: 0
- Slug:
SQUARE - Version: 20261103_00
Tools
Accept Dispute
Accept Dispute
SQUARE_ACCEPT_DISPUTEAccepts a dispute, acknowledging liability and returning funds to the cardholder; acceptance is irreversible and requires DISPUTES_WRITE permission. Non-JSON responses, including HTTP failures, can produce an empty result, so check the returned dispute and errors.Input Parameters
Output
Add Group to Customer
Add Group to Customer
SQUARE_ADD_GROUP_TO_CUSTOMERTool to add a customer to a customer group. Use when you need to associate a customer with a specific group for targeted marketing, loyalty programs, or customer segmentation.Input Parameters
Output
Calculate Order
Calculate Order
SQUARE_CALCULATE_ORDERTool to preview order pricing without creating an order. Use when you need to calculate the total cost, taxes, discounts, and other pricing details for an order before finalizing it. Particularly useful for integrating rewards, discounts, and complex pricing scenarios.Input Parameters
Output
Cancel Booking
Cancel Booking
SQUARE_CANCEL_BOOKINGCancels an existing Square booking, terminating the reservation. Use this action when a customer or seller needs to cancel a scheduled appointment. The booking must be in a cancellable state, and the cancellation will update the booking status accordingly. This action is irreversible - once a booking is cancelled, it cannot be restored and must be rebooked if needed. Use the booking_version parameter to ensure safe concurrent updates.Input Parameters
Output
Cancel Invoice
Cancel Invoice
SQUARE_CANCEL_INVOICECancels a Square invoice, preventing further payments from being collected. Requirements: - Invoice must be in SCHEDULED, UNPAID, or PARTIALLY_PAID state - Cannot cancel invoices in DRAFT state or terminal states (PAID, REFUNDED, CANCELED, FAILED) - Requires INVOICES_WRITE and ORDERS_WRITE OAuth scopes - Version number must match the current invoice version to prevent conflicts After cancellation, the associated order status is set to CANCELED and webhook events are triggered.Input Parameters
Output
Cancel Payment
Cancel Payment
SQUARE_CANCEL_PAYMENTCancels (voids) a payment that is in APPROVED status. This is typically used in delayed capture scenarios where a payment was authorized but not yet captured, allowing you to void the authorization before settlement. Important: Only payments with APPROVED status can be canceled. Attempting to cancel a payment in any other status (COMPLETED, PENDING, CANCELED, FAILED) will result in an error. Once canceled, the payment status changes to CANCELED and the card details status changes to VOIDED. Required permissions: PAYMENTS_WRITEInput Parameters
Output
Batch Create Inventory Changes
Batch Create Inventory Changes
SQUARE_CREATE_BATCH_INVENTORY_CHANGESApplies multiple inventory adjustments and physical counts in a single batch request. Returns the created changes and current inventory counts for all affected items. Use this action when you need to update inventory quantities for multiple items or locations at once, either through physical stock counts or adjustments (e.g., receiving stock, recording waste, or correcting discrepancies). Supports up to 100 inventory changes per request. Each change can be either a PHYSICAL_COUNT (setting absolute quantity) or an ADJUSTMENT (modifying quantity with state transitions). The ignore_unchanged_counts parameter controls whether calculated counts are returned in the response.Input Parameters
Output
Create Bulk Customers
Create Bulk Customers
SQUARE_CREATE_BULK_CUSTOMERSTool to create multiple customer profiles in a single request. Use when you need to efficiently create up to 100 customers at once. Each customer is identified by a unique idempotency key.Input Parameters
Output
Create Card
Create Card
Create Customer
Create Customer
SQUARE_CREATE_CUSTOMERTool to create a new customer profile in Square. Use when you need to add a customer to the Square account. At least one of given_name, family_name, company_name, email_address, or phone_number is required.Input Parameters
Output
Create Customer Custom Attribute Definition
Create Customer Custom Attribute Definition
SQUARE_CREATE_CUSTOMER_CUSTOM_ATTRIBUTE_DEFINITIONTool to create a customer-related custom attribute definition. Use when you need to define a new custom attribute that can be applied to customer profiles. Custom attributes allow storing additional structured data on customers beyond the standard fields.Input Parameters
Output
Create Customer Group
Create Customer Group
SQUARE_CREATE_CUSTOMER_GROUPTool to create a new customer group for a business. Use when you need to organize customers into groups for targeted marketing or segmentation.Input Parameters
Output
Create Dispute Evidence File
Create Dispute Evidence File
SQUARE_CREATE_DISPUTE_EVIDENCE_FILEUploads a file as supporting evidence for an existing Square dispute, such as a PDF or image. File content can be supplied inline as base64, and an idempotency key identifies the upload.Input Parameters
Output
Create Dispute Evidence Text
Create Dispute Evidence Text
SQUARE_CREATE_DISPUTE_EVIDENCE_TEXTUpload text evidence for a dispute challenge. Use this to submit textual information (up to 500 characters) that supports your case in a payment dispute. After uploading all evidence, you must call SubmitEvidence to finalize the dispute challenge. Endpoint: POST /v2/disputes/{dispute_id}/evidence-textInput Parameters
Output
Create Gift Card Activity
Create Gift Card Activity
SQUARE_CREATE_GIFT_CARD_ACTIVITYCreates a gift card activity to manage gift card balances. This action supports multiple activity types including ACTIVATE (initiate a gift card with an opening balance), LOAD (add funds), REDEEM (withdraw funds), CLEAR_BALANCE (set balance to zero), DEACTIVATE (permanently block), ADJUST_INCREMENT/ADJUST_DECREMENT (manual adjustments), REFUND (restore funds from refunds), and others. Use this action when you need to modify a gift card’s balance or state. Each activity type requires specific details in the corresponding activity_details field (e.g., activate_activity_details for ACTIVATE type). Either gift_card_id or gift_card_gan must be provided to identify the target gift card. Important: DEACTIVATE and CLEAR_BALANCE are destructive operations - DEACTIVATE permanently blocks the card from future balance changes, and CLEAR_BALANCE sets the balance to zero.Input Parameters
Output
Create Invoice Attachment
Create Invoice Attachment
SQUARE_CREATE_INVOICE_ATTACHMENTUpload and attach a file to a Square invoice. Use this action to add supplementary documents (receipts, contracts, supporting documentation) to an existing invoice. Attachments can only be added to invoices in DRAFT, SCHEDULED, UNPAID, or PARTIALLY_PAID state. Square supports up to 10 attachments per invoice with a combined maximum size of 25 MB in production (1 KB in Sandbox). Supported file formats: GIF, JPEG, PNG, TIFF, BMP, PDF. Creating an attachment increments the invoice version and triggers an invoice.updated webhook event.Input Parameters
Output
Create Location
Create Location
Create Location Custom Attribute Definition
Create Location Custom Attribute Definition
Create Order
Create Order
SQUARE_CREATE_ORDERCreates a new Square order with line items, taxes, discounts, and fulfillment details. Use this action when you need to create an order for processing payments or tracking sales. The created order will have a state of DRAFT or OPEN depending on the configuration. Each line item must have a quantity and either a catalog_object_id (for catalog items) or both name and base_price_money (for custom items). You can optionally include taxes, discounts, service charges, and fulfillment information. Use when: Creating a new order for a customer transaction, building a cart for checkout, or initiating a sales order workflow.Input Parameters
Output
Create Refund
Create Refund
SQUARE_CREATE_REFUNDRefunds a Square payment in full or partially. Use this action when you need to return funds to a customer for a completed payment, such as for returned products, cancelled services, or billing errors. The refund amount cannot exceed the original payment total minus any prior refunds.Input Parameters
Output
Create Team Member
Create Team Member
SQUARE_CREATE_TEAM_MEMBERTool to create a new team member in Square. Creates a team member profile that can be used to assign permissions and track employee data. Use when you need to add a new employee or staff member to the Square account. The team member can then be assigned to locations and given access to Square products like Point of Sale. Requires given_name and family_name at minimum. Optionally specify email, phone, status (ACTIVE/INACTIVE), and location assignments.Input Parameters
Output
Delete Catalog Object
Delete Catalog Object
SQUARE_DELETE_CATALOG_OBJECTTool to delete a Square catalog object by ID. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (cascading deletion). Use this action when you need to permanently remove a catalog item, category, modifier, or other catalog object from Square. This action is irreversible — the catalog object cannot be recovered once deleted. Note: Only one delete request is processed at a time per seller account.Input Parameters
Output
Delete Catalog Objects (Batch)
Delete Catalog Objects (Batch)
SQUARE_DELETE_CATALOG_OBJECTS_BATCHDeletes a set of CatalogObjects based on a list of target object IDs and returns a set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. Use this action when you need to remove multiple catalog objects (items, categories, modifiers, etc.) at once. This action is irreversible — the catalog objects cannot be recovered once deleted.Input Parameters
Output
Delete Customer
Delete Customer
SQUARE_DELETE_CUSTOMERTool to delete a Square customer profile. Use when you need to permanently remove a customer record from Square.Input Parameters
Output
Delete Customer Custom Attribute
Delete Customer Custom Attribute
SQUARE_DELETE_CUSTOMER_CUSTOM_ATTRIBUTETool to delete a custom attribute from a customer profile. Use when you need to remove custom data associated with a specific customer. Requires the CUSTOMERS_WRITE OAuth permission scope.Input Parameters
Output
Delete Customer Custom Attribute Definition
Delete Customer Custom Attribute Definition
Delete Customer Group
Delete Customer Group
Bulk Delete Customers
Bulk Delete Customers
SQUARE_DELETE_CUSTOMERS_BULKTool to bulk delete customer profiles from Square. Use when you need to delete multiple customer profiles at once (1-100 customers per request). Each successful deletion returns an empty object; failed deletions include error details. Note that delete events trigger separate webhook notifications per customer.Input Parameters
Output
Delete Dispute Evidence
Delete Dispute Evidence
SQUARE_DELETE_DISPUTE_EVIDENCERemoves a specific piece of evidence from a dispute. Evidence that is removed will NOT be sent to the bank. This action requires the DISPUTES_WRITE permission scope. Important: You CANNOT remove evidence after it has been submitted to the bank using the SubmitEvidence endpoint. The deletion is permanent and cannot be undone. Use this when: - You need to remove evidence that was uploaded by mistake - You want to replace evidence with a better version (delete old, upload new) - The evidence is no longer relevant to the dispute case Prerequisites: - A valid dispute_id (obtain from list/retrieve disputes) - A valid evidence_id (obtain from list evidence or create evidence response) - The evidence must not have been submitted to the bank yetInput Parameters
Output
Delete Invoice
Delete Invoice
SQUARE_DELETE_INVOICETool to delete a Square invoice (only DRAFT invoices can be deleted).Input Parameters
Output
Delete Invoice Attachment
Delete Invoice Attachment
SQUARE_DELETE_INVOICE_ATTACHMENTTool to delete an attachment from a Square invoice. Endpoint: DELETE /v2/invoices/{invoice_id}/attachments/{attachment_id}Input Parameters
Output
Delete Location Custom Attribute
Delete Location Custom Attribute
SQUARE_DELETE_LOCATION_CUSTOM_ATTRIBUTETool to delete a custom attribute from a location. Use when you need to remove custom data associated with a specific business location. Requires the MERCHANT_PROFILE_WRITE OAuth permission scope.Input Parameters
Output
Delete Location Custom Attribute Definition
Delete Location Custom Attribute Definition
SQUARE_DELETE_LOCATION_CUSTOM_ATTRIBUTE_DEFINITIONTool to delete a location-related custom attribute definition. Once deleted, the custom attribute definition cannot be used to add custom attributes to locations. Use when you need to remove obsolete or incorrect custom attribute definitions from your Square account.Input Parameters
Output
Delete Locations Custom Attributes (Batch)
Delete Locations Custom Attributes (Batch)
SQUARE_DELETE_LOCATIONS_CUSTOM_ATTRIBUTES_BATCHTool to delete custom attributes from multiple locations in a single batch request. Use when you need to remove custom metadata from multiple business locations efficiently. To delete custom attributes owned by other applications, the attribute’s visibility must be set to VISIBILITY_READ_WRITE_VALUES.Input Parameters
Output
Delete Merchant Custom Attribute
Delete Merchant Custom Attribute
SQUARE_DELETE_MERCHANT_CUSTOM_ATTRIBUTETool to delete a custom attribute from a merchant profile. Use when you need to remove custom data associated with a specific merchant. Requires the MERCHANT_PROFILE_WRITE OAuth permission scope.Input Parameters
Output
Delete Merchant Custom Attribute Definition
Delete Merchant Custom Attribute Definition
SQUARE_DELETE_MERCHANT_CUSTOM_ATTRIBUTE_DEFINITIONTool to delete a merchant-related custom attribute definition. Once deleted, the custom attribute definition cannot be used to add custom attributes to merchants. Use when you need to remove obsolete or incorrect custom attribute definitions from your Square account.Input Parameters
Output
Delete Merchants Custom Attributes (Batch)
Delete Merchants Custom Attributes (Batch)
SQUARE_DELETE_MERCHANTS_CUSTOM_ATTRIBUTES_BATCHTool to delete custom attributes from multiple merchants in a single batch request. Use when you need to remove custom metadata from merchant profiles efficiently. To delete custom attributes owned by other applications, the attribute’s visibility must be set to VISIBILITY_READ_WRITE_VALUES.Input Parameters
Output
Delete Webhook Subscription
Delete Webhook Subscription
SQUARE_DELETE_WEBHOOK_SUBSCRIPTIONPermanently deletes a webhook subscription by its ID. Once deleted, the subscription will no longer receive event notifications. This action cannot be undone. Note: Webhook subscriptions are application-level resources and require personal access token authentication (not OAuth tokens).Input Parameters
Output
Get Booking
Get Booking
SQUARE_GET_BOOKINGRetrieves detailed information about a specific Square booking by its ID. Returns the complete booking object including appointment segments, customer notes, seller notes, location details, creator information, and current status. Use this action when you need to view or verify booking details for a known booking ID, check appointment times, or retrieve information about services and team members assigned to the booking. Required permission: APPOINTMENTS_READ (buyer-level) or both APPOINTMENTS_ALL_READ and APPOINTMENTS_READ (seller-level).Input Parameters
Output
Get Business Booking Profile
Get Business Booking Profile
SQUARE_GET_BUSINESS_BOOKING_PROFILETool to retrieve the business booking profile for a Square merchant via GraphQL. Use when you need to check if bookings are enabled, view cancellation policies, or access booking configuration settings. This is an alpha feature.Input Parameters
Output
Get Current Merchant
Get Current Merchant
SQUARE_GET_CURRENT_MERCHANTTool to retrieve merchant information associated with the access token using Square’s GraphQL API. Use when you need to obtain the merchant ID required for other GraphQL queries, or to get merchant details like business name, status, currency, and main location.Output
Get Customer Custom Attribute
Get Customer Custom Attribute
SQUARE_GET_CUSTOMER_CUSTOM_ATTRIBUTERetrieves a custom attribute from a customer profile in Square. Use this when you need to access specific custom data associated with a customer, such as preferences, external IDs, or other merchant-defined information. Requires CUSTOMERS_READ permission.Input Parameters
Output
Get Customer Custom Attribute Definition
Get Customer Custom Attribute Definition
SQUARE_GET_CUSTOMERS_CUSTOM_ATTRIBUTE_DEFINITIONSTool to retrieve a customer-related custom attribute definition from Square. Use when you need to fetch the schema, visibility, or metadata of a specific custom attribute definition by its key.Input Parameters
Output
Get Customers via GraphQL
Get Customers via GraphQL
SQUARE_GET_CUSTOMERS_GRAPHQLTool to retrieve customer profiles from Square Customer Directory using GraphQL API. Use when you need to fetch customer information including name, contact details, and profile data for a specific merchant. Requires merchant ID filter.Input Parameters
Output
Get Dispute Evidence
Get Dispute Evidence
SQUARE_GET_DISPUTE_EVIDENCERetrieves detailed information about a specific piece of evidence that was uploaded for a dispute. Use this action to: - Get metadata about evidence (file details, upload time, evidence type) - Verify evidence was uploaded successfully - Review evidence details before submitting a dispute response Note: This returns metadata only, not the actual file content. To upload evidence, use the Create Dispute Evidence File or Create Dispute Evidence Text actions. Endpoint: GET /v2/disputes/{dispute_id}/evidence/{evidence_id}Input Parameters
Output
Get Gift Card From GAN
Get Gift Card From GAN
SQUARE_GET_GIFT_CARD_FROM_GANRetrieves gift card information by its GAN (gift card account number), including available ID, type, state, balance, and associated customer IDs.Input Parameters
Output
Get Invoice
Get Invoice
SQUARE_GET_INVOICERetrieves detailed information about a specific Square invoice by its ID. Returns the complete invoice object including payment requests, recipient details, accepted payment methods, custom fields, attachments, and current status. Use this when you need to view or verify invoice details for a known invoice ID. Required permission: INVOICES_READInput Parameters
Output
Get Loyalty Account
Get Loyalty Account
SQUARE_GET_LOYALTY_ACCOUNTTool to retrieve detailed information about a specific Square loyalty account by ID. Use when you need to fetch loyalty account data including balance, lifetime points, customer association, and point expiration schedules. This action provides read-only access to loyalty program membership details.Input Parameters
Output
Get Merchant
Get Merchant
SQUARE_GET_MERCHANTTool to retrieve detailed information about a specific Square merchant by ID. Use when you need to fetch merchant profile data including business name, country, currency, and main location ID. Use ‘me’ as the merchant_id to retrieve the currently authenticated merchant.Input Parameters
Output
Get Online Checkout Location Settings
Get Online Checkout Location Settings
SQUARE_GET_ONLINE_CHECKOUT_LOCATION_SETTINGSTool to retrieve location-level settings for Square online checkout. Use when you need to get checkout configuration including customer notes, policies, branding, and tipping options for a specific location.Input Parameters
Output
Get Payment Refund
Get Payment Refund
SQUARE_GET_REFUNDRetrieves a specific payment refund by its unique ID from Square. Returns complete refund details including amount, status, associated payment and order IDs, and refund destination information. Use this action when you need to retrieve detailed information about a specific refund, such as verifying refund status, checking refund amounts, or accessing refund metadata for reconciliation or customer service purposes.Input Parameters
Output
Get Subscription
Get Subscription
SQUARE_GET_SUBSCRIPTIONRetrieves detailed information about a specific Square customer subscription by its ID. Use this action when you need to fetch subscription details including status, billing information, plan variation, associated customer, and scheduled actions. Returns comprehensive subscription data including payment information, invoices, phases, and configured actions. Required permission: SUBSCRIPTIONS_READ.Input Parameters
Output
Get Team Member
Get Team Member
SQUARE_GET_TEAM_MEMBERTool to retrieve detailed information about a specific Square team member by ID. Use when you need to fetch team member profile data including name, contact information, location assignments, and wage settings.Input Parameters
Output
Link Customer to Gift Card
Link Customer to Gift Card
SQUARE_LINK_CUSTOMER_TO_GIFT_CARDTool to link a customer to a gift card in Square. Links the customer profile to the gift card, adding their ID to the gift card’s customer_ids list. Use when you need to associate a customer with a gift card for tracking purchases, balances, or gifting purposes.Input Parameters
Output
List Cards
List Cards
SQUARE_LIST_CARDSTool to retrieve cards on file associated with a Square account. Use when you need to list saved payment methods for a merchant or customer for payment processing or management purposes. Returns a maximum of 25 cards per request with pagination support.Input Parameters
Output
List Channels
List Channels
SQUARE_LIST_CHANNELSTool to list requested channels from Square. Use when you need to retrieve channel information for a specific reference type, reference ID, or status.Input Parameters
Output
List Customer Custom Attribute Definitions
List Customer Custom Attribute Definitions
SQUARE_LIST_CUSTOMER_CUSTOM_ATTRIBUTE_DEFINITIONSTool to list customer-related custom attribute definitions from Square. Use when you need to discover available custom attributes that can be attached to customer profiles.Input Parameters
Output
List Customer Custom Attribute Definitions (GraphQL)
List Customer Custom Attribute Definitions (GraphQL)
SQUARE_LIST_CUSTOMER_CUSTOM_ATTRIBUTE_DEFINITIONS_GRAPH_QLQueries customer custom attribute definitions and their metadata via Square’s GraphQL API, filtered by the supplied merchant IDs. Alpha feature.Input Parameters
Output
List Customer Custom Attributes
List Customer Custom Attributes
SQUARE_LIST_CUSTOMER_CUSTOM_ATTRIBUTESLists a page of custom attributes for a customer profile, optionally including definitions that provide metadata about each attribute. Use the returned cursor to request additional pages.Input Parameters
Output
List Customer Groups
List Customer Groups
SQUARE_LIST_CUSTOMER_GROUPSTool to retrieve the list of customer groups of a business. Use when you need to discover customer group IDs or list all customer groups for segmentation and targeting purposes.Input Parameters
Output
List Customers
List Customers
SQUARE_LIST_CUSTOMERSTool to retrieve customer profiles associated with a Square account. Use when you need to list customers for CRM, reporting, or customer management purposes. Only returns profiles with public information (given_name, family_name, company_name, email_address, or phone_number).Input Parameters
Output
List Customer Segments
List Customer Segments
SQUARE_LIST_CUSTOMER_SEGMENTSTool to retrieve the list of customer segments of a business. Use when you need to discover customer segment IDs for targeting or filtering customer groups in Square.Input Parameters
Output
List Dispute Evidence
List Dispute Evidence
List Invoices
List Invoices
List Location Custom Attribute Definitions
List Location Custom Attribute Definitions
SQUARE_LIST_LOCATION_CUSTOM_ATTRIBUTE_DEFINITIONSTool to list location-related custom attribute definitions from Square. Use when you need to discover available custom attributes that can be attached to location profiles.Input Parameters
Output
List Locations
List Locations
List Locations Custom Attributes
List Locations Custom Attributes
SQUARE_LIST_LOCATIONS_CUSTOM_ATTRIBUTESLists a page of custom attributes for a specific Square location. Use the returned cursor to retrieve further pages; results can be filtered by visibility.Input Parameters
Output
List Merchant Custom Attribute Definitions
List Merchant Custom Attribute Definitions
SQUARE_LIST_MERCHANT_CUSTOM_ATTRIBUTE_DEFINITIONSTool to list merchant-related custom attribute definitions from Square. Use when you need to discover available custom attributes that can be attached to merchant profiles.Input Parameters
Output
List Merchants
List Merchants
SQUARE_LIST_MERCHANTSTool to retrieve merchant account information associated with the access token. Use when you need to get merchant profile details including business name, country, currency, and main location ID.Input Parameters
Output
List Merchants Custom Attributes
List Merchants Custom Attributes
SQUARE_LIST_MERCHANTS_CUSTOM_ATTRIBUTESLists a page of custom attributes for a specific Square merchant. Use the returned cursor to retrieve further pages; results can be filtered by visibility.Input Parameters
Output
List Payments
List Payments
SQUARE_LIST_PAYMENTSTool to list payments by location and time range to enable reconciliation and net sales reporting from Square POS. Use when you need to retrieve payment records for reporting, analytics, or reconciliation purposes.Input Parameters
Output
List Subscriptions
List Subscriptions
SQUARE_LIST_SUBSCRIPTIONSTool to search and list Square customer billing subscriptions. Use this action when you need to retrieve subscription information for customers, filter subscriptions by location, or view all active subscriptions. Results are ordered chronologically by subscription creation date.Input Parameters
Output
List Webhook Event Types
List Webhook Event Types
List Webhook Subscriptions
List Webhook Subscriptions
SQUARE_LIST_WEBHOOK_SUBSCRIPTIONSList all webhook subscriptions owned by your application. Returns webhook subscriptions with their event types, notification URLs, and status. Supports filtering by enabled/disabled status, sorting by creation date, and pagination for large result sets. Note: Webhook subscriptions are application-level resources and require personal access token authentication (not OAuth tokens).Input Parameters
Output
Pay Order
Pay Order
SQUARE_PAY_ORDERPays an existing Square order by processing approved payments and completing the transaction. Use this action when you need to finalize payment on an order that has already been created and has associated approved payments. The total amount of the payment_ids provided must equal the order total, and upon success, the order state transitions to COMPLETED. Important: The payments referenced in payment_ids must be in APPROVED status and must have been created with a reference to this order_id. For orders with a zero total, you can pass an empty payment_ids array or omit it entirely. Using the idempotency_key prevents duplicate payment processing if the request is retried. Required permissions: ORDERS_WRITE, PAYMENTS_WRITEInput Parameters
Output
Remove Group From Customer
Remove Group From Customer
Retrieve Bulk Customers
Retrieve Bulk Customers
SQUARE_RETRIEVE_BULK_CUSTOMERSTool to retrieve multiple customer profiles in a single request. Use when you need to efficiently fetch up to 100 customer profiles by their IDs.Input Parameters
Output
Retrieve Channel
Retrieve Channel
SQUARE_RETRIEVE_CHANNELRetrieve a Square channel by its ID. Channels represent different distribution points for catalog content, including physical locations and online platforms. Use this to get detailed information about a specific channel, including its status, associated references, and metadata.Input Parameters
Output
Bulk Retrieve Channels
Bulk Retrieve Channels
SQUARE_RETRIEVE_CHANNELS_BULKTool to bulk retrieve multiple Square channels by their IDs in a single request. Use when you need to fetch specific channels by their unique identifiers rather than listing all channels.Input Parameters
Output
Retrieve Customer
Retrieve Customer
SQUARE_RETRIEVE_CUSTOMERTool to retrieve detailed information about a specific Square customer by ID. Use when you need to fetch customer profile data including contact information, preferences, and group memberships.Input Parameters
Output
Retrieve Customer Group
Retrieve Customer Group
Retrieve Customer Segment
Retrieve Customer Segment
SQUARE_RETRIEVE_CUSTOMER_SEGMENTTool to retrieve a specific customer segment by its ID. Use when you need to get details about a customer segment including its name and timestamps.Input Parameters
Output
Retrieve Dispute
Retrieve Dispute
Retrieve Inventory Changes
Retrieve Inventory Changes
SQUARE_RETRIEVE_INVENTORY_CHANGESRetrieves physical counts and inventory adjustments for a catalog object at selected locations, or all locations if none are specified. Results are paginated newest first, supporting inventory history review and reconciliation; INVENTORY_READ permission is required. DEPRECATED: Square retired this endpoint; use BatchRetrieveInventoryChanges with a single catalog object ID instead.Input Parameters
Output
Batch Retrieve Inventory Counts
Batch Retrieve Inventory Counts
SQUARE_RETRIEVE_INVENTORY_COUNTS_BATCHRetrieve inventory counts for multiple catalog objects and locations in a single batch request. Filter by catalog objects, locations, states, or an updated-after timestamp for inventory sync and reporting.Input Parameters
Output
Retrieve Location
Retrieve Location
SQUARE_RETRIEVE_LOCATIONTool to retrieve detailed information about a specific Square location by ID. Use when you need to get complete details about a specific location, including address, business hours, contact information, and capabilities.Input Parameters
Output
Retrieve Location Custom Attribute
Retrieve Location Custom Attribute
SQUARE_RETRIEVE_LOCATION_CUSTOM_ATTRIBUTERetrieves a custom attribute associated with a location in Square. Use this when you need to access specific custom data associated with a location, such as metadata, external IDs, or other merchant-defined information.Input Parameters
Output
Retrieve Location Custom Attribute Definition
Retrieve Location Custom Attribute Definition
SQUARE_RETRIEVE_LOCATION_CUSTOM_ATTRIBUTE_DEFINITIONTool to retrieve a location-related custom attribute definition. Use when you need to get the schema, visibility, and metadata for a custom attribute associated with locations.Input Parameters
Output
Retrieve Merchant Custom Attribute
Retrieve Merchant Custom Attribute
SQUARE_RETRIEVE_MERCHANT_CUSTOM_ATTRIBUTERetrieves a custom attribute associated with a merchant in Square. Use this when you need to access specific custom data associated with a merchant, such as metadata, external IDs, or other merchant-defined information.Input Parameters
Output
Retrieve Merchant Custom Attribute Definition
Retrieve Merchant Custom Attribute Definition
SQUARE_RETRIEVE_MERCHANT_CUSTOM_ATTRIBUTE_DEFINITIONTool to retrieve a merchant-related custom attribute definition from Square. Use when you need to fetch the schema, visibility, or metadata of a specific custom attribute definition by its key.Input Parameters
Output
Retrieve Merchants
Retrieve Merchants
SQUARE_RETRIEVE_MERCHANTSTool to retrieve merchant information including status, main location details, and capabilities using Square’s GraphQL API. Use when you need to fetch merchant profile data for specific merchant IDs.Input Parameters
Output
Retrieve Order
Retrieve Order
SQUARE_RETRIEVE_ORDERRetrieves detailed information about a specific Square order by its ID. Use this tool when you need to: - Fetch complete details of an order including line items, pricing, taxes, and discounts - Check order status and fulfillment information - View payment tenders and refunds associated with an order - Access order metadata and timestamps Requires: ORDERS_READ permission scope.Input Parameters
Output
Retrieve Payment Link
Retrieve Payment Link
Retrieve Token Status
Retrieve Token Status
Retrieve Webhook Subscription
Retrieve Webhook Subscription
SQUARE_RETRIEVE_WEBHOOK_SUBSCRIPTIONRetrieve a Square webhook subscription by its ID. Returns subscription details including name, enabled status, event types, notification URL, and signature key. Note: Requires personal access token authentication with DEVELOPER_APPLICATION_WEBHOOKS_READ scope (OAuth tokens are not supported for webhook subscriptions).Input Parameters
Output
Search Booking Availability
Search Booking Availability
SQUARE_SEARCH_BOOKING_AVAILABILITYSearches for available appointment time slots for booking services at Square locations. Use this action when you need to find open booking slots for a specific service, location, and time range. This is essential for scheduling appointments as it shows which times are available for booking based on service requirements and team member availability.Input Parameters
Output
Search Catalog Objects
Search Catalog Objects
SQUARE_SEARCH_CATALOG_OBJECTSSearches for catalog objects (items, categories, taxes, discounts, etc.) in the Square catalog. Use this action when you need to find specific catalog items by name, SKU, category, or other attributes, or when retrieving the entire catalog with filtering and sorting options. Supports full-text search, exact matching, prefix matching, range queries, and complex combinations of filters.Input Parameters
Output
Search Customers
Search Customers
Search Orders
Search Orders
SQUARE_SEARCH_ORDERSTool to search orders across one or more Square locations with filters. Use when you need to find orders within a date range, by state, by customer, or other criteria. This is the primary way Square exposes ‘list orders for a date range’ functionality.Input Parameters
Output
Submit Dispute Evidence
Submit Dispute Evidence
SQUARE_SUBMIT_DISPUTE_EVIDENCESubmits evidence for a dispute to the cardholder’s bank. IMPORTANT: You must upload evidence FIRST using CreateDisputeEvidenceText or CreateDisputeEvidenceFile before calling this endpoint. Once evidence is submitted, it cannot be modified or removed. The dispute state will change to PROCESSING after successful submission. Use this when: (1) You have uploaded all evidence files/text, (2) The dispute is in EVIDENCE_REQUIRED state, and (3) You are ready to finalize and send evidence to the bank before the due date.Input Parameters
Output
Test Webhook Subscription
Test Webhook Subscription
SQUARE_TEST_WEBHOOK_SUBSCRIPTIONTests a webhook subscription by sending a test event to the configured notification URL. Use this to verify that your webhook endpoint is correctly receiving and processing Square events. The response includes the HTTP status code returned by your endpoint and the test payload that was sent. Useful after creating or updating a subscription to confirm proper integration.Input Parameters
Output
Update Booking
Update Booking
SQUARE_UPDATE_BOOKINGUpdates an existing Square booking with new appointment details, times, notes, or team members. Use when you need to modify a booking’s start time, change appointment segments, update customer or seller notes, or modify the location type. Requires the current booking version number for optimistic concurrency control - get this from a previous retrieve booking call. Seller must subscribe to Appointments Plus or Premium to use this action.Input Parameters
Output
Update Customer
Update Customer
SQUARE_UPDATE_CUSTOMERUpdates an existing Square customer profile, including details such as name, email, address, or phone number. Supports sparse updates and an optional version for optimistic concurrency control; null values are omitted rather than sent to remove fields.Input Parameters
Output
Update Customer Custom Attribute Definition
Update Customer Custom Attribute Definition
SQUARE_UPDATE_CUSTOMER_CUSTOM_ATTRIBUTE_DEFINITIONTool to update a customer-related custom attribute definition in Square. Use when you need to modify the name, description, visibility, or schema of an existing custom attribute definition. Supports sparse updates: only include fields you want to change. Use the version parameter for optimistic concurrency control to prevent conflicting updates.Input Parameters
Output
Update Customer Group
Update Customer Group
Bulk Update Customers
Bulk Update Customers
SQUARE_UPDATE_CUSTOMERS_BULKUpdates multiple Square customer profiles in a single batch, using customer IDs and the fields to update. An optional version supports optimistic concurrency control; null-valued fields are omitted from the request.Input Parameters
Output
Update Location
Update Location
Update Location Custom Attribute Definition
Update Location Custom Attribute Definition
SQUARE_UPDATE_LOCATION_CUSTOM_ATTRIBUTE_DEFINITIONTool to update a location-related custom attribute definition in Square. Use when you need to modify the description, name, visibility, or schema of an existing location custom attribute definition.Input Parameters
Output
Update Merchant Custom Attribute Definition
Update Merchant Custom Attribute Definition
SQUARE_UPDATE_MERCHANT_CUSTOM_ATTRIBUTE_DEFINITIONTool to update a merchant-related custom attribute definition in Square. Use when you need to modify the description, name, visibility, or schema of an existing merchant custom attribute definition.Input Parameters
Output
Update Online Checkout Location Settings
Update Online Checkout Location Settings
SQUARE_UPDATE_ONLINE_CHECKOUT_LOCATION_SETTINGSTool to update location-level settings for Square online checkout. Use when you need to modify checkout configuration including customer notes, policies, branding, and tipping options for a specific location. Supports sparse updates: only include fields you want to change.Input Parameters
Output
Update Order
Update Order
SQUARE_UPDATE_ORDERUpdates an existing Square order by adding, modifying, or removing fields. Use for OPEN or DRAFT orders only (COMPLETED/CANCELED orders cannot be updated). Requires the current order version number for optimistic concurrency control - get this from retrieve/search order first. Supports sparse updates: only include fields you want to change. To remove fields, use fields_to_clear array with dot notation paths. Common use cases: adding line items, updating quantities, applying discounts/taxes, modifying fulfillment details, updating metadata.Input Parameters
Output
Update Team Member
Update Team Member
SQUARE_UPDATE_TEAM_MEMBERTool to update an existing Square team member’s information. Use when you need to modify team member details like name, email, phone number, status, location assignments, or wage settings. Supports sparse updates: only include fields you want to change. To update wage_setting.job_assignments, provide the complete list of job assignments.Input Parameters
Output
Update Webhook Subscription
Update Webhook Subscription
Update Webhook Subscription Signature Key
Update Webhook Subscription Signature Key
Upsert Catalog Object
Upsert Catalog Object
SQUARE_UPSERT_CATALOG_OBJECTCreates or updates a catalog object in the Square catalog. Use when you need to add or modify items, variations, categories, taxes, discounts, or other catalog entities in the merchant’s inventory system. For new objects, use a temporary ID starting with ’#’ (e.g., ‘#new-item-1’). For updates, provide the existing object ID and current version number. The object type field determines which data field should be populated (e.g., type=ITEM requires item_data). Only one update request is processed at a time per seller account.Input Parameters
Output
Batch Upsert Catalog Objects
Batch Upsert Catalog Objects
SQUARE_UPSERT_CATALOG_OBJECTS_BATCHCreates or updates multiple catalog objects in a single batch operation. Use this action when you need to efficiently manage catalog items, categories, discounts, taxes, or other catalog entities in bulk. Supports up to 10,000 objects across all batches, with each batch containing up to 1,000 objects. Use temporary IDs starting with # (e.g., #Tea) for new objects, and existing IDs to update objects. Each batch is processed atomically (all succeed or all fail). Use when you need to create multiple catalog items at once, update existing catalog objects in bulk, or set up an initial product catalog. The idempotency_key ensures safe retries without duplicate creation. Required permissions: ITEMS_WRITEInput Parameters
Output
Upsert Customer Custom Attribute
Upsert Customer Custom Attribute
SQUARE_UPSERT_CUSTOMER_CUSTOM_ATTRIBUTETool to create or update a custom attribute for a customer profile. Use when you need to store custom data on a customer record, such as preferences, loyalty tiers, or external system IDs. The custom attribute key must match an existing custom attribute definition in the Square account.Input Parameters
Output
Batch Upsert Customer Custom Attributes
Batch Upsert Customer Custom Attributes
SQUARE_UPSERT_CUSTOMER_CUSTOM_ATTRIBUTES_BATCHTool to create or update custom attributes for multiple customers in a single batch request. Use when you need to set custom data on customer profiles (e.g., preferences, loyalty tiers, tags). Supports 1 to 25 upsert operations per request. Before using this action, ensure the custom attribute definitions exist in your Square seller account. The custom attribute keys must match existing definitions. Use optimistic concurrency (version field) to prevent overwriting concurrent updates. Required permissions: CUSTOMERS_WRITEInput Parameters
Output
Upsert Location Custom Attribute
Upsert Location Custom Attribute
SQUARE_UPSERT_LOCATION_CUSTOM_ATTRIBUTETool to create or update a custom attribute for a location. Use when you need to store custom data on a location record, such as capacity limits, special features, or external system IDs. The custom attribute key must match an existing custom attribute definition in the Square account.Input Parameters
Output
Batch Upsert Locations Custom Attributes
Batch Upsert Locations Custom Attributes
SQUARE_UPSERT_LOCATIONS_CUSTOM_ATTRIBUTES_BATCHTool to create or update custom attributes for multiple locations in a single batch request. Use when you need to set custom data on location records (e.g., store ratings, delivery zones, tags). Supports 1 to 25 upsert operations per request. Before using this action, ensure the custom attribute definitions exist in your Square seller account. The custom attribute keys must match existing definitions. Use optimistic concurrency (version field) to prevent overwriting concurrent updates. Required permissions: MERCHANT_PROFILE_WRITEInput Parameters
Output
Upsert Merchant Custom Attribute
Upsert Merchant Custom Attribute
SQUARE_UPSERT_MERCHANT_CUSTOM_ATTRIBUTETool to create or update a custom attribute for a merchant profile. Use when you need to store custom data on a merchant record, such as business notes, external system IDs, or configuration values. The custom attribute key must match an existing custom attribute definition in the Square account.Input Parameters
Output
Batch Upsert Merchants Custom Attributes
Batch Upsert Merchants Custom Attributes
SQUARE_UPSERT_MERCHANTS_CUSTOM_ATTRIBUTES_BATCHTool to create or update custom attributes for multiple merchants in a single batch request. Use when you need to set custom data on merchant profiles (e.g., business types, establishment dates, merchant categories). Supports 1 to 25 upsert operations per request. Before using this action, ensure the custom attribute definitions exist in your Square seller account. The custom attribute keys must match existing definitions. Use optimistic concurrency (version field) to prevent overwriting concurrent updates. Required permissions: MERCHANT_PROFILE_WRITE