> ## 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 dashboard payment plans > List consumers on payment plans for the Creditor Portal Dashboard > Performance > Payment Plans page. Rows are scoped to the authenticated creditor company and assigned sub-account when applicable. The list includes installment payment-plan accounts only and ignores rolling dashboard window filters. ## OpenAPI ````yaml /api/creditor.openapi.yaml get /dashboard/performance/payment-plans openapi: 3.1.0 info: title: YouNegotiate Creditor API version: '2.0' description: >- Stateless API endpoints for creditor portal authentication and account access. servers: - url: https://api.creditor.younegotiate.com description: Production security: [] tags: - name: System description: Public creditor domain system and health endpoints. - name: Authentication description: Creditor registration, login, password, and email verification endpoints. - name: Account Settings description: >- Authenticated creditor profile, contact, operating-hours, and profile-image endpoints. - name: Account Profile description: >- Creditor onboarding profile, membership, billing, and setup status endpoints. - name: Setup Wizard description: >- Creditor setup wizard status, required-step completion, and optional-step completion. - name: Dashboard description: Creditor dashboard work queues and performance widgets. - name: Import / Export description: >- Creditor consumer import upload sessions, queued imports, history, downloads, and failed-row files. - name: Membership Settings description: >- Creditor membership dashboard, plan changes, payment method, cancellation, special-plan inquiry, and over-limit retry endpoints. - name: Merchant Account description: >- Existing merchant processor credentials, Tilled onboarding, and merchant application endpoints. - name: Header Profiles description: >- CSV header profile upload, mapping, download, and setup wizard completion endpoints. - name: SFTP Connections description: >- Creditor-managed SFTP connection profiles for imports, exports, and setup wizard completion. - name: Sub Accounts description: >- Creditor-managed sub account list, export, create, update, and delete endpoints. - name: Pay Terms Offers description: >- Creditor-managed master, sub-account, group, and group-sub-account Pay Terms endpoints. - name: Individual Custom Offers description: Creditor individual custom offer list endpoints. - name: Negotiations description: >- Creditor negotiation work queues, including notice responses and offer review counts. - name: Communications / CFPB Validation Letter description: >- CFPB Validation Letter tables, secure EcoLetter send/resend, CSV export, and print/download actions. - name: Communications / EcoLetter Template description: >- Creditor EcoLetter template management for secure eLetter communications and campaigns. - name: Communications / Groups description: >- Creditor communication group management for dynamic consumer targeting and campaign selection. - name: Communications / Schedule Campaign description: >- Creditor EcoLetter campaign scheduling, quote, immediate send, and delivery queue endpoints. - name: Communications / Campaign Tracker description: >- Creditor campaign tracker reporting, refresh, and consumer export endpoints. - name: Consumer Profiles description: Creditor Consumer Profiles list, filter options, and CSV export endpoints. - name: Terms & Conditions description: Creditor-managed master and sub-account Terms & Conditions templates. - name: About Us & Contact description: Creditor-managed company About Us content shown to consumers. - name: Logo & Links description: >- Creditor-managed master and sub-account personalized logo colors, size, and consumer link metadata. - name: Users description: >- Master creditor user management, invitations, and account deletion endpoints. paths: /dashboard/performance/payment-plans: get: tags: - Dashboard summary: List dashboard payment plans description: >- List consumers on payment plans for the Creditor Portal Dashboard > Performance > Payment Plans page. Rows are scoped to the authenticated creditor company and assigned sub-account when applicable. The list includes installment payment-plan accounts only and ignores rolling dashboard window filters. operationId: creditorListDashboardPaymentPlans parameters: - $ref: '#/components/parameters/PerformancePaymentPlanSearch' - $ref: '#/components/parameters/PerformancePaymentPlanSort' - $ref: '#/components/parameters/PerformancePaymentPlanDirection' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PerPage' responses: '200': description: Dashboard payment plan rows returned. content: application/json: schema: $ref: '#/components/schemas/PerformancePaymentPlanListResponse' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/ActiveMembershipRequired' '422': $ref: '#/components/responses/ValidationError' security: - bearerAuth: [] components: parameters: PerformancePaymentPlanSearch: name: search in: query required: false description: >- Search consumer full name, member account number, or original account number. schema: type: string maxLength: 255 PerformancePaymentPlanSort: name: sort in: query required: false description: Payment plans sort field. Defaults to `consumer_name` when omitted. schema: type: string default: consumer_name enum: - consumer_name - account_name - sub_account - placement_date - member_account_number - current_balance - profile_created_on PerformancePaymentPlanDirection: name: direction in: query required: false description: Sort direction. schema: type: string default: asc enum: - asc - desc Page: name: page in: query required: false description: Page number for paginated list responses. schema: type: integer minimum: 1 default: 1 PerPage: name: per_page in: query required: false description: Number of records per page. schema: type: integer minimum: 1 maximum: 100 default: 25 schemas: PerformancePaymentPlanListResponse: type: object additionalProperties: false required: - data - pagination properties: data: type: array items: $ref: '#/components/schemas/PerformancePaymentPlanRow' pagination: $ref: '#/components/schemas/PaginationMeta' PerformancePaymentPlanRow: type: object additionalProperties: false required: - id - consumer_name - account_name - subclient_name - placement_date - member_account_number - account_number - current_balance - payment_profile_created_on - status - payment_plan properties: id: type: integer description: Consumer account ID. consumer_name: type: string account_name: type: string nullable: true subclient_name: type: string nullable: true example: Master Portfolio placement_date: type: string format: date nullable: true member_account_number: type: string nullable: true account_number: type: string nullable: true current_balance: type: string pattern: ^-?\d+\.\d{2}$ example: '425.75' payment_profile_created_on: type: string format: date-time nullable: true status: type: object additionalProperties: false required: - value - label properties: value: type: string nullable: true example: payment_setup label: type: string nullable: true example: Pending Creditor Response payment_plan: anyOf: - $ref: '#/components/schemas/PerformancePaymentPlanSummary' - type: 'null' PaginationMeta: type: object additionalProperties: true properties: current_page: type: integer from: type: integer nullable: true last_page: type: integer path: type: string per_page: type: integer to: type: integer nullable: true total: type: integer 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 PerformancePaymentPlanSummary: type: object additionalProperties: false required: - term - approved_by - installments - monthly_amount - last_month_amount - completed_at - first_payment_date properties: term: type: object additionalProperties: false required: - value - label properties: value: type: string enum: - discounted_payment_plan - discounted_counter_payment_plan label: type: string enum: - Discounted Payment Plan - Discounted Counter Payment Plan approved_by: type: string description: >- `Auto Approve` for system-approved plans, or the consumer name for accepted counter plans. example: Auto Approve installments: type: integer nullable: true minimum: 0 example: 4 monthly_amount: type: string pattern: ^-?\d+\.\d{2}$ example: '50.25' last_month_amount: type: string nullable: true pattern: ^-?\d+\.\d{2}$ example: '10.50' completed_at: type: string format: date-time nullable: true first_payment_date: type: string format: date nullable: true responses: Unauthenticated: description: Missing or invalid bearer token. content: application/json: schema: $ref: '#/components/schemas/MessageResponse' ActiveMembershipRequired: description: Authenticated creditor does not have an active membership. content: application/json: schema: $ref: '#/components/schemas/MessageResponse' example: message: An active membership is required. ValidationError: description: Request validation failed. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Sanctum token ````