Skip to main content

Square Component

Manage payments, customers, orders, invoices, and team members in Square.

Component key: square · Source ·
· Changelog ↓

Description​

Square is a comprehensive commerce platform that provides payment processing, point-of-sale systems, online store capabilities, and business management tools. This component enables management of payments, customers, orders, inventory, invoices, team members, and webhooks in a Square account.

API Documentation​

This component was built using the Square API Documentation

A Note on Square Pagination​

Square's API supports pagination. This means that the API will return up to a specific limit of items for any query. If additional results are available, the API response includes a cursor field that can be used to retrieve the next page of data.

{
  "objects": [],
  "cursor": "next_page_cursor"
}

The cursor can be used in a subsequent query to fetch additional results.

See Square's Docs for information about Square's paginated API.

Connections​

OAuth 2.0​

key: oauth2

To connect to Square using OAuth 2.0, create an application in the Square Developer Portal.

Prerequisites​

Setup Steps​

  1. Navigate to the Square Developer Portal and sign in
  2. Create a new application or select an existing application
  3. In the application settings, navigate to the OAuth section
  4. Add https://oauth2.prismatic.io/callback as a Redirect URL
  5. Configure the required permissions (scopes) for the application based on the integration needs
  6. Copy the Application ID and Application Secret from the Credentials section

Configure the Connection​

  • Select the Authorize URL matching the target Square environment. Defaults to the Production URL https://connect.squareup.com/oauth2/authorize; select the Sandbox URL https://connect.squareupsandbox.com/oauth2/authorize for testing.
  • Select the Token URL matching the same environment as the Authorize URL. Defaults to the Production URL https://connect.squareup.com/oauth2/token; select the Sandbox URL https://connect.squareupsandbox.com/oauth2/token for testing.
  • For Scopes, enter a space-separated list of OAuth permissions required by the application. Refer to the Square OAuth Permissions documentation for available scopes.
  • Enter the Application ID as the Client ID.
  • Enter the Application Secret as the Client Secret.
  • (Optional) Set the API Version to override the default Square API version. Leave blank to use the default. See Square API Versioning for details.

Verify Connection​

After configuring the connection, the authorizing user is redirected to Square to authorize access to the account. Once authorized, the integration can interact with the Square API on behalf of the merchant.

Production Credentials​

Square separates its development environment from production to prevent test operations from affecting live merchant data. Sandbox and production credentials are distinct. Switching to production credentials is a required step before the integration can interact with real Square accounts.

Square sandbox and production environments use separate credentials. The sandbox environment is for testing only. To connect to real Square accounts, use production credentials.

  1. Navigate to the application in the Square Developer Portal
  2. Toggle from Sandbox to Production in the top navigation
  3. Copy the Application ID and Application Secret from the Production > Credentials section

Update the connection configuration with the production Application ID (Client ID) and Application Secret (Client Secret).

App Marketplace

If distributing the app publicly through the Square App Marketplace, a formal app review is required, including having at least 5 active sellers using the integration. For private integrations within a single organization, App Marketplace listing is not required and no formal review applies.

InputNotesExample
API Version

Override the default Square API version (2025-08-20). Leave blank to use the default version. See Square API Versioning for version details.

2025-08-20
Authorize URL

The OAuth 2.0 Authorization URL for Square. Select Sandbox for testing or Production for live transactions.

https://connect.squareup.com/oauth2/authorize
Application ID

The Application ID from the Square Developer Dashboard. Navigate to Applications > [App Name] > Credentials to find this value.

sq0idp-XXXXXXXXXXXXXXXXXXXXXX
Application Secret

The Application Secret from the Square Developer Dashboard. Keep this value secure and never share it publicly.

Scopes

A space-separated list of OAuth permission scopes. These scopes must be configured in the Square Application. See Square OAuth Permissions for available scopes.

MERCHANT_PROFILE_READ PAYMENTS_READ
Token URL

The OAuth 2.0 Token URL for Square. This must match the environment selected in the Authorize URL.

https://connect.squareup.com/oauth2/token

Triggers​

New and Updated Payments​

Fetches Square payments created or updated since the last execution, separated into new and updated buckets. | key: pollChangesTrigger

InputNotesExample
Show New Records

When true, newly created payments are included in the trigger output.

true
Show Updated Records

When true, payments updated since the last poll are included in the trigger output.

true
Connection

The Square connection to use.

The New and Updated Payments polling trigger fetches Square payments that were created or updated since the previous execution. Records are separated into created and updated buckets so that downstream steps can branch on lifecycle without re-comparing timestamps.

How It Works​

  1. On the first run, the trigger captures the current time and returns no records (the baseline is established).
  2. On each subsequent run, the trigger calls Square's List Payments endpoint with the begin_time set to the previous poll timestamp and paginates through all results.
  3. Each payment's created_at and updated_at timestamps are compared against the previous poll timestamp to partition results into created (new payments) and updated (payments modified after creation).
  4. The new poll timestamp is persisted to polling state for the next execution.
  5. If both buckets are empty, the trigger reports polledNoChanges: true so the flow does not execute unnecessarily.

Returned Data​

The trigger returns an object with created and updated arrays under body.data. Each array contains full Square Payment objects.

Example Payload
{
  "body": {
    "data": {
      "created": [
        {
          "id": "KkAkhdMsgzn59SM8A89WgKwekxLZY",
          "status": "COMPLETED",
          "amount_money": {
            "amount": 100,
            "currency": "USD"
          },
          "source_type": "CARD",
          "location_id": "L8MR4Y5BMDJSC",
          "order_id": "03O3USaPaAaFnI6kkwB1JxGgBsUZY",
          "created_at": "2026-05-20T22:55:45.183Z",
          "updated_at": "2026-05-20T22:55:45.273Z"
        }
      ],
      "updated": [
        {
          "id": "9fNAOdpmh9XQpgUYRWJ7vWa4FdjZY",
          "status": "COMPLETED",
          "amount_money": {
            "amount": 2500,
            "currency": "USD"
          },
          "source_type": "CARD",
          "location_id": "L8MR4Y5BMDJSC",
          "created_at": "2026-05-18T14:12:03.000Z",
          "updated_at": "2026-05-20T22:50:11.412Z"
        }
      ]
    }
  }
}

