Update Payment Link - Automate.ax

square.updatePaymentLink updates a payment link.

Example

automations/square-update-payment-link.automation.ts

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

export default automation("Update Square Payment Link", () => {
  onDashboardRun({ title: "Update Square Payment Link" })

  square.updatePaymentLink({
    id: "id",
    paymentLink: {
      version: 1,
      checkoutOptions: {
        askForShippingAddress: true,
      },
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires ORDERS_READ and ORDERS_WRITE and PAYMENTS_WRITE.

Field	Type	Required	Default	Description
`id`	`string`	Yes	—	The ID of the payment link to update.
`paymentLink`	`Square.PaymentLink`	Yes	—	The `payment_link` object describing the updates to apply. For more information, see Update a payment link.

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

Output

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