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

# Update a recurring payment

> Update a recurring payment by cancelling it or unpausing it. When cancelling, optionally returns a transaction to decrease allowance. When unpausing, resumes execution of a paused recurring payment.



## OpenAPI

````yaml /api-reference/openapi.v2.json patch /v2/payouts/recurring/{id}
openapi: 3.0.0
info:
  title: Request Network API
  description: API for easily creating and paying Requests with Request Network.
  version: 0.13.0
  contact: {}
servers:
  - url: https://api.request.network
    description: Production server
  - url: https://api.stage.request.network
    description: Staging server
  - url: http://127.0.0.1:8080
    description: Local development server
security: []
tags:
  - name: V2/Request
    description: Core payment request operations (V2)
  - name: V2/Payments
    description: Payment search and management operations (V2)
  - name: V2/Payouts
    description: Pay a request without creating one first (V2)
  - name: V2/Payer
    description: Crypto-to-fiat payer management operations (V2)
  - name: V2/Currencies
    description: Currency operations (V2)
  - name: V2/Client IDs
    description: Client ID management (V2)
  - name: V2/Payee Destination
    description: Payee destination management (V2)
externalDocs:
  description: Request Network Docs
  url: https://docs.request.network/request-network-api
paths:
  /v2/payouts/recurring/{id}:
    patch:
      tags:
        - Pay
        - V2/Payouts
      summary: Update a recurring payment
      description: >-
        Update a recurring payment by cancelling it or unpausing it. When
        cancelling, optionally returns a transaction to decrease allowance. When
        unpausing, resumes execution of a paused recurring payment.
      operationId: PayoutV2Controller_updateRecurringPayment_v2
      parameters:
        - name: id
          required: true
          in: path
          description: The ID of the recurring payment
          schema:
            example: 01JXYJKCAHGFTDR15F2D072ESG
            type: string
        - name: x-api-key
          in: header
          description: API key for authentication (optional if using Client ID)
          required: false
          schema:
            type: string
        - name: x-client-id
          in: header
          description: Client ID for frontend authentication (optional if using API key)
          required: false
          schema:
            type: string
        - name: Origin
          in: header
          description: >-
            Origin header (required for Client ID auth, automatically set by
            browser)
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  enum:
                    - cancel
                    - unpause
                  description: The action to perform on the recurring payment
              required:
                - action
              example:
                action: cancel
      responses:
        '200':
          description: Recurring payment updated successfully
          content:
            application/json:
              examples:
                cancelled:
                  summary: Recurring payment cancelled
                  value:
                    id: 01JXYJKCAHGFTDR15F2D072ESG
                    status: cancelled
                    transactions:
                      - to: '0xA0b86a33E6441b8c4C8C8C8C8C8C8C8C8C8C8C8'
                        data: >-
                          0x095ea7b30000000000000000000000000363dD3ccD4f187d7033c57354CA81f998451D590000000000000000000000000000000000000000000000000000000000000000
                        value: '0x0'
                    metadata:
                      remainingPayments: 5
                      remainingAmount: '5000000000000000000'
                      processedPayments: 3
                      totalPayments: 8
                unpaused:
                  summary: Recurring payment unpaused
                  value:
                    id: 01JXYJKCAHGFTDR15F2D072ESG
                    status: active
                    metadata:
                      processedPayments: 3
                      totalPayments: 8
                      nextPaymentDate: '2024-01-15T10:00:00.000Z'
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                alreadyCancelled:
                  summary: Recurring payment is already cancelled
                  value:
                    message: Recurring payment is already cancelled
                    error: Bad Request
                    statusCode: 400
                completed:
                  summary: Cannot cancel a completed recurring payment
                  value:
                    message: Cannot cancel a completed recurring payment
                    error: Bad Request
                    statusCode: 400
                notPaused:
                  summary: Recurring payment is not paused
                  value:
                    message: Recurring payment is not paused
                    error: Bad Request
                    statusCode: 400
                invalidAction:
                  summary: Invalid action provided
                  value:
                    message: 'Invalid action: invalid_action'
                    error: Bad Request
                    statusCode: 400
        '404':
          description: Recurring payment not found
        '429':
          description: Too Many Requests

````