> ## 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.

# Show account schedule plan record

> Show one normalized schedule-plan record for an owned account. Use a `record_key` returned by `GET /accounts/{consumer}/payments`, such as `scheduled:12` or `transaction:44`.



## OpenAPI

````yaml /api/consumer.openapi.yaml get /accounts/{consumer}/payments/{payment}
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:
  /accounts/{consumer}/payments/{payment}:
    get:
      tags:
        - Accounts
      summary: Show account schedule plan record
      description: >-
        Show one normalized schedule-plan record for an owned account. Use a
        `record_key` returned by `GET /accounts/{consumer}/payments`, such as
        `scheduled:12` or `transaction:44`.
      operationId: consumerShowAccountPayment
      parameters:
        - $ref: '#/components/parameters/ConsumerAccountId'
        - $ref: '#/components/parameters/ConsumerPaymentRecordKey'
      responses:
        '200':
          description: Account schedule-plan record returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerAccountPaymentRecordResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ProfileIncomplete'
      security:
        - bearerAuth: []
components:
  parameters:
    ConsumerAccountId:
      name: consumer
      in: path
      required: true
      description: Consumer account ID.
      schema:
        type: integer
    ConsumerPaymentRecordKey:
      name: payment
      in: path
      required: true
      description: Payment record key returned by the payments list payload.
      schema:
        type: string
        pattern: ^(scheduled|transaction):\d+$
        examples:
          - scheduled:12
          - transaction:44
  schemas:
    ConsumerAccountPaymentRecordResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/ConsumerPaymentRecord'
    ConsumerPaymentRecord:
      oneOf:
        - $ref: '#/components/schemas/ConsumerPaymentScheduleRecord'
        - $ref: '#/components/schemas/ConsumerTransactionPayment'
    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
    ConsumerPaymentScheduleRecord:
      type: object
      required:
        - id
        - record_type
        - record_key
        - amount
        - status
      properties:
        id:
          type: integer
        record_type:
          type: string
          enum:
            - scheduled_payment
        record_key:
          type: string
          example: scheduled:12
        transaction_id:
          type:
            - integer
            - 'null'
        transaction_type:
          type:
            - string
            - 'null'
          enum:
            - pif
            - installment
            - partial_pif
            - null
        transaction_type_label:
          type:
            - string
            - 'null'
          example: Payment Plan
        schedule_date:
          type:
            - string
            - 'null'
          format: date
        previous_schedule_date:
          type:
            - string
            - 'null'
          format: date
        amount:
          type: string
          example: '125.00'
        status:
          $ref: '#/components/schemas/ConsumerPaymentStatus'
        is_first_schedule_row:
          type: boolean
          description: >-
            True when this record is the first row in the Schedule Plan table
            ordering.
          example: true
        is_next_scheduled_payment:
          type: boolean
          description: True when this record is the next row with `scheduled` status.
          example: true
        actions:
          $ref: '#/components/schemas/ConsumerSchedulePaymentActions'
        action_items:
          type: array
          description: Available row-level action labels for frontend menus/buttons.
          items:
            $ref: '#/components/schemas/ConsumerScheduleActionItem'
        status_code:
          type:
            - string
            - 'null'
        attempt_count:
          type: integer
        last_attempted_at:
          type:
            - string
            - 'null'
          format: date-time
        payment_profile:
          anyOf:
            - $ref: '#/components/schemas/ConsumerPaymentProfile'
            - type: 'null'
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
    ConsumerTransactionPayment:
      type: object
      required:
        - id
        - transaction_id
        - record_type
        - record_key
        - amount
        - status
      properties:
        id:
          type: integer
        transaction_id:
          type:
            - string
            - 'null'
          description: Gateway transaction identifier.
          example: gateway-payment-100
        record_type:
          type: string
          enum:
            - transaction_history
        record_key:
          type: string
          example: transaction:44
        schedule_transaction_id:
          type:
            - integer
            - 'null'
        schedule_date:
          type:
            - string
            - 'null'
          format: date
        transaction_type:
          type:
            - string
            - 'null'
          enum:
            - pif
            - installment
            - partial_pif
            - null
        transaction_type_label:
          type:
            - string
            - 'null'
          example: Settlement
        amount:
          type: string
          example: '250.00'
        status:
          $ref: '#/components/schemas/ConsumerPaymentStatus'
        payment_profile:
          anyOf:
            - $ref: '#/components/schemas/ConsumerPaymentProfile'
            - type: 'null'
        processed_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
    ConsumerPaymentStatus:
      type: object
      properties:
        value:
          type: string
          enum:
            - successful
            - failed
            - processing
            - scheduled
            - rescheduled
            - consumer_change_date
            - creditor_change_date
            - cancelled
        label:
          type: string
          example: Scheduled
    ConsumerSchedulePaymentActions:
      type: object
      properties:
        can_pay_now:
          type: boolean
        can_generate_helping_hand_link:
          type: boolean
        can_generate_helping_hand_qr_code:
          type: boolean
        can_partial_pay:
          type: boolean
        can_change_date:
          type: boolean
        can_skip:
          type: boolean
          description: >-
            True only for the first scheduled installment row in the Schedule
            Plan table ordering.
        can_reschedule_today:
          type: boolean
        can_request_settlement_date:
          type: boolean
    ConsumerScheduleActionItem:
      type: object
      required:
        - key
        - label
        - available
      properties:
        key:
          type: string
          example: pay_now
        label:
          type: string
          example: Pay Now
        available:
          type: boolean
          example: true
    ConsumerPaymentProfile:
      type: object
      properties:
        id:
          type: integer
        method:
          $ref: '#/components/schemas/ConsumerPaymentMethod'
        method_label:
          type:
            - string
            - 'null'
          example: Card
        label:
          type: string
          example: Card ending in 4242
        last_four_digit:
          type:
            - string
            - 'null'
        account_number_last_four:
          type:
            - string
            - 'null'
        expiration_month:
          type:
            - string
            - 'null'
        expiration_year:
          type:
            - string
            - 'null'
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        address:
          type:
            - string
            - 'null'
        city:
          type:
            - string
            - 'null'
        state:
          type:
            - string
            - 'null'
        zip:
          type:
            - string
            - 'null'
        is_saved_for_future_use:
          type: boolean
    ConsumerPaymentMethod:
      type:
        - string
        - 'null'
      enum:
        - cc
        - ach
        - null
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    Forbidden:
      description: Authenticated consumer cannot access the resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    NotFound:
      description: Resource not found.
      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'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````