> ## 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 cancelled plan agreements

> List stored cancelled payment-plan agreement PDFs for the authenticated consumer profile. Rows are created when an active installment plan with at least one successful transaction is cancelled.



## OpenAPI

````yaml /api/consumer.openapi.yaml get /cancelled-plan-agreements
openapi: 3.1.0
info:
  title: YouNegotiate Consumer API
  version: '2.0'
  description: >-
    Stateless API endpoints for consumer portal authentication and account
    access.
servers:
  - url: https://api.consumer.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public consumer domain system and health endpoints.
  - name: Authentication
    description: >-
      Consumer identity matching, contact capture, OTP verification, token
      creation, and logout endpoints.
  - name: Profile - My ecoAddress
    description: Consumer profile tab for signed-in identity / ecoAddress context.
  - name: Profile - Communication Controls
    description: >-
      Consumer profile tab for communication permissions, email/mobile changes,
      and email/mobile verification.
  - name: Profile - My Billing Details
    description: >-
      Consumer profile tab for billing name and billing address details used for
      payment verification.
  - name: Profile - Personalize My Portal
    description: Consumer profile tab for portal colors and profile image personalization.
  - name: Accounts
    description: Consumer-owned account list and account detail endpoints.
  - name: Bill Pay Wallet
    description: >-
      Consumer Bill Pay Wallet saved payment profiles and scheduled payment
      method update endpoints.
  - name: Upcoming Payments
    description: >-
      Consumer My Bill Pay Calendar upcoming-payment rows and calendar display
      data.
  - name: Calendar Sync
    description: >-
      Consumer Google and Microsoft calendar connection, OAuth callback, and
      live-update endpoints.
  - name: Gift Registry
    description: >-
      Consumer Bill Pay Gift Registry account list, shared registry, and Helping
      Hand link endpoints.
  - name: EcoMailbox
    description: Consumer MyEcoMailBox list endpoints and unread sidebar badge state.
  - name: Notice Responses
    description: >-
      Consumer My Account notice-response wizard endpoints for sender details
      and account details.
paths:
  /cancelled-plan-agreements:
    get:
      tags:
        - Accounts
      summary: List cancelled plan agreements
      description: >-
        List stored cancelled payment-plan agreement PDFs for the authenticated
        consumer profile. Rows are created when an active installment plan with
        at least one successful transaction is cancelled.
      operationId: consumerListCancelledPlanAgreements
      parameters:
        - name: search
          in: query
          required: false
          description: Search by account name or member/payee company name.
          schema:
            type: string
            maxLength: 255
        - name: sort
          in: query
          required: false
          description: Sort column.
          schema:
            type: string
            enum:
              - date
              - account_name
              - company_name
            default: date
        - name: direction
          in: query
          required: false
          description: Sort direction.
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - 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: 10
      responses:
        '200':
          description: Cancelled plan agreements returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelledPlanAgreementListResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '409':
          $ref: '#/components/responses/ProfileIncomplete'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    CancelledPlanAgreementListResponse:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CancelledPlanAgreement'
        pagination:
          $ref: '#/components/schemas/Pagination'
    CancelledPlanAgreement:
      type: object
      required:
        - id
        - date
        - created_at
        - consumer
        - company
        - file
        - actions
      properties:
        id:
          type: integer
          example: 12
        date:
          type:
            - string
            - 'null'
          format: date
          example: '2026-07-02'
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        consumer:
          type: object
          required:
            - id
            - original_account_name
            - account_number
          properties:
            id:
              type:
                - integer
                - 'null'
            original_account_name:
              type:
                - string
                - 'null'
              example: Visa Account
            account_number:
              type:
                - string
                - 'null'
              example: ACC-100
        company:
          type: object
          required:
            - id
            - company_name
          properties:
            id:
              type:
                - integer
                - 'null'
            company_name:
              type:
                - string
                - 'null'
              example: Acme Agency
        file:
          type: object
          required:
            - name
            - exists
          properties:
            name:
              type: string
              example: ACC-100_you_negotiate_agreement.pdf
            exists:
              type: boolean
              description: >-
                False when the historical row exists but the PDF file is missing
                from storage.
        actions:
          type: object
          required:
            - can_view
            - can_download
          properties:
            can_view:
              type: boolean
              description: >-
                True when the stored PDF file exists and can be opened with
                `disposition=inline`.
            can_download:
              type: boolean
              description: True when the stored PDF file exists and can be downloaded.
    Pagination:
      type: object
      required:
        - current_page
        - from
        - last_page
        - per_page
        - to
        - total
      properties:
        current_page:
          type: integer
        from:
          type:
            - integer
            - 'null'
        last_page:
          type: integer
        per_page:
          type: integer
        to:
          type:
            - integer
            - 'null'
        total:
          type: integer
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ProfileIncompleteResponse:
      type: object
      required:
        - code
        - message
        - required_steps
      properties:
        code:
          type: string
          example: profile_incomplete
        message:
          type: string
          example: Please complete your communication profile before viewing accounts.
        required_steps:
          type: array
          items:
            type: string
          example:
            - profile_communication
    ValidationErrorResponse:
      type: object
      required:
        - message
        - errors
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ProfileIncomplete:
      description: >-
        The authenticated consumer profile must complete communication setup
        before My Account can be shown.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProfileIncompleteResponse'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````