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

# Update Payment Link

> Update or deactivate a payment link.

## Overview

Update a payment link. Setting `status` to `inactive` closes it while keeping
every payment it has taken, which is what you want for reporting on a quarter
that has ended.


## OpenAPI

````yaml PATCH /v1/payment-links/{id}
openapi: 3.1.0
info:
  title: Reclack API
  version: 1.0.0
  description: >-
    Recurring and one-time stablecoin payments, taken straight from your
    customers' wallets.


    Reclack is non-custodial. Payments move from a customer's wallet to a
    settlement address you control, and Reclack never holds funds and never asks
    anyone for a seed phrase or a private key.


    ## Authentication


    Send your API key in the `Api-Key` header:


    ```

    Api-Key: rk_live_your_key_here

    ```


    `X-API-Key` is accepted too. The key prefix decides the environment:
    `rk_sandbox_` for test chains, `rk_live_` for production.


    ## Responses


    Objects and lists come back under `data`. Errors come back under `error`
    with a `type`, an optional `code` and a message written for a person.
servers:
  - url: https://api.reclack.com
    description: Sandbox and live, chosen by your key
security:
  - apiKeyAuth: []
tags:
  - name: Products
  - name: Prices
  - name: Customers
  - name: Subscriptions
  - name: Usage
  - name: Invoices
  - name: Checkouts
  - name: Payment links
  - name: Transactions
  - name: Webhooks
  - name: API keys
  - name: Settlement
paths:
  /v1/payment-links/{id}:
    patch:
      tags:
        - Payment links
      summary: Update payment link
      description: Update or deactivate a payment link.
      operationId: payment-links-update
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The payment link id.
          example: plink_8Qd3ZkR2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: Dana Okafor
                status:
                  type: string
                  enum:
                    - active
                    - inactive
                collect_email:
                  type: boolean
                collect_name:
                  type: boolean
                after_completion:
                  type: string
                  enum:
                    - message
                    - redirect
                confirmation_message:
                  type: string
                  example: Payment received. Access is live.
                redirect_url:
                  type: string
                  example: https://acme.dev/thanks
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PaymentLink'
        '400':
          description: The request is missing something or contradicts itself
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: No key, a revoked key, or a key that does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key is valid but is not allowed to do this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    PaymentLink:
      type: object
      properties:
        id:
          type: string
          example: plink_8Qd3ZkR2
        name:
          type: string
          example: Premium Research Access
        type:
          type: string
          enum:
            - fixed
            - custom_amount
          example: fixed
        status:
          type: string
          enum:
            - active
            - inactive
          example: active
        url:
          type: string
          example: https://pay.reclack.com/plink_8Qd3ZkR2
        price_id:
          type: string
          example: price_7Fh2PqX9
        min_amount:
          type: string
          example: '5.00'
        max_amount:
          type: string
          example: '500.00'
        preset_amount:
          type: string
          example: '25.00'
        collect_email:
          type: boolean
        collect_name:
          type: boolean
        collect_phone:
          type: boolean
        collect_address:
          type: boolean
        max_payments:
          type: integer
        after_completion:
          type: string
          enum:
            - message
            - redirect
        confirmation_message:
          type: string
          example: Payment received. Access is live.
        redirect_url:
          type: string
          example: https://acme.dev/thanks
        fee_payer:
          type: string
          enum:
            - merchant
            - customer
        created_at:
          type: string
          format: date-time
          example: '2026-10-18T22:07:41Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-10-18T22:07:41Z'
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              description: >-
                One of invalid_request_error, authentication_error,
                permission_error or api_error.
              example: invalid_request_error
            code:
              type: string
              description: A stable, machine readable reason.
              example: price_not_found
            message:
              type: string
              description: A sentence written for a person.
              example: No price was found for that id
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Api-Key
      description: >-
        Your Reclack API key. The prefix decides the environment: rk_sandbox_
        for test chains, rk_live_ for production.

````

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