Fields shown are representative. The full response object includes additional properties.

Notes​

  • The polling interval is configured on the integration instance, not on the trigger itself.
  • The begin_time filter uses Square's server time. Clock skew between the integration runtime and Square may cause edge-case records near the boundary to be classified differently across runs.
  • For high-volume merchants, consider pairing this trigger with the Webhook trigger to receive real-time payment.created and payment.updated events and reduce polling load.
Example Payload for New and Updated Payments⤓
Loading…

Webhook​

Receive and validate webhook requests from Square for manually configured webhook subscriptions. | key: squareWebhookTrigger

The Webhook trigger receives event notifications from a Square webhook subscription configured in the Square Developer Dashboard. When a subscribed event occurs (a payment is created, an order is updated, a customer profile is modified, an inventory count changes, etc.), Square sends a POST request to the flow's webhook URL and this trigger forwards the event payload to the integration.

How It Works​

This trigger does not register or manage the webhook subscription. Subscriptions are created manually in the Square Developer Dashboard and pointed at the flow's instance webhook URL.

  1. Square sends a POST request to the flow's webhook URL when a subscribed event occurs.
  2. The trigger forwards the request body to the integration as the flow payload.
  3. The trigger responds to Square with HTTP 200 to acknowledge receipt.

For signature verification, refer to the Square webhook signature validation documentation and implement the validation logic in a dedicated action.

Event Types​

A complete list of supported event types is available in the Square Webhook Events Reference. Common event categories include:

Common Event Categories (8)
  • payment.created / payment.updated — Payment lifecycle events
  • refund.created / refund.updated — Refund lifecycle events
  • order.created / order.updated / order.fulfillment.updated — Order lifecycle events
  • customer.created / customer.updated / customer.deleted — Customer profile changes
  • inventory.count.updated — Inventory count changes
  • invoice.created / invoice.updated / invoice.payment_made — Invoice lifecycle events
  • catalog.version.updated — Catalog changes
  • team_member.created / team_member.updated / team_member.wage_setting.updated — Team member changes

Returned Data​

The trigger returns the raw payload sent by Square. Payload structure varies by event type.

Example Payload (payment.created)
{
  "merchant_id": "6SSW7HV8K2ST5",
  "type": "payment.created",
  "event_id": "6a8f5f28-54a1-4eb0-a98a-3111513fd4fc",
  "created_at": "2026-05-20T22:55:45.293Z",
  "data": {
    "type": "payment",
    "id": "KkAkhdMsgzn59SM8A89WgKwekxLZY",
    "object": {
      "payment": {
        "id": "KkAkhdMsgzn59SM8A89WgKwekxLZY",
        "status": "COMPLETED",
        "amount_money": {
          "amount": 100,
          "currency": "USD"
        },
        "source_type": "CARD",
        "location_id": "L8MR4Y5BMDJSC",
        "order_id": "03O3USaPaAaFnI6kkwB1JxGgBsUZY",
        "created_at": "2026-05-20T22:55:45.183Z",
        "updated_at": "2026-05-20T22:55:45.273Z"
      }
    }
  }
}

Configuration​

This trigger does not require configurable inputs. The webhook subscription, signing key, and event types are managed in the Square Developer Dashboard.

Example Payload for Webhook⤓
Loading…

Data Sources​

Select Bank Accounts​

List and select from all of the bank accounts linked to a Square account. | key: selectBankAccounts | type: picklist

InputNotesExample
Cursor

The pagination cursor returned by a previous call to this endpoint.

Limit

The maximum number of results to return in a single page.

100
Location ID

The unique identifier for the location used to filter results.

LH2G9VFHJRWKR
Connection

The Square connection to use.

Select Catalog​

List and select from all of the catalog objects of the specified types. | key: selectCatalog | type: picklist

InputNotesExample
Catalog Version

The specific version of the catalog objects to include in the response. Used to retrieve historical versions of objects. The value is matched against the CatalogObject version attribute.

1234567890123
Cursor

The pagination cursor returned by a previous call to this endpoint.

Connection

The Square connection to use.

Types

An optional case-insensitive, comma-separated list of object types to retrieve. Valid values are defined in the CatalogObjectType enum, for example, ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST, IMAGE.

ITEM, CATEGORY, TAX

Select Customers​

List and select from all customer profiles associated with a Square account. | key: selectCustomers | type: picklist

InputNotesExample
Cursor

The pagination cursor returned by a previous call to this endpoint.

Limit

The maximum number of results to return in a single page.

100
Sort Field

The field used to sort the results.

Sort Order

The order in which results are sorted.

Connection

The Square connection to use.

Select Invoice​

Lists invoices in the Square account. | key: selectInvoice | type: picklist

InputNotesExample
Connection

The Square connection to use.

Select Job​

Lists jobs in the Square account. | key: selectJob | type: picklist

InputNotesExample
Connection

The Square connection to use.

Select Locations​

List and select from all of the seller's locations. | key: selectLocations | type: picklist

InputNotesExample
Connection

The Square connection to use.

Select Merchants​

List and select from all of the seller's merchants. | key: selectMerchants | type: picklist

InputNotesExample
Connection

The Square connection to use.

Select Order​

Lists orders in the Square account. | key: selectOrder | type: picklist

InputNotesExample
Connection

The Square connection to use.

Select Payment​

Lists payments in the Square account. | key: selectPayment | type: picklist

InputNotesExample
Connection

The Square connection to use.

Select Refund​

Lists payment refunds in the Square account. | key: selectRefund | type: picklist

InputNotesExample
Connection

The Square connection to use.

Select Team Member​

Lists team members in the Square account. | key: selectTeamMember | type: picklist

InputNotesExample
Connection

The Square connection to use.

Select Webhook Event Types​

List all webhook event types that can be subscribed to. | key: selectWebhookEventTypes | type: picklist

InputNotesExample
Connection

