> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Update Payment Link

> Updates a payment link.

`square.updatePaymentLink` updates a payment link.

## Example

```ts automations/square-update-payment-link.automation.ts theme={null}
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](https://developer.squareup.com/docs/checkout-api/manage-checkout#update-a-payment-link). |

Use the official [UpdatePaymentLink reference](https://developer.squareup.com/reference/square/checkout-api/update-payment-link) 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.