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

# List recurring plans

> Recurring payment plans, a page at a time. `q` searches description, reference, PO, customer company, name, email and phone, note, MID, location and amount; `status` keeps one: PendingSetup, Active, Paused, Cancelled, Completed or Failed.



## OpenAPI

````yaml /api-reference/openapi.json get /recurring-plans
openapi: 3.1.1
info:
  title: Mojo Payments API
  description: >-
    Invoices, deposits, payments and locations for merchants; the merchant
    portfolio for reseller partners. Authenticate with an API key: exchange it
    at `POST /oauth/token` for a 10-minute access token, and send that as
    `Authorization: Bearer <token>`. Guides:
    https://kb.paymentsmojo.com/developers/overview
  version: '1'
servers:
  - url: https://api.paymentsmojo.com
security:
  - Bearer: []
tags:
  - name: Locations
  - name: Reseller portfolio
  - name: Invoice payments
  - name: Customers
  - name: Campaign pages
  - name: Authentication
  - name: Merchant accounts (MIDs)
  - name: Merchant applications
  - name: POS Gateway
  - name: Deposits
  - name: Card transactions
  - name: Recurring billing
  - name: Webhooks
paths:
  /recurring-plans:
    get:
      tags:
        - Recurring billing
      summary: List recurring plans
      description: >-
        Recurring payment plans, a page at a time. `q` searches description,
        reference, PO, customer company, name, email and phone, note, MID,
        location and amount; `status` keeps one: PendingSetup, Active, Paused,
        Cancelled, Completed or Failed.
      parameters:
        - name: q
          in: query
          schema:
            type: string
        - name: status
          in: query
          schema:
            type: string
        - name: page
          in: query
          description: The page, from 1. Default 1.
          schema:
            minimum: 1
            type: integer
            format: int32
        - name: pageSize
          in: query
          description: Items per page, up to 100. Default 25.
          schema:
            maximum: 100
            minimum: 1
            type: integer
            format: int32
        - name: sort
          in: query
          description: What to sort by. Default created.
          schema:
            enum:
              - created
              - amount
              - status
              - next
              - customer
              - description
            type: string
        - name: dir
          in: query
          description: Sort direction. Default desc for created, asc otherwise.
          schema:
            enum:
              - asc
              - desc
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedOfRecurringPlanView'
        '401':
          description: >-
            No access token, or it expired or its key was revoked. Get a new
            token.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: >-
            The key doesn't have the permission this needs, or the organization
            is suspended.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too many requests. Wait and try again.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    PagedOfRecurringPlanView:
      required:
        - items
        - page
        - pageSize
        - total
        - sort
        - dir
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/RecurringPlanView'
        page:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        pageSize:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        total:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        sort:
          type: string
        dir:
          type: string
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
          description: A short summary, e.g. "Check the request".
        status:
          type: integer
          format: int32
        detail:
          type: string
          description: What to change, in plain words.
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Field validation messages, by field (400 only).
      description: What went wrong (RFC 9457).
    RecurringPlanView:
      required:
        - id
        - merchantAccountId
        - mid
        - locationName
        - description
        - reference
        - poNumber
        - amount
        - frequency
        - startDate
        - totalPayments
        - paymentsMade
        - nextChargeDate
        - terms
        - status
        - customerName
        - customerCompany
        - customerEmail
        - customerPhone
        - delivery
        - sentVia
        - sentAt
        - sendProblem
        - memo
        - lines
        - cardLastFour
        - cardExpiry
        - authorizedAt
        - authorizedByName
        - failedAttempts
        - problem
        - pausedAt
        - pausedByName
        - cancelledAt
        - cancelledBy
        - cancelledByName
        - cancelReason
        - createdAt
        - createdByName
        - link
      type: object
      properties:
        id:
          type: string
          format: uuid
        merchantAccountId:
          type: string
          format: uuid
        mid:
          type: string
        locationName:
          type:
            - 'null'
            - string
        description:
          type: string
        reference:
          type:
            - 'null'
            - string
        poNumber:
          type:
            - 'null'
            - string
        amount:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        frequency:
          type: string
        startDate:
          type: string
          format: date
        totalPayments:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
        paymentsMade:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        nextChargeDate:
          type:
            - 'null'
            - string
          format: date
        terms:
          type: string
        status:
          type: string
        customerName:
          type:
            - 'null'
            - string
        customerCompany:
          type:
            - 'null'
            - string
        customerEmail:
          type: string
        customerPhone:
          type:
            - 'null'
            - string
        delivery:
          type: string
        sentVia:
          type:
            - 'null'
            - string
        sentAt:
          type:
            - 'null'
            - string
          format: date-time
        sendProblem:
          type:
            - 'null'
            - string
        memo:
          type:
            - 'null'
            - string
        lines:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        cardLastFour:
          type:
            - 'null'
            - string
        cardExpiry:
          type:
            - 'null'
            - string
        authorizedAt:
          type:
            - 'null'
            - string
          format: date-time
        authorizedByName:
          type:
            - 'null'
            - string
        failedAttempts:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        problem:
          type:
            - 'null'
            - string
        pausedAt:
          type:
            - 'null'
            - string
          format: date-time
        pausedByName:
          type:
            - 'null'
            - string
        cancelledAt:
          type:
            - 'null'
            - string
          format: date-time
        cancelledBy:
          type:
            - 'null'
            - string
        cancelledByName:
          type:
            - 'null'
            - string
        cancelReason:
          type:
            - 'null'
            - string
        createdAt:
          type: string
          format: date-time
        createdByName:
          type: string
        link:
          type:
            - 'null'
            - string
        lineItems:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/InvoiceLine'
        charges:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/RecurringChargeView'
    InvoiceLine:
      required:
        - description
        - quantity
        - unitCost
        - uom
        - commodityCode
        - upc
      type: object
      properties:
        description:
          type: string
        quantity:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        unitCost:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        uom:
          type:
            - 'null'
            - string
        commodityCode:
          type:
            - 'null'
            - string
        upc:
          type:
            - 'null'
            - string
    RecurringChargeView:
      required:
        - period
        - attempt
        - scheduledFor
        - amount
        - initiated
        - status
        - retRef
        - authCode
        - lastFour
        - message
        - level3Sent
        - attemptedAt
      type: object
      properties:
        period:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        attempt:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        scheduledFor:
          type: string
          format: date-time
        amount:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          format: double
        initiated:
          type: string
        status:
          type: string
        retRef:
          type:
            - 'null'
            - string
        authCode:
          type:
            - 'null'
            - string
        lastFour:
          type:
            - 'null'
            - string
        message:
          type:
            - 'null'
            - string
        level3Sent:
          type: boolean
        attemptedAt:
          type: string
          format: date-time
  securitySchemes:
    Bearer:
      type: http
      description: >-
        An access token from POST /oauth/token (your API key's id and secret).
        It lasts 10 minutes.
      scheme: bearer
      bearerFormat: JWT

````

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