The Square connection to use.

Select Webhook Subscription​

Lists webhook subscriptions in the Square account. | key: selectWebhookSubscription | type: picklist

InputNotesExample
Connection

The Square connection to use.

Actions​

Batch Change Inventory​

Applies adjustments and counts to the provided item quantities. | key: batchChangeInventory

InputNotesExample
Inventory Changes

An array of inventory changes in JSON format. See Square Inventory Changes for change types.

[
  {
    "type": "PHYSICAL_COUNT",
    "physical_count": {
      "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
      "state": "IN_STOCK",
      "quantity": "10",
      "location_id": "LH2G9VFHJRWKR",
      "occurred_at": "2024-07-01T00:00:00Z",
      "created_at": "2024-07-01T00:00:00Z"
    }
  },
  {
    "type": "ADJUSTMENT",
    "adjustment": {
      "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
      "from_state": "IN_STOCK",
      "to_state": "SOLD",
      "quantity": "-1",
      "location_id": "LH2G9VFHJRWKR",
      "occurred_at": "2024-07-01T00:00:00Z",
      "created_at": "2024-07-01T00:00:00Z",
      "source": {
        "product": "SQUARE_POS",
        "application_id": "sandbox-sq0idb-example",
        "name": "Point of Sale",
        "type": "APPLICATION"
      }
    }
  }
]
Idempotency Key

A unique string that identifies this request to ensure idempotent operations.

a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b
Ignore Unchanged Counts

When true, unchanged inventory counts are ignored.

false
Connection

The Square connection to use.

Example Payload for Batch Change Inventory⤓
Loading…

Batch Delete Catalog Objects​

Deletes a set of CatalogItems based on the provided list of target IDs and returns a set of successfully deleted IDs in the response. | key: batchDeleteCatalogObjects

InputNotesExample
Object IDs

Array of catalog object IDs to retrieve in JSON format.

[
  "W62UWFY35CWMYGVWK6TWJDNI",
  "X73VXGZ46DXNZHXWL7UXKENJ",
  "Y84WHHA57EYOAIYWM8VYLOFK"
]
Connection

The Square connection to use.

Example Payload for Batch Delete Catalog Objects⤓
Loading…

Batch Retrieve Catalog Objects​

Returns a set of objects based on the provided ID. | key: batchRetrieveCatalogObjects

InputNotesExample
Catalog Version

The specific version of the catalog objects to include in the response. Used to retrieve historical versions of objects. The value is matched against the CatalogObject version attribute.

1234567890123
Include Deleted Objects

When true, deleted objects are included in the results.

false
Include Related Objects

When true, the response includes additional objects that are related to the requested objects.

false
Object IDs

Array of catalog object IDs to retrieve in JSON format.

[
  "W62UWFY35CWMYGVWK6TWJDNI",
  "X73VXGZ46DXNZHXWL7UXKENJ",
  "Y84WHHA57EYOAIYWM8VYLOFK"
]
Connection

The Square connection to use.

Example Payload for Batch Retrieve Catalog Objects⤓
Loading…

Batch Retrieve Inventory Counts​

Returns current counts for the provided CatalogObjects at the requested Locations. | key: batchRetrieveInventoryCounts

InputNotesExample
Catalog Object IDs

An array of catalog object IDs in JSON format used to filter inventory results.

[
  "W62UWFY35CWMYGVWK6TWJDNI",
  "X73VXGZ46DXNZHXWL7UXKENJ"
]
Cursor

The pagination cursor returned by a previous call to this endpoint.

Limit

The maximum number of results to return in a single page.

100
Location IDs

An array of location IDs in JSON format used to filter results to specific locations.

[
  "LH2G9VFHJRWKR",
  "LK3H8WGIKSMLA"
]
Connection

The Square connection to use.

States

An array of inventory states in JSON format used to filter results. Options: IN_STOCK, SOLD, RETURNED_BY_CUSTOMER.

[
  "IN_STOCK",
  "SOLD"
]
Updated After

The timestamp filter used to return results whose calculated_at value is after the given time. Format: RFC 3339.

2024-01-01T00:00:00Z
Example Payload for Batch Retrieve Inventory Counts⤓
Loading…

Batch Retrieve Orders​

Retrieves a set of orders by their IDs. | key: batchRetrieveOrders

InputNotesExample
Location ID

The unique identifier for the location.

LH2G9VFHJRWKR
Order IDs

An array of order IDs to retrieve in JSON format. A maximum of 100 orders can be retrieved per request.

[
  "CAISEHUwyPjyk5QFnMR1k5axW5YgAQ",
  "CAISEHUwyPjyk5QFnMR1k5axW5YgAB"
]
Connection

The Square connection to use.

Example Payload for Batch Retrieve Orders⤓
Loading…

Batch Upsert Catalog Objects​

Creates or updates up to 10,000 target objects based on the provided list of objects. | key: batchUpsertCatalogObjects

InputNotesExample
Batches

Array of batches containing catalog objects in JSON format. Each batch may contain up to 1,000 objects. Maximum 10,000 objects total across all batches.

[
  {
    "objects": [
      {
        "type": "ITEM",
        "id": "#coffee-mug",
        "item_data": {
          "name": "Coffee Mug",
          "description": "Ceramic coffee mug"
        }
      }
    ]
  }
]
Idempotency Key

A unique string that identifies this request to ensure idempotent operations.

a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b
Connection

The Square connection to use.

Example Payload for Batch Upsert Catalog Objects⤓
Loading…

Cancel Invoice​

Cancels an invoice. | key: cancelInvoice

InputNotesExample
Invoice ID

The unique identifier for the invoice.

inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
Connection

The Square connection to use.

Example Payload for Cancel Invoice⤓
Loading…

Cancel Payment​

Cancels (voids) a payment. | key: cancelPayment

InputNotesExample
Payment ID

The unique identifier for the payment.

KkAkhdMsgzn59SM8A89WgKwekxLZY
Connection

The Square connection to use.

Example Payload for Cancel Payment⤓
Loading…

Clone Order​

