Built by Metorial, the integration platform for agentic AI.
Retrieve a specific catalog object by its ID. Returns full object data including related objects (e.g., item variations, modifier lists) when requested.
Create or fully replace a catalog object (item, variation, category, tax, discount, modifier list, etc.). Omitted fields and nested children are cleared on update. Use a temporary ID starting with '#' for new objects.
Update an existing customer profile. Omitted fields remain unchanged; use null to clear a field or an address component.
Charge a token or saved card, or record cash or an external payment. Use autocomplete=false for delayed capture.
Create an OPEN or DRAFT order at a Square location. Use DRAFT for subscription order templates. Supports line items, taxes, discounts, service charges, fulfillments, and customer association. Discover locations with list_locations.
Retrieve current inventory counts, optionally filtered by item variations, locations, tracked states, or update time. Use search_catalog for variation IDs and list_locations for location IDs.
Get an invoice by ID, including its current version, payment schedule, recipient, status, and customer payment URL when published.
Create a draft invoice for an existing order. A payment schedule is required; publish separately to make the invoice available to the customer.
Permanently delete a customer profile from the Square account. This action cannot be undone.
Apply physical counts or inventory adjustments to item variations. Use ADJUSTMENT with different source and destination locations to move stock between locations.
Search Square catalog items by text or category, or search catalog objects by type and advanced query. Choose one search mode; item and object filters cannot be combined.
List payments with documented date, location, card, amount, and offline filters. New payments can take several seconds to appear.
Search for orders across one or more locations. Supports filtering by date range, fulfillment state, customer, and other criteria. Use this to find and list orders.
Retrieve full details of a specific customer profile by ID. Returns contact information, address, notes, preferences, and group memberships.
List invoices at one location with status, version, recipient, payment requests, and public URL when available.
Retrieve a list of customer profiles. Supports pagination and sorting by creation date or default order.
Get a payment by ID, including current status, version token, refund IDs, card or cash details, and receipt URL.
Issue a full or partial refund of a completed Square payment. A payment can have no more than 20 refunds.
Publish a draft invoice, cancel a published invoice, or delete a draft. Publishing can email the customer or charge a saved card based on settings. Deleting a draft cancels its order.
List Square business locations. Use locationId in payments, orders, invoices, inventory, subscriptions, and payout tools; check status and capabilities before choosing a location.
Delete a catalog object by its ID. Deleting an item also deletes its variations. Deleted objects can still be referenced by existing orders.
Capture or void an approved payment, update its amount or tip, or void an uncertain create request using its idempotency key.
Create a new customer profile. Provide at least one of: given name, family name, company name, email address, or phone number.
Retrieve full details of a specific order by its ID. Returns line items, taxes, discounts, fulfillments, tenders, and all order metadata.
Retrieve a Square business location and its currency, status, and capabilities. Call list_locations to discover location IDs; use "main" for the main location.
Retrieve full details for a Square payment refund by refund ID.
Update sparse invoice fields using the current version. Updating a published invoice can notify its customer. Use null or payment-request remove markers to clear supported values.
Mark a Square order as paid using approved delayed-capture payment IDs, or settle a zero-total order with an empty paymentIds array.
Retrieve Square payment refunds with pagination and filters for created time, updated time, location, status, and source type.
Retrieve the authenticated Square merchant profile or a specific merchant by ID. Returns merchantId, currency, country, and mainLocationId for downstream tools.
Update an OPEN or DRAFT order using sparse fields and its current version, or set state to CANCELED to cancel an uninvoiced order. Invoice-linked orders must be canceled through manage_invoice. Array entries match by uid.
Search Square customer profiles using common filters or an advanced Square customer query object. Newly created or updated customers can take time to appear in search results.
Search invoices at exactly one location and optionally one customer. Choose either convenience fields or query fields for each filter.
Update a payment link using its current version. Checkout options replace the full options object; provide every option you want to keep.
Save a tokenized card for a Square customer. Use a one-time card token or recent payment ID; call list_customers to discover the customer ID.
List saved cards, optionally filtered by customer or reference ID. Square returns up to 25 cards per page.
Create a single-use Square-hosted checkout link for a quick-pay item or a new itemized order. Call list_locations for a valid location ID.
List Square-hosted payment links and their checkout URLs, with cursor pagination.
Retrieve a Square-hosted payment link, its order ID, version, and checkout URL.
Delete a payment link and cancel its unpaid checkout order. A buyer using the link can no longer complete checkout.
Retrieve a saved card by ID, including customer association and enabled state.
Enroll a customer in a catalog subscription plan variation. A saved card charges automatically; without one, Square emails an invoice.
Disable a saved card, preventing future charges. Disabling an already disabled card has no effect.
Schedule cancellation at the end of the active billing period. The subscription can remain ACTIVE until its canceled date.
List payouts and their settlement amounts, status, destination, and reconciliation identifiers. Without a location ID, Square uses the default location.
List the transactions and adjustments that make up a batch payout. Each entry includes gross, fee, and net amounts with available payment, refund, or dispute IDs.
Retrieve the current subscription, billing dates, card, invoices, and optional scheduled actions.
Update selected subscription fields. Omitted fields are unchanged; null clears a supported value. Supply the current version from get_subscription.
Retrieve one payout and its settlement status, amount, destination, and reconciliation ID.
Retrieve the state, disputed payment, amount, reason, and response deadline for one dispute.
Search subscriptions by location or customer, including their billing and cancellation state.
List payment disputes, including the disputed payment, amount, state, and response deadline.