Reference

Create Customer Custom Attribute Definition

Define custom data fields for your customer profiles to capture information specific to your business beyond standard contact details.

Create Location Custom Attribute Definition

Define custom fields for your Square locations to track business-specific information beyond standard location data, enabling you to organize and categorize your physical or virtual business locations according to your unique needs.

Delete Customer Custom Attribute

Removes custom data fields from a customer's profile in Square, allowing you to clean up or remove information that's no longer needed for that customer.

Delete Customer Custom Attribute Definition

Removes a custom attribute definition from your customer records, allowing you to clean up data fields that are no longer relevant to your business.

Delete Location Custom Attribute

Remove custom data fields from a business location when you no longer need to track that information. This helps keep your location profile clean and organized.

Delete Location Custom Attribute Definition

Removes a custom attribute definition from your locations, preventing it from being used on future location records. Use this when you need to clean up outdated or incorrectly configured location attributes.

Delete Locations Custom Attributes (Batch)

Remove custom metadata fields from multiple business locations simultaneously, streamlining the process of cleaning up or standardizing location information across your Square account.

Delete Merchant Custom Attribute

Remove custom metadata or fields from your merchant profile when you no longer need to track that information. This helps keep your merchant data clean and organized.

Delete Merchant Custom Attribute Definition

Removes a custom attribute definition from your Square account, preventing it from being used on merchant profiles. Use this when you need to clean up outdated or incorrectly configured custom attributes.

Delete Merchants Custom Attributes (Batch)

Remove custom metadata fields from multiple merchant profiles at once, streamlining bulk updates to your merchant database. This is useful when cleaning up outdated information or standardizing merchant records across your business.

Get Customer Custom Attribute

Retrieves custom data stored on a customer's profile in Square, such as preferences, loyalty tier, or external reference IDs that you've previously saved.

Get Customer Custom Attribute Definition

Retrieve the schema and metadata for a custom customer attribute you've created in Square, such as viewing its data type, required status, or visibility settings. This helps you understand how customer data fields are structured in your Square account.

List Customer Custom Attribute Definitions

Retrieve all custom attribute definitions available for your customer profiles in Square, allowing you to see what additional data fields you can store for each customer. This helps you understand what customer information you're already set up to track.

List Customer Custom Attribute Definitions (GraphQL)

Retrieve all custom attributes you've set up for customer profiles in Square, including their names, types, and visibility settings. Use this to understand what customer data fields are available for your business.

List Customer Custom Attributes

Retrieve all custom data fields stored on a customer's profile, including metadata about what each field represents. This helps you access personalized customer information you've added beyond Square's standard fields.

List Location Custom Attribute Definitions

Retrieves all custom attributes you've created for your business locations in Square, helping you understand what additional information you can track for each location.

Get Business Booking Profile

Retrieve your Square booking profile settings to view your cancellation policies, booking configuration, and whether bookings are enabled for your business.

Create Card

Securely store a customer's payment card for future transactions without requiring them to re-enter card details each time. This enables faster checkout experiences and recurring payments while keeping sensitive card information safe.

List Channels

Retrieve a list of your sales channels from Square to see all the platforms and locations where you're selling products or services. This helps you manage and track sales across multiple storefronts, marketplaces, or physical locations.

Get Online Checkout Location Settings

Retrieves the checkout configuration settings for a specific location, including customer messaging, policies, branding, and tipping preferences to help you understand how your online store is currently set up.

Create Bulk Customers

Add multiple customer profiles to your Square account in a single operation, making it easy to onboard groups of customers at once. This is ideal when you need to set up dozens of customer records efficiently without making individual requests.

Create Customer

Adds a new customer to your Square account with their contact information so you can track purchases, build customer lists, and manage relationships. This creates a permanent customer record you can reference for future transactions and communications.

List Customers

Retrieve all customer profiles from your Square account to access contact information and customer details for business operations. Use this when you need to analyze your customer base, sync data with other tools, or perform outreach campaigns.

Add Group to Customer

Assign a customer to a specific group in your Square account to organize customers for targeted marketing campaigns, loyalty programs, or service-based segmentation.

