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

# List consumer scheduled transactions

> Return read-only Payment Plans tab rows for the Superadmin consumer detail page. Superadmin receives the same scheduled/failed rows as the old detail page, with creditor-only row actions disabled.



## OpenAPI

````yaml /api/superadmin.openapi.yaml get /manage-consumers/{consumer}/scheduled-transactions
openapi: 3.1.0
info:
  title: YouNegotiate Superadmin API
  version: '2.0'
  description: Stateless API endpoints for the Superadmin portal.
servers:
  - url: https://api.hub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public superadmin domain system and health endpoints.
  - name: Authentication
    description: Superadmin login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated superadmin profile endpoints.
  - name: Admin Configuration
    description: Platform configuration values and feature flag controls.
  - name: MailHub Users
    description: Superadmin management for EcoMail Hub / EcoPortal users.
  - name: Super Admin Users
    description: Superadmin management for platform operations users.
  - name: Consumers
    description: Superadmin consumer account list, detail, filter, and export endpoints.
  - name: Creditors
    description: Superadmin creditor account list and account access endpoints.
  - name: Sub Accounts
    description: Superadmin sub account list and export endpoints.
  - name: Reseller Partners
    description: Superadmin reseller partner list and report-history endpoints.
  - name: Special Plan Inquiries
    description: >-
      Superadmin special membership inquiry list, detail, resolve, and close
      endpoints.
  - name: Plans
    description: >-
      Superadmin membership plan list, create, update, reorder, visibility, and
      delete endpoints.
  - name: Failed - Canceled
    description: Superadmin failed or cancelled membership list and custom email endpoints.
  - name: Merchant Requests
    description: >-
      Superadmin merchant API request list, export, email, forwarding, progress,
      and approval endpoints.
  - name: Bill Pay Donations
    description: Superadmin Bill Pay gift donation list, export, and receipt endpoints.
  - name: Export & Reporting
    description: Superadmin generated report options and CSV download endpoints.
  - name: Communications / Templates
    description: >-
      Superadmin email and SMS template management for manual communications and
      campaigns.
  - name: Communications / Groups
    description: >-
      Superadmin communication group management for dynamic consumer targeting
      and campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Superadmin email and SMS campaign scheduling, immediate send, and delivery
      queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Superadmin campaign tracker snapshots, refresh actions, and consumer
      exports.
  - name: Automated Communications
    description: >-
      Superadmin automated email/SMS templates, trigger configuration, and
      delivery history endpoints.
paths:
  /manage-consumers/{consumer}/scheduled-transactions:
    get:
      tags:
        - Consumers
      summary: List consumer scheduled transactions
      description: >-
        Return read-only Payment Plans tab rows for the Superadmin consumer
        detail page. Superadmin receives the same scheduled/failed rows as the
        old detail page, with creditor-only row actions disabled.
      operationId: superadminListConsumerScheduledTransactions
      parameters:
        - name: consumer
          in: path
          required: true
          description: Consumer ID.
          schema:
            type: integer
        - name: sort
          in: query
          required: false
          description: Sort field.
          schema:
            type: string
            enum:
              - schedule_date
              - amount
              - payment_profile
              - previous_schedule_date
              - remaining_balance
            default: schedule_date
        - name: direction
          in: query
          required: false
          description: Sort direction.
          schema:
            type: string
            enum:
              - asc
              - desc
            default: asc
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
      responses:
        '200':
          description: Scheduled transaction rows returned.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperadminConsumerScheduledTransactionListResponse
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    SuperadminConsumerScheduledTransactionListResponse:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SuperadminConsumerScheduledTransaction'
        pagination:
          $ref: '#/components/schemas/Pagination'
    SuperadminConsumerScheduledTransaction:
      type: object
      additionalProperties: false
      required:
        - id
        - schedule_date
        - schedule_time
        - amount
        - payment_profile_label
        - frequency_label
        - previous_schedule_date
        - original_date_label
        - status
        - remaining_balance
        - actions
        - action_items
      properties:
        id:
          type: integer
          example: 501
        schedule_date:
          type: string
          format: date
          nullable: true
          example: '2026-04-15'
        schedule_time:
          type: string
          nullable: true
          example: '12:00:00'
        amount:
          type: string
          example: '100.00'
        payment_profile_label:
          type: string
          example: CARD (xx-4242)
        frequency_label:
          type: string
          example: Monthly
        previous_schedule_date:
          type: string
          format: date
          nullable: true
          example: '2026-04-10'
        original_date_label:
          type: string
          example: Apr 10, 2026
        status:
          $ref: '#/components/schemas/SuperadminConsumerTransactionStatus'
        remaining_balance:
          type: string
          description: >-
            Projected remaining balance after this scheduled row in
            schedule-date order.
          example: '110.00'
        company:
          $ref: '#/components/schemas/CompanySummary'
        actions:
          type: object
          additionalProperties: false
          required:
            - can_change_date
            - can_skip
          properties:
            can_change_date:
              type: boolean
              description: >-
                Always false for Superadmin because old Superadmin detail is
                read-only for scheduled transaction row actions.
              example: false
            can_skip:
              type: boolean
              description: >-
                Always false for Superadmin because old Superadmin detail is
                read-only for scheduled transaction row actions.
              example: false
        action_items:
          type: array
          description: Always empty for Superadmin scheduled transaction rows.
          items:
            type: object
            additionalProperties: false
            required:
              - key
              - label
              - available
            properties:
              key:
                type: string
                enum:
                  - change_date
                  - skip
              label:
                type: string
              available:
                type: boolean
    Pagination:
      type: object
      required:
        - current_page
        - from
        - last_page
        - per_page
        - to
        - total
      properties:
        current_page:
          type: integer
          example: 1
        from:
          type: integer
          nullable: true
          example: 1
        last_page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 25
        to:
          type: integer
          nullable: true
          example: 10
        total:
          type: integer
          example: 10
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ValidationErrorResponse:
      type: object
      required:
        - message
        - errors
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    SuperadminConsumerTransactionStatus:
      type: object
      nullable: true
      additionalProperties: false
      required:
        - value
        - label
      properties:
        value:
          type: string
          enum:
            - successful
            - failed
            - processing
            - scheduled
            - rescheduled
            - consumer_change_date
            - creditor_change_date
            - cancelled
        label:
          type: string
          example: Failed
    CompanySummary:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        company_name:
          type: string
        deleted_at:
          type: string
          format: date-time
          nullable: true
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````