Delete Customer - Automate.ax

square.deleteCustomer deletes a customer profile from a business.

Example

automations/square-delete-customer.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Delete Square Customer", () => {
  onDashboardRun({ title: "Delete Square Customer" })

  square.deleteCustomer({
    customerId: "customer_id",
    version: BigInt("1000000"),
  })
})

Inputs

Every input accepts a compatible signal. It requires CUSTOMERS_WRITE.

Field	Type	Required	Default	Description
`customerId`	`string`	Yes	—	The ID of the customer to delete.
`version`	`bigint \| null`	No	—	The current version of the customer profile. As a best practice, you should include this parameter to enable optimistic concurrency control. For more information, see Delete a customer profile.

Use the official DeleteCustomer reference for provider field semantics and limits.

Output

Returns the official Square.DeleteCustomerResponse response as a codec-safe object. Square integer money amounts remain bigint values.