> ## 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.

# Get the status of a recurring payment

> Retrieve the current status and execution details of a recurring payment. Returns information about executed payments, remaining executions, next payment date, and overall status. This endpoint is useful for monitoring recurring payment progress and checking if payments are being executed as expected. Note: Customer information (PII) is not included in the response for security reasons.



## OpenAPI

````yaml /api-reference/openapi.v2.json get /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}:
    get:
      tags:
        - Pay
        - V2/Payouts
      summary: Get the status of a recurring payment
      description: >-
        Retrieve the current status and execution details of a recurring
        payment. Returns information about executed payments, remaining
        executions, next payment date, and overall status. This endpoint is
        useful for monitoring recurring payment progress and checking if
        payments are being executed as expected. Note: Customer information
        (PII) is not included in the response for security reasons.
      operationId: PayoutV2Controller_getRecurringPaymentStatus_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
      responses:
        '200':
          description: Recurring payment status retrieved successfully
          content:
            application/json:
              examples:
                active:
                  summary: Active recurring payment
                  value:
                    processedPayments: 3
                    totalPayments: 30
                    lastPaymentDate: '2025-01-04T10:00:00.000Z'
                    nextPaymentDate: '2025-01-05T10:00:00.000Z'
                    status: active
                    requests:
                      - paymentReference: '0xb3581f0b0f74cc61'
                        requestId: >-
                          01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb
                    payments:
                      - id: 01JXYJKCAHGFTDR15F2D072ESG
                        amount: '10'
                        timestamp: '2025-01-04T10:00:00.000Z'
                        txHash: >-
                          0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
                paused:
                  summary: Paused recurring payment
                  value:
                    processedPayments: 5
                    totalPayments: 30
                    lastPaymentDate: '2025-01-05T10:00:00.000Z'
                    nextPaymentDate: null
                    status: paused
                    failureCount: 3
                    failureReason: Insufficient token allowance
                completed:
                  summary: Completed recurring payment
                  value:
                    processedPayments: 30
                    totalPayments: 30
                    lastPaymentDate: '2025-01-30T10:00:00.000Z'
                    nextPaymentDate: null
                    status: completed
        '404':
          description: Recurring payment not found
          content:
            application/json:
              examples:
                notFound:
                  summary: Recurring payment not found
                  value:
                    message: Recurring payment not found
                    error: Not Found
                    statusCode: 404
        '429':
          description: Too Many Requests

````