Creates a new order, in the DRAFT state, by duplicating an existing order. | key: cloneOrder

InputNotesExample
Idempotency Key

A unique string that identifies this request to ensure idempotent operations.

a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b
Order ID

The unique identifier for the order.

CAISEHUwyPjyk5QFnMR1k5axW5YgAQ
Connection

The Square connection to use.

Example Payload for Clone Order⤓
Loading…

Complete Payment​

Completes (captures) a payment. | key: completePayment

InputNotesExample
Payment ID

The unique identifier for the payment.

KkAkhdMsgzn59SM8A89WgKwekxLZY
Connection

The Square connection to use.

Version Token

The version token used for optimistic concurrency control. Identifies the current payment version.

gVCJTjmQHQC2VQCFTe3pRHJsaJl
Example Payload for Complete Payment⤓
Loading…

Create Customer​

Creates a new customer profile. | key: createCustomer

InputNotesExample
Address

The customer's mailing address in JSON format. See Square Address Object for field details.

{
  "address_line_1": "1234 Main Street",
  "address_line_2": "Suite 100",
  "locality": "San Francisco",
  "administrative_district_level_1": "CA",
  "postal_code": "94102",
  "country": "US",
  "first_name": "John",
  "last_name": "Doe"
}
Birthday

The customer's date of birth. Format: YYYY-MM-DD.

1990-01-15
Company Name

The name of the company associated with the customer.

Acme Corporation
Email Address

The email address of the customer.

john.doe@example.com
Family Name

The last name of the customer.

Doe
Given Name

The first name of the customer.

John
Idempotency Key

A unique string that identifies this request to ensure idempotent operations.

a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b
Nickname

An informal name to associate with the customer.

Johnny
Note

A free-form note to associate with the customer.

Preferred customer - offer special discounts
Phone Number

The phone number of the customer in E.164 format (e.g., +14155552671).

+14155552671
Reference ID

An optional external reference ID to associate with the customer.

customer-ref-001
Connection

The Square connection to use.

Tax IDs

Tax identification numbers in JSON format. Only applicable for EU countries. See Square Tax IDs for supported formats.

{
  "eu_vat": "IE3426675K"
}
Example Payload for Create Customer⤓
Loading…

Create Job​

Creates a job in a seller account with a title and tip eligibility. | key: createJob

InputNotesExample
Idempotency Key

A unique string that identifies this CreateJob request.

a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b
Is Tip Eligible

When true, employees in this job role are eligible to receive tips.

true
Job Title

The designation for the job role (for example, Cashier, Server, Manager).

Cashier
Connection

The Square connection to use.

Example Payload for Create Job⤓
Loading…

Create Order​

Creates a new order. | key: createOrder

InputNotesExample
Location ID

The unique identifier for the location.

LH2G9VFHJRWKR
Order Object

The complete order object in JSON format. See Square Order Object for field details.

{
  "idempotency_key": "a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b",
  "order": {
    "location_id": "LH2G9VFHJRWKR",
    "line_items": [
      {
        "name": "Coffee Mug",
        "quantity": "1",
        "base_price_money": {
          "amount": 1500,
          "currency": "USD"
        }
      }
    ]
  }
}
Connection

The Square connection to use.

Example Payload for Create Order⤓
Loading…

Create Payment​

Creates a payment using the provided source. | key: createPayment

InputNotesExample
Payment Data

Payment data in JSON format. Amounts are in cents (smallest currency unit). See Square Create Payment for field details.

{
  "source_id": "cnon:card-nonce-ok",
  "idempotency_key": "a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b",
  "amount_money": {
    "amount": 1500,
    "currency": "USD"
  },
  "location_id": "LH2G9VFHJRWKR"
}
Connection

The Square connection to use.

Example Payload for Create Payment⤓
Loading…

Create Team Member​

Creates a new team member. | key: createTeamMember

InputNotesExample
Idempotency Key

A unique string that identifies this request to ensure idempotent operations.

a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b
Connection

The Square connection to use.

Team Member

The team member data in JSON format. See Square TeamMember Object for field details.

{
  "reference_id": "employee-001",
  "status": "ACTIVE",
  "given_name": "John",
  "family_name": "Doe",
  "email_address": "john.doe@example.com",
  "phone_number": "+14155552671",
  "assigned_locations": {
    "assignment_type": "EXPLICIT_LOCATIONS",
    "location_ids": [
      "LH2G9VFHJRWKR"
    ]
  }
}
Example Payload for Create Team Member⤓
Loading…

Create Webhook Subscription​

Creates a webhook subscription. | key: createWebhookSubscription

InputNotesExample
Idempotency Key

A unique string that identifies this request to ensure idempotent operations.

a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b
Connection

The Square connection to use.

Webhook Subscription

The webhook subscription data in JSON format. See Square Webhook Subscription for configuration details.

{
  "name": "Order Updates Webhook",
  "enabled": true,
  "event_types": [
    "order.created",
    "order.updated"
  ],
  "notification_url": "https://your-webhook-endpoint.com/square/webhooks"
}
Example Payload for Create Webhook Subscription⤓
Loading…

Delete Catalog Object​

Deletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response. | key: deleteCatalogObject

InputNotesExample
Object ID

The unique identifier for the catalog object.

W62UWFY35CWMYGVWK6TWJDNI
Connection

The Square connection to use.

Example Payload for Delete Catalog Object⤓
Loading…

Delete Customer​

Deletes a customer profile from a business. | key: deleteCustomer

InputNotesExample
Customer ID

The unique identifier for the customer.

JDKYHBWT1D4F8MFH63DBMEN8Y4
Connection

The Square connection to use.

Example Payload for Delete Customer⤓
Loading…

Delete Instance Webhooks​

Deletes all webhooks that point to a flow in this instance. | key: deleteInstanceWebhooks

InputNotesExample
Connection

The Square connection to use.

Example Payload for Delete Instance Webhooks⤓
Loading…

Delete Invoice​

Deletes an invoice. | key: deleteInvoice

InputNotesExample
Invoice ID

The unique identifier for the invoice.

inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
Connection

The Square connection to use.

Example Payload for Delete Invoice⤓
Loading…

Delete Webhook Subscription​

Deletes a webhook subscription. | key: deleteWebhookSubscription

InputNotesExample
Subscription ID

The unique identifier for the webhook subscription to delete.

wbhk_b35f6b3145074cf9ad513610786c19d5
Connection

The Square connection to use.

Example Payload for Delete Webhook Subscription⤓
Loading…

Get Invoice​

Retrieves an invoice by its ID. | key: getInvoice

InputNotesExample
Invoice ID

The unique identifier for the invoice.

inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
Connection

The Square connection to use.

Example Payload for Get Invoice⤓
Loading…

Get Payment​

Retrieves details for a specific payment. | key: getPayment

InputNotesExample
Payment ID

The unique identifier for the payment.

KkAkhdMsgzn59SM8A89WgKwekxLZY
Connection

The Square connection to use.

Example Payload for Get Payment⤓
Loading…

Get Payment Refund​

Retrieves a specific refund using the refund_id. | key: getPaymentRefund

InputNotesExample
Refund ID

The unique identifier for the payment refund.

KTSQvpHJMXp5hUtvZMgKr5EXhfZZY
Connection

The Square connection to use.

Example Payload for Get Payment Refund⤓
Loading…

List Catalog​

Returns a list of all CatalogObjects of the specified types in the catalog. | key: listCatalog

InputNotesExample
Catalog Version

The specific version of the catalog objects to include in the response. Used to retrieve historical versions of objects. The value is matched against the CatalogObject version attribute.

1234567890123
Cursor

The pagination cursor returned by a previous call to this endpoint.

Connection

The Square connection to use.

Types

An optional case-insensitive, comma-separated list of object types to retrieve. Valid values are defined in the CatalogObjectType enum, for example, ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST, IMAGE.

ITEM, CATEGORY, TAX
Example Payload for List Catalog⤓
Loading…

List Customers​

Lists customer profiles associated with a Square account. | key: listCustomers

InputNotesExample
Cursor

The pagination cursor returned by a previous call to this endpoint.

Limit

The maximum number of results to return in a single page.

100
Sort Field

The field used to sort the results.

Sort Order

The order in which results are sorted.

Connection

The Square connection to use.

Example Payload for List Customers⤓
Loading…

List Invoices​

Returns a list of invoices for a given location. | key: listInvoices

InputNotesExample
Cursor

The pagination cursor returned by a previous call to this endpoint.

Limit

The maximum number of results to return in a single page.

100
Location ID

The unique identifier for the location.

LH2G9VFHJRWKR
Connection

The Square connection to use.

Example Payload for List Invoices⤓
Loading…

List Jobs​

Lists jobs in a seller account, sorted by title in ascending order. | key: listJobs

InputNotesExample
Cursor

The pagination cursor returned by a previous call to this endpoint.

Fetch All

When true, automatically fetches all pages of results using cursor pagination.

false
Connection

The Square connection to use.

Example Payload for List Jobs⤓
Loading…

List Locations​

Lists all of the seller's locations, including those with an inactive status. | key: listLocations

InputNotesExample
Connection

The Square connection to use.

Example Payload for List Locations⤓
Loading…

List Payment Refunds​

Retrieves a list of refunds for the account making the request. | key: listPaymentRefunds

InputNotesExample
Begin Time

The timestamp marking the start of the time range. Format: RFC 3339.

2024-01-01T00:00:00Z
Cursor

The pagination cursor returned by a previous call to this endpoint.

End Time

The end of the time range used to retrieve payments. Filtered using the created_at field. Format: RFC 3339.

2024-12-31T23:59:59Z
Limit

The maximum number of results to return in a single page.

100
Location ID

The unique identifier for the location.

LH2G9VFHJRWKR
Sort Order

The order in which results are sorted.

Source Type

When provided, only refunds whose payments have the indicated source type are returned.

CARD
Connection

The Square connection to use.

Status

When provided, only refunds with the given status are returned.

COMPLETED
Example Payload for List Payment Refunds⤓
Loading…

List Payments​

Retrieves a list of payments taken by the account making the request. | key: listPayments

InputNotesExample
Begin Time

The timestamp marking the start of the time range. Format: RFC 3339.

2024-01-01T00:00:00Z
Card Brand

The brand of the payment card (for example, VISA, MASTERCARD, AMEX).

VISA
Cursor

The pagination cursor returned by a previous call to this endpoint.

End Time

The end of the time range used to retrieve payments. Filtered using the created_at field. Format: RFC 3339.

2024-12-31T23:59:59Z
Last 4 Digits of Card

The last four digits of the payment card used.

1234
Limit

The maximum number of results to return in a single page.

100
Location ID

The unique identifier for the location.

LH2G9VFHJRWKR
Sort Order

The order in which results are sorted.

Connection

The Square connection to use.

Total

The exact payment amount in cents (smallest currency unit). For example, 1500 for $15.00.

1500
Example Payload for List Payments⤓
Loading…

List Webhook Subscriptions​

Lists all webhook subscriptions owned by your application. | key: listWebhookSubscriptions

InputNotesExample
Cursor

The pagination cursor returned by a previous call to this endpoint.

Include Disabled

When true, disabled subscriptions are included in the results. By default, only enabled subscriptions are returned.

false
Limit

The maximum number of results to return in a single page.

100
Sort Order

The sort order for subscriptions by creation date. Options: ASC (oldest first), DESC (newest first).

DESC
Connection

The Square connection to use.

Example Payload for List Webhook Subscriptions⤓
Loading…

Publish Invoice​

Publishes an invoice. | key: publishInvoice

InputNotesExample
Idempotency Key

A unique string that identifies this request to ensure idempotent operations.

a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b
Invoice ID

The unique identifier for the invoice.

inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
Connection

The Square connection to use.

Example Payload for Publish Invoice⤓
Loading…

Raw Request​

Sends a raw HTTP request to the Square API. | key: rawRequest

InputNotesExample
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Connection

The Square connection to use.

Timeout