Bulk Delete Customers

Remove multiple customer profiles from your Square account in a single operation, allowing you to clean up your customer database or remove inactive accounts efficiently.

Create Customer Group

Organize your customers into groups based on shared characteristics or preferences, enabling you to run targeted marketing campaigns and manage customer relationships more effectively.

Delete Customer

Permanently remove a customer profile from your Square account when you no longer need to maintain their record. This ensures your customer database stays clean and up-to-date.

Delete Customer Group

Permanently remove a customer group from your Square account when you no longer need to organize customers by that category. This helps keep your customer management system clean and up-to-date.

Get Customers via GraphQL

Retrieve customer profiles from your Square Customer Directory to access names, contact details, and profile information for your business. Use this to build customer lists, verify customer data, or integrate customer information with other business tools.

List Customer Groups

Retrieve all customer groups in your Square account to view and manage how you've organized your customer base for marketing and business purposes.

List Customer Segments

Retrieve all customer segments you've created in Square to identify and organize your customer groups. This helps you understand how your customers are categorized for targeted marketing and personalized business decisions.

Accept Dispute

Settle a payment dispute by accepting liability and returning the disputed amount to the customer's account. Use this when you've determined the dispute claim is valid or when contesting it is not worth the effort.

Create Dispute Evidence File

Upload supporting documents like receipts, invoices, or images to strengthen your dispute case when a customer challenges a transaction. This helps you provide evidence to Square's dispute team to resolve the claim in your favor.

Create Dispute Evidence Text

Submit text-based evidence to support your case in a payment dispute, such as communication records or explanations of the transaction issue. This helps Square review your dispute claim before you formally submit it.

Delete Dispute Evidence

Remove a piece of evidence from a dispute before it's submitted to the bank, allowing you to correct mistakes or update your documentation. This is useful when you need to clean up your dispute filing or replace evidence with better supporting materials.

Get Dispute Evidence

Retrieve metadata and details about evidence files you've uploaded to support a dispute case, including upload timestamps and file information. This helps you verify that your supporting documentation was successfully submitted before finalizing your dispute response.

List Dispute Evidence

Retrieve all evidence files and documents you've submitted to support your response to a payment dispute, helping you track what you've provided to Square for review.

Create Invoice Attachment

Attach supporting documents like receipts, contracts, or agreements to a Square invoice to provide context and documentation for your client. This helps keep all invoice-related materials organized in one place for easy reference and record-keeping.

Cancel Invoice

Cancels an active Square invoice to stop payment collection and mark the associated order as canceled. Use this when you need to void an invoice that's been sent to a customer but payment is no longer needed.

Delete Invoice

Remove draft invoices from your Square account that are no longer needed or were created by mistake. This helps you keep your invoice records clean and organized.

Delete Invoice Attachment

Remove an attached file from a Square invoice to keep your invoice records clean and organized. Use this when you've uploaded the wrong document or no longer need a specific attachment linked to a customer's invoice.

Get Invoice

Retrieve detailed information about a specific invoice including payment status, recipient details, and custom fields to view or verify invoice specifics.

List Invoices

Retrieve all invoices for your Square location to view payment history, outstanding balances, and customer billing records in one place.

Create Location

Add a new business location to your Square account for managing sales across multiple physical stores, pop-up shops, or mobile operations. This lets you track inventory, payments, and customer data separately for each location.

List Locations

Retrieve all business locations associated with your Square account to identify location IDs needed for other Square operations. This helps you understand your business structure and find the correct location context for transactions and reports.

Get Current Merchant

Retrieves your merchant account information from Square, including your business name, status, currency, and main location details. Use this to access your merchant ID and verify your account settings.

Get Merchant

Retrieves detailed information about a Square merchant account, including business name, location, and currency settings. Use this to access your merchant profile data or verify account details programmatically.

Calculate Order

Preview the total cost, taxes, and discounts for an order before finalizing the sale, helping you show accurate pricing to customers without committing to the transaction.

Cancel Payment

Voids an authorized payment before it's captured, allowing you to reverse transactions that haven't been finalized yet. This is essential for managing payment authorizations and preventing unwanted charges.

