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

# List Recurring Invoices

> Retrieves a paginated (cursor) list of recurring-invoice templates for a
Merchant, optionally filtered by status.



## OpenAPI

````yaml https://app.dimepayments.com/openapi.yaml get /api/recurring-invoices
openapi: 3.0.3
info:
  title: Dime Payments API Documentation
  description: >-
    A simple, basic API for managing Merchants through Dime Payments. JSON based
    REST API
  version: 1.0.0
servers:
  - url: https://app.dimepayments.com
security:
  - default: []
tags:
  - name: Merchant management
    description: ''
  - name: Transaction management
    description: >-

      APIs for managing transactions.  Depending on API KEY permissions, one
      should be able to

      charge credit cards, ACH, Google/Apple Pay wallets along with other
      functions.
  - name: Addresses
    description: |-

      APIs for managing customer addresses
  - name: Customer management
    description: >-

      APIs for managing customers.  Depending on API KEY permissions, one should
      be able to

      list, create, update, and delete customers along with several other
      customer specific requests.
  - name: Deposit management
    description: ''
  - name: Invoice management
    description: >-

      APIs for managing invoices. Depending on API KEY permissions, one should
      be

      able to list, create, update, delete, and send invoices, manage their line

      items, and manage recurring-invoice schedules. Every request is scoped to
      a

      single Merchant via the required `data.sid`.
  - name: Payment Method management
    description: >-

      APIs for managing payment methods associated with customers.  Depending on
      API KEY permissions, one should be able to

      list, show, create, update, and delete payment methods.
  - name: Recurring Payments management
    description: >-

      APIs for managing recurring payments.  Depending on API KEY permissions,
      one should be able to

      create, edit, pause, cancel along with other functions.
  - name: Zapier
    description: >-

      APIs for use through Zapier.  Depending on API KEY permissions, one should
      be able to

      see customers and transactions data.
paths:
  /api/recurring-invoices:
    get:
      tags:
        - Invoice management
      summary: List Recurring Invoices
      description: |-
        Retrieves a paginated (cursor) list of recurring-invoice templates for a
        Merchant, optionally filtered by status.
      operationId: listRecurringInvoices
      parameters: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  description: ''
                  example: []
                  properties:
                    sid:
                      type: integer
                      description: The SID of the Merchant.
                      example: 12345
                  required:
                    - sid
                filters:
                  type: object
                  description: ''
                  example: []
                  properties:
                    status:
                      type: string
                      description: 'A status to filter by. One of: Active, Ended, Cancelled.'
                      example: Active
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - id: null
                      status: Active
                      recurrence_schedule: Monthly
                      payment_terms: net_15
                      start_date: '2026-07-22'
                      end_date: null
                      next_run_date: '2026-08-22'
                      last_run_date: null
                      customer_name: Lafayette Considine
                    - id: null
                      status: Active
                      recurrence_schedule: Monthly
                      payment_terms: net_15
                      start_date: '2026-07-22'
                      end_date: null
                      next_run_date: '2026-08-22'
                      last_run_date: null
                      customer_name: Margaretta Thiel
                  links:
                    prev: null
                    next: null
                  meta:
                    path: /
                    per_page: 500
                    next_cursor: null
                    prev_cursor: null
                properties:
                  data:
                    type: array
                    example:
                      - id: null
                        status: Active
                        recurrence_schedule: Monthly
                        payment_terms: net_15
                        start_date: '2026-07-22'
                        end_date: null
                        next_run_date: '2026-08-22'
                        last_run_date: null
                        customer_name: Lafayette Considine
                      - id: null
                        status: Active
                        recurrence_schedule: Monthly
                        payment_terms: net_15
                        start_date: '2026-07-22'
                        end_date: null
                        next_run_date: '2026-08-22'
                        last_run_date: null
                        customer_name: Margaretta Thiel
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: null
                          description: 'The template id. Example: 3'
                        status:
                          type: string
                          example: Active
                          description: 'The template status. Example: Active'
                        recurrence_schedule:
                          type: string
                          example: Monthly
                          description: 'The schedule. Example: Monthly'
                        payment_terms:
                          type: string
                          example: net_15
                          description: >-
                            The payment terms applied to generated invoices.
                            Example: net_15
                        start_date:
                          type: string
                          example: '2026-07-22'
                          description: 'The start date (Y-m-d). Example: 2026-07-01'
                        end_date:
                          type: string
                          example: null
                          description: >-
                            The optional end date (Y-m-d), or null. Example:
                            2027-07-01
                        next_run_date:
                          type: string
                          example: '2026-08-22'
                          description: >-
                            The next run date (Y-m-d), or null once ended.
                            Example: 2026-08-01
                        last_run_date:
                          type: string
                          example: null
                          description: >-
                            The most recent run date (Y-m-d), or null. Example:
                            2026-07-01
                        customer_name:
                          type: string
                          example: Lafayette Considine
                          description: 'The linked customer name. Example: Jane Doe'
                  links:
                    type: object
                    properties:
                      prev:
                        type: string
                        example: null
                        nullable: true
                      next:
                        type: string
                        example: null
                        nullable: true
                  meta:
                    type: object
                    properties:
                      path:
                        type: string
                        example: /
                      per_page:
                        type: integer
                        example: 500
                      next_cursor:
                        type: string
                        example: null
                        nullable: true
                      prev_cursor:
                        type: string
                        example: null
                        nullable: true
        '401':
          description: Token unauthorized
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    message: Permission Denied.
                properties:
                  data:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Permission Denied.
        '404':
          description: Invalid sid
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    message: No such Merchant
                properties:
                  data:
                    type: object
                    properties:
                      message:
                        type: string
                        example: No such Merchant
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: >-
        You can retrieve your token by visiting your dashboard and clicking
        <b>Generate API token under your profile in top right</b>.

````