The maximum time that a client will await a response to its request

2000
URL

This is the URL to call.

/v2/locations
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false
Example Payload for Raw Request⤓
Loading…

Refund Payment​

Refunds a payment. You can refund the entire payment amount or a portion of it. | key: refundPayment

InputNotesExample
Idempotency Key

A unique string that identifies this request to ensure idempotent operations.

a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b
Payment ID

The unique identifier for the payment.

KkAkhdMsgzn59SM8A89WgKwekxLZY
Reason

A description of the reason for the refund.

Customer requested refund due to defective product
Refund Amount

The refund amount in JSON format. Amount is in cents (smallest currency unit). Cannot exceed the payment total minus previous refunds.

{
  "amount": 1500,
  "currency": "USD"
}
Connection

The Square connection to use.

Example Payload for Refund Payment⤓
Loading…

Retrieve Catalog Object​

Returns a single CatalogObject based on the provided ID. | key: retrieveCatalogObject

InputNotesExample
Catalog Version

The specific version of the catalog objects to include in the response. Used to retrieve historical versions of objects. The value is matched against the CatalogObject version attribute.

1234567890123
Include Related Objects

When true, the response includes additional objects that are related to the requested objects.

false
Object ID

The unique identifier for the catalog object.

W62UWFY35CWMYGVWK6TWJDNI
Connection

The Square connection to use.

Example Payload for Retrieve Catalog Object⤓
Loading…

Retrieve Customer​

Retrieves details for a single customer. | key: retrieveCustomer

InputNotesExample
Customer ID

The unique identifier for the customer.

JDKYHBWT1D4F8MFH63DBMEN8Y4
Connection

The Square connection to use.

Example Payload for Retrieve Customer⤓
Loading…

Retrieve Job​

Retrieves a specified job by ID. | key: retrieveJob

InputNotesExample
Job ID

The unique identifier for the job.

1yJlHapkseYnNPETIU1B
Connection

The Square connection to use.

Example Payload for Retrieve Job⤓
Loading…

Retrieve Location​

Retrieves details of a specific location. | key: retrieveLocation

InputNotesExample
Location ID

The unique identifier for the location.

LH2G9VFHJRWKR
Connection

The Square connection to use.

Example Payload for Retrieve Location⤓
Loading…

Retrieve Order​

Retrieves an Order by its ID. | key: retrieveOrder

InputNotesExample
Order ID

The unique identifier for the order.

CAISEHUwyPjyk5QFnMR1k5axW5YgAQ
Connection

The Square connection to use.

Example Payload for Retrieve Order⤓
Loading…

Retrieve Team Member​

Retrieves a team member based on the provided ID. | key: retrieveTeamMember

InputNotesExample
Connection

The Square connection to use.

Team Member ID

The unique identifier for the team member.

1yJlHapkseYnNPETIU1B
Example Payload for Retrieve Team Member⤓
Loading…

Retrieve Webhook Subscription​

Retrieves a webhook subscription identified by its ID. | key: retrieveWebhookSubscription

InputNotesExample
Connection

The Square connection to use.

Subscription ID

The unique identifier for the webhook subscription.

wbhk_b35f6b3145074cf9ad513610786c19d5
Example Payload for Retrieve Webhook Subscription⤓
Loading…

Search Catalog Items​

Searches for catalog items or item variations by matching supported search attribute values, including custom attribute values, against one or more of the specified query filters. | key: searchCatalogItems

InputNotesExample
Category IDs

An array of category IDs in JSON format used to filter items by category.

[
  "W62UWFY35CWMYGVWK6TWJDNI",
  "X73VXGZ46DXNZHXWL7UXKENJ"
]
Cursor

The pagination cursor returned by a previous call to this endpoint.

Custom Attribute Filters

An array of custom attribute filters in JSON format used to match items with specific custom attributes.

[
  {
    "custom_attribute_definition_id": "W62UWFY35CWMYGVWK6TWJDNI",
    "key": "color",
    "string_filter": "blue",
    "bool_filter": true
  }
]
Enabled Location IDs

An array of location IDs in JSON format used to filter items by enabled locations.

[
  "LH2G9VFHJRWKR",
  "LK3H8WGIKSMLA"
]
Limit

The maximum number of results to return in a single page.

100
Product Types

An array of product types in JSON format used to filter items. Options: REGULAR, APPOINTMENTS_SERVICE.

[
  "REGULAR",
  "APPOINTMENTS_SERVICE"
]
Sort Order

The order in which results are sorted.

Connection

The Square connection to use.

Stock Levels

An array of stock levels in JSON format used to filter items. Options: OUT, LOW.

[
  "OUT",
  "LOW"
]
Text Filter

The text filter expression used to return items or item variations containing the specified text.

coffee mug
Example Payload for Search Catalog Items⤓
Loading…

Search Catalog Objects​

Searches for CatalogObject of any type by matching supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query filters. | key: searchCatalogObjects

InputNotesExample
Begin Time

The timestamp marking the start of the time range. Format: RFC 3339.

2024-01-01T00:00:00Z
Catalog Query

Query to filter or sort catalog results in JSON format. See Square Catalog Query for query options.

{
  "sorted_attribute_query": {
    "attribute_name": "name",
    "initial_attribute_value": "A",
    "sort_order": "ASC"
  },
  "exact_query": {
    "attribute_name": "type",
    "attribute_value": "ITEM"
  }
}
Cursor

The pagination cursor returned by a previous call to this endpoint.

Include Deleted Objects

When true, deleted objects are included in the results.

false
Include Related Objects

When true, the response includes additional objects that are related to the requested objects.

false
Limit

The maximum number of results to return in a single page.

100
Object Types

A comma-separated list of catalog object types to include in the search results. Options: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST.

ITEM,CATEGORY,TAX
Connection

The Square connection to use.

Example Payload for Search Catalog Objects⤓
Loading…

Search Customers​

Searches for customer profiles. | key: searchCustomers

InputNotesExample
Cursor

The pagination cursor returned by a previous call to this endpoint.

Limit

The maximum number of results to return in a single page.

