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

# Atualizar link de pagamento

> Atualiza dados, ativação, cupons e trial do link

Atualização parcial: campos omitidos permanecem. `null` limpa `description`, `checkoutLayout`, `successUrl` e `cancelUrl`. Para alterar itens e bumps use as rotas de [itens](./add-item) e [bumps](./add-bump).

Permissão: `payment_link.write` (chave secreta).

## Endpoint

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PATCH https://api.upag.dev/v1/payment-links/d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70 \
    -H "Authorization: Bearer sk_test_your_api_key" \
    -H "Content-Type: application/json" \
    -d '{
      "couponEnabled": true,
      "subscriptionData": {
        "trial": { "interval": "day", "intervalCount": 14 }
      }
    }'
  ```

  ```javascript Node.js SDK theme={null}
  import { Upag } from 'upag';

  const upag = new Upag('sk_test_your_api_key');

  const link = await upag.paymentLinks.update('d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70', {
    couponEnabled: true,
    subscriptionData: { trial: { interval: 'day', intervalCount: 14 } }, // trial: null remove o trial
  });
  ```
</CodeGroup>

<Note>
  Em produção use `https://api.upag.io/v1` com `sk_live_...`.
</Note>

## Parâmetros

<ParamField path="paymentLinkId" type="string (uuid)" required>
  ID do link de pagamento.
</ParamField>

<ParamField body="name" type="string">
  1 a 255 caracteres.
</ParamField>

<ParamField body="description" type="string | null">
  Descrição.
</ParamField>

<ParamField body="checkoutLayout" type="string (uuid) | null">
  ID de um [layout de checkout](../checkout-layouts/reference) da conta.
</ParamField>

<ParamField body="paymentMethods" type="string[]">
  `pix` e/ou `card` (mínimo 1).
</ParamField>

<ParamField body="billingAddressCollection" type="string">
  `auto`, `required` ou `none`.
</ParamField>

<ParamField body="successUrl" type="string (url) | null">
  URL de sucesso.
</ParamField>

<ParamField body="cancelUrl" type="string (url) | null">
  URL de cancelamento.
</ParamField>

<ParamField body="active" type="boolean">
  Ativa ou desativa o link.
</ParamField>

<ParamField body="couponEnabled" type="boolean">
  Permite o comprador aplicar cupons.
</ParamField>

<ParamField body="subscriptionData" type="object">
  `trial` (`{ interval, intervalCount }` ou `null` para remover) e/ou `trialSettings.endBehavior.missingPaymentMethod` (`create_invoice` ou `cancel`). Campos omitidos mantêm o valor atual.
</ParamField>

<ParamField body="paymentMethodCollection" type="string">
  `always` ou `if_required`.
</ParamField>

## Resposta

`200 OK`

```json Response theme={null}
{
  "id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70",
  "name": "Plano Pro com trial",
  "description": null,
  "checkoutLayout": null,
  "active": true,
  "amount": 4990,
  "url": "https://checkout.upag.io/buy/Xk3mPq9RtVw2Zd7B",
  "paymentMethods": ["pix", "card"],
  "couponEnabled": true,
  "billingAddressCollection": "auto",
  "successUrl": "https://example.com/obrigado",
  "cancelUrl": null,
  "subscriptionData": {
    "trial": { "interval": "day", "intervalCount": 14 },
    "trialSettings": { "endBehavior": { "missingPaymentMethod": "cancel" } }
  },
  "paymentMethodCollection": "always",
  "items": [
    {
      "id": "e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a81",
      "product": "0b9c1f3e-6a4d-4c1e-9d55-3f1f6a7c2e10",
      "price": "5f2d7a90-3b1c-4e8a-8f6d-1c9e4b7a2d33",
      "quantity": 1,
      "amount": 4990
    }
  ],
  "bumps": [],
  "createdAt": "2026-03-18T11:20:00.000Z",
  "updatedAt": "2026-03-18T12:30:00.000Z"
}
```

* `404` — `PAYMENT_LINK_NOT_FOUND` ou `CHECKOUT_LAYOUT_NOT_FOUND`.
* `400` — alterações de trial ou métodos que violem as [regras de consistência](./reference).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.