Delete Webhook Subscription

Removes a webhook subscription so your application stops receiving event notifications from Square. Use this when you no longer need to monitor specific Square events.

Batch Upsert Customer Custom Attributes

Tool to create or update custom attributes for multiple customers in a single batch request.

Batch Upsert Locations Custom Attributes

Tool to create or update custom attributes for multiple locations in a single batch request.

Batch Upsert Merchants Custom Attributes

Tool to create or update custom attributes for multiple merchants in a single batch request.

Bulk Retrieve Channels

Tool to bulk retrieve multiple Square channels by their IDs in a single request.

Bulk Update Customers

Tool to update multiple customer profiles in a single batch operation.

List Locations Custom Attributes

Tool to list custom attributes for a specific location in Square.

List Merchant Custom Attribute Definitions

Tool to list merchant-related custom attribute definitions from Square.

List Merchants

Tool to retrieve merchant account information associated with the access token.

List Merchants Custom Attributes

Tool to list custom attributes for a specific merchant in Square.

List Payments

Tool to list payments by location and time range to enable reconciliation and net sales reporting from Square POS.

List Webhook Event Types

Tool to list available webhook event types.

List Webhook Subscriptions

List all webhook subscriptions owned by your application.

Remove Group From Customer

Removes a customer from a customer group.

Retrieve Bulk Customers

Tool to retrieve multiple customer profiles in a single request.

Retrieve Channel

Retrieve a Square channel by its ID.

Retrieve Customer

Tool to retrieve detailed information about a specific Square customer by ID.

Retrieve Customer Group

Tool to retrieve a specific Square customer group by ID.

Retrieve Customer Segment

Tool to retrieve a specific customer segment by its ID.

Retrieve Dispute

Tool to retrieve a Square dispute by ID.

Retrieve Location

Tool to retrieve detailed information about a specific Square location by ID.

Retrieve Location Custom Attribute

Retrieves a custom attribute associated with a location in Square.

Retrieve Location Custom Attribute Definition

Tool to retrieve a location-related custom attribute definition.

Retrieve Merchant Custom Attribute

Retrieves a custom attribute associated with a merchant in Square.

Retrieve Merchant Custom Attribute Definition

Tool to retrieve a merchant-related custom attribute definition from Square.

Retrieve Merchants

Tool to retrieve merchant information including status, main location details, and capabilities using Square's GraphQL API.

Retrieve Order

Retrieves detailed information about a specific Square order by its ID.

Retrieve Payment Link

Retrieves a Square-hosted payment link by ID.

Retrieve Token Status

Tool to retrieve information about an OAuth access token or personal access token.

Retrieve Webhook Subscription

Retrieve a Square webhook subscription by its ID.

Search Customers

Tool to search customer profiles in Square Customer Directory.

Search Orders

Tool to search orders across one or more Square locations with filters.

Submit Dispute Evidence

Submits evidence for a dispute to the cardholder's bank.

Test Webhook Subscription

Tests a webhook subscription by sending a test event to the configured notification URL.

Update Customer

Tool to update an existing Square customer profile.

Update Customer Custom Attribute Definition

Tool to update a customer-related custom attribute definition in Square.

Update Customer Group

Tool to update a customer group's information by its ID.

Update Location

Tool to update an existing business location in a Square account.

Update Location Custom Attribute Definition

Tool to update a location-related custom attribute definition in Square.

Update Merchant Custom Attribute Definition

Tool to update a merchant-related custom attribute definition in Square.

Update Online Checkout Location Settings

Tool to update location-level settings for Square online checkout.

Update Order

Updates an existing Square order by adding, modifying, or removing fields.

Update Webhook Subscription

Tool to update a Square webhook subscription.

Update Webhook Subscription Signature Key

Tool to rotate the signature key for a webhook subscription.

Upsert Customer Custom Attribute

Tool to create or update a custom attribute for a customer profile.

Upsert Location Custom Attribute

Tool to create or update a custom attribute for a location.

Upsert Merchant Custom Attribute

Tool to create or update a custom attribute for a merchant profile.