100
Query

The query to search for customers. See Square Search Customers for filter and sort options.

{
  "query": {
    "filter": {
      "creation_source": {
        "values": [
          "THIRD_PARTY"
        ],
        "rule": "INCLUDE"
      },
      "created_at": {
        "start_at": "2024-01-01T00:00:00-00:00",
        "end_at": "2024-02-01T00:00:00-00:00"
      },
      "email_address": {
        "fuzzy": "example.com"
      },
      "group_ids": {
        "all": [
          "JDKYHBWT1D4F8MFH63DBMEN8Y4"
        ]
      }
    },
    "sort": {
      "field": "CREATED_AT",
      "order": "ASC"
    }
  }
}
Connection

The Square connection to use.

Example Payload for Search Customers⤓
Loading…

Search Invoices​

Searches for invoices from a location specified in the filter. | key: searchInvoices

InputNotesExample
Cursor

The pagination cursor returned by a previous call to this endpoint.

Query

The query to search for invoices. See Square Search Invoices for filter and sort options.

{
  "filter": {
    "location_ids": [
      "LH2G9VFHJRWKR"
    ],
    "customer_ids": [
      "JDKYHBWT1D4F8MFH63DBMEN8Y4"
    ]
  },
  "sort": {
    "field": "INVOICE_SORT_DATE",
    "order": "DESC"
  }
}
Limit

The maximum number of results to return in a single page.

100
Connection

The Square connection to use.

Example Payload for Search Invoices⤓
Loading…

Search Orders​

Searches all orders for one or more locations. | key: searchOrders

InputNotesExample
Cursor

The pagination cursor returned by a previous call to this endpoint.

Limit

The maximum number of results to return in a single page.

100
Location IDs

An array of location IDs in JSON format used to filter results to specific locations.

[
  "LH2G9VFHJRWKR",
  "LK3H8WGIKSMLA"
]
Query

The query to search for orders. See Square Search Orders for filter and sort options.

{
  "filter": {
    "state_filter": {
      "states": [
        "COMPLETED"
      ]
    },
    "date_time_filter": {
      "closed_at": {
        "start_at": "2024-01-01T00:00:00+00:00",
        "end_at": "2024-12-31T23:59:59+00:00"
      }
    },
    "customer_filter": {
      "customer_ids": [
        "JDKYHBWT1D4F8MFH63DBMEN8Y4"
      ]
    }
  },
  "sort": {
    "sort_field": "CLOSED_AT",
    "sort_order": "DESC"
  }
}
Return Entries

When true, the entries associated with the orders are returned.

true
Connection

The Square connection to use.

Example Payload for Search Orders⤓
Loading…

Search Team Members​

Searches for team members based on the given filters. | key: searchTeamMembers

InputNotesExample
Cursor

The pagination cursor returned by a previous call to this endpoint.

Limit

The maximum number of results to return in a single page.

100
Search Query

The query parameters to filter team members. See Square Search Team Members for filter options.

{
  "filter": {
    "location_ids": [
      "LH2G9VFHJRWKR"
    ],
    "status": "ACTIVE",
    "is_owner": false
  }
}
Connection

The Square connection to use.

Example Payload for Search Team Members⤓
Loading…

Update Customer​

Updates a customer profile. | key: updateCustomer

InputNotesExample
Address

The customer's mailing address in JSON format. See Square Address Object for field details.

{
  "address_line_1": "1234 Main Street",
  "address_line_2": "Suite 100",
  "locality": "San Francisco",
  "administrative_district_level_1": "CA",
  "postal_code": "94102",
  "country": "US",
  "first_name": "John",
  "last_name": "Doe"
}
Birthday

The customer's date of birth. Format: YYYY-MM-DD.

1990-01-15
Company Name

The name of the company associated with the customer.

Acme Corporation
Customer ID

The unique identifier for the customer.

JDKYHBWT1D4F8MFH63DBMEN8Y4
Email Address

The email address of the customer.

john.doe@example.com
Family Name

The last name of the customer.

Doe
Given Name

The first name of the customer.

John
Nickname

An informal name to associate with the customer.

Johnny
Note

A free-form note to associate with the customer.

Preferred customer - offer special discounts
Phone Number

The phone number of the customer in E.164 format (e.g., +14155552671).

+14155552671
Reference ID

An optional external reference ID to associate with the customer.

customer-ref-001
Connection

The Square connection to use.

Tax IDs

Tax identification numbers in JSON format. Only applicable for EU countries. See Square Tax IDs for supported formats.

{
  "eu_vat": "IE3426675K"
}
Example Payload for Update Customer⤓
Loading…

Update Invoice​

Updates an invoice. | key: updateInvoice

InputNotesExample
Invoice ID

The unique identifier for the invoice.

inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
Connection

The Square connection to use.

Update Invoice

The invoice data to update in JSON format. See Square Update Invoice for field details.

{
  "invoice": {
    "version": 1,
    "payment_requests": [
      {
        "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355",
        "tipping_enabled": false
      }
    ]
  },
  "idempotency_key": "4ee82288-0910-499e-ab4c-5d0071dad1be",
  "fields_to_clear": [
    "payment_requests[2da7964f-f3d2-4f43-81e8-5aa220bf3355].reminders"
  ]
}
Example Payload for Update Invoice⤓
Loading…

Update Job​

Updates the title or tip eligibility of a job. Changes propagate to all job assignments, shifts, and wage settings. | key: updateJob

InputNotesExample
Is Tip Eligible

When true, employees in this job role are eligible to receive tips. Only include if changing tip eligibility.

true
Job ID

The unique identifier for the job.

1yJlHapkseYnNPETIU1B
Job Title

Updated job title. Only include if changing the title.

Cashier
Connection

The Square connection to use.

Version

The version number used for optimistic concurrency control. Ensures the object has not been modified by another request.

1
Example Payload for Update Job⤓
Loading…

Update Location​

Updates a location associated with a Square account. | key: updateLocation

InputNotesExample
Location ID

The unique identifier for the location.

LH2G9VFHJRWKR
Location Update

The location data to update in JSON format. See Square Location Object for field details.

{
  "id": "LH2G9VFHJRWKR",
  "name": "Downtown Store",
  "address": {
    "address_line_1": "1234 Main Street",
    "locality": "San Francisco",
    "administrative_district_level_1": "CA",
    "postal_code": "94102"
  },
  "timezone": "America/Los_Angeles",
  "status": "ACTIVE",
  "country": "US",
  "language_code": "en-US",
  "currency": "USD",
  "type": "PHYSICAL",
  "description": "Main downtown retail location",
  "coordinates": {
    "latitude": 37.7749,
    "longitude": -122.4194
  },
  "business_hours": {
    "periods": [
      {
        "day_of_week": "MON",
        "start_local_time": "09:00",
        "end_local_time": "18:00"
      },
      {
        "day_of_week": "TUE",
        "start_local_time": "09:00",
        "end_local_time": "18:00"
      }
    ]
  },
  "business_name": "Example Business",
  "mcc": "5999"
}
Connection

The Square connection to use.

Example Payload for Update Location⤓
Loading…

Update Order​

Updates an open order by adding, replacing, or deleting fields. | key: updateOrder

InputNotesExample
Fields to Clear

Array of dot notation paths for fields to clear in JSON format. For example: line_items[uid].note or discounts[uid].

[
  "line_items[uid].note",
  "discounts[uid]"
]
Idempotency Key

A unique string that identifies this request to ensure idempotent operations.

a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b
Order ID

The unique identifier for the order.

CAISEHUwyPjyk5QFnMR1k5axW5YgAQ
Order Object

The complete order object in JSON format. See Square Order Object for field details.

{
  "idempotency_key": "a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b",
  "order": {
    "location_id": "LH2G9VFHJRWKR",
    "line_items": [
      {
        "name": "Coffee Mug",
        "quantity": "1",
        "base_price_money": {
          "amount": 1500,
          "currency": "USD"
        }
      }
    ]
  }
}
Connection

The Square connection to use.

Example Payload for Update Order⤓
Loading…

Update Payment​

Updates a payment with the APPROVED status. | key: updatePayment

InputNotesExample
Payment

Payment data in JSON format. Amounts are in cents (smallest currency unit). See Square Payment Object for field details.

{
  "amount_money": {
    "amount": 1500,
    "currency": "USD"
  },
  "tip_money": {
    "amount": 300,
    "currency": "USD"
  }
}
Payment ID

The unique identifier for the payment.

KkAkhdMsgzn59SM8A89WgKwekxLZY
Connection

The Square connection to use.

Example Payload for Update Payment⤓
Loading…

Update Team Member​

Updates a team member. | key: updateTeamMember

InputNotesExample
Connection

The Square connection to use.

Team Member

The team member data in JSON format. See Square TeamMember Object for field details.

{
  "reference_id": "employee-001",
  "status": "ACTIVE",
  "given_name": "John",
  "family_name": "Doe",
  "email_address": "john.doe@example.com",
  "phone_number": "+14155552671",
  "assigned_locations": {
    "assignment_type": "EXPLICIT_LOCATIONS",
    "location_ids": [
      "LH2G9VFHJRWKR"
    ]
  }
}
Team Member ID

The unique identifier for the team member.

1yJlHapkseYnNPETIU1B
Example Payload for Update Team Member⤓
Loading…

Update Webhook Subscription​

Updates a webhook subscription. | key: updateWebhookSubscription

InputNotesExample
Connection

The Square connection to use.

Subscription ID

The unique identifier for the webhook subscription.

wbhk_b35f6b3145074cf9ad513610786c19d5
Webhook Subscription

The updated webhook subscription data in JSON format. Include only the fields to modify.

{
  "name": "Updated Order Webhook",
  "enabled": true,
  "event_types": [
    "order.created",
    "order.updated",
    "order.fulfilled"
  ],
  "notification_url": "https://your-webhook-endpoint.com/square/webhooks"
}
Example Payload for Update Webhook Subscription⤓
Loading…

Upsert Catalog Object​

Creates a new or updates the specified CatalogObject. | key: upsertCatalogObject

InputNotesExample
Catalog Object

Catalog object data in JSON format. See Square Catalog Object for field details.

{
  "type": "ITEM",
  "id": "#temp-item-id",
  "item_data": {
    "name": "Coffee Mug",
    "description": "Ceramic coffee mug - 12oz capacity",
    "abbreviation": "MUG",
    "category_id": "W62UWFY35CWMYGVWK6TWJDNI",
    "variations": [
      {
        "type": "ITEM_VARIATION",
        "id": "#temp-variation-id",
        "item_variation_data": {
          "item_id": "#temp-item-id",
          "name": "Regular",
          "pricing_type": "FIXED_PRICING",
          "price_money": {
            "amount": 1500,
            "currency": "USD"
          }
        }
      }
    ]
  }
}
Idempotency Key

A unique string that identifies this request to ensure idempotent operations.

a7c8e4b1-3f5d-4e2a-9c1b-7d3e5f8a2c6b
Connection

The Square connection to use.

Example Payload for Upsert Catalog Object⤓
Loading…

Changelog​

2026-05-26​

Added the New and Updated Payments polling trigger using the Payments API's updated_at_begin_time filter. The trigger walks the cursor stream sorted by UPDATED_AT and partitions records into created and updated buckets based on each payment's created_at and updated_at timestamps

2026-04-30​

Updated spectral version

2026-04-08​

Updated Square API reference links

2026-03-31​

Various modernizations and documentation updates

2026-02-26​

Added inline data source for refunds to enable dynamic dropdown selection

2025-11-17​

Added Jobs API support with actions for managing jobs:

  • List Jobs - List jobs in a seller account, sorted by title
  • Create Job - Create a new job with title and tip eligibility
  • Retrieve Job - Retrieve a specific job by ID
  • Update Job - Update job title, tip eligibility, or version

Added inline data sources for Jobs, Team Members, Invoices, Orders, Payments, and Webhook Subscriptions to enhance data selection capabilities