> ## 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 upcoming payments > List all owned future scheduled/failed payments for the My Bill Pay Calendar page. The response is frontend-shaped and library-agnostic; clients can map `calendar_items` into FullCalendar or another calendar component without relying on backend `extendedProps`. ## OpenAPI ````yaml /api/consumer.openapi.yaml get /upcoming-payments 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: /upcoming-payments: get: tags: - Upcoming Payments summary: List upcoming payments description: >- List all owned future scheduled/failed payments for the My Bill Pay Calendar page. The response is frontend-shaped and library-agnostic; clients can map `calendar_items` into FullCalendar or another calendar component without relying on backend `extendedProps`. operationId: consumerListUpcomingPayments responses: '200': description: Upcoming payments returned. content: application/json: schema: $ref: '#/components/schemas/ConsumerUpcomingPaymentsResponse' '401': $ref: '#/components/responses/Unauthenticated' '409': $ref: '#/components/responses/ProfileIncomplete' security: - bearerAuth: [] components: schemas: ConsumerUpcomingPaymentsResponse: type: object required: - data - meta properties: data: $ref: '#/components/schemas/ConsumerUpcomingPayments' meta: $ref: '#/components/schemas/ConsumerUpcomingPaymentsMeta' ConsumerUpcomingPayments: type: object required: - payments - calendar_items properties: payments: type: array description: >- Future scheduled/failed payment rows for the Upcoming Payments table. Render only the first `meta.table_limit` rows in the table to match the reference app. items: $ref: '#/components/schemas/ConsumerUpcomingPayment' calendar_items: type: array description: >- Same underlying rows shaped for calendar rendering. The backend intentionally does not return FullCalendar `extendedProps`; map these keys into the frontend calendar library. items: $ref: '#/components/schemas/ConsumerUpcomingPaymentCalendarItem' ConsumerUpcomingPaymentsMeta: type: object required: - table_limit properties: table_limit: type: integer example: 5 description: >- Number of `payments` rows to render in the table. Calendar views can use all `calendar_items`. 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 ConsumerUpcomingPayment: type: object required: - id - consumer_id - bill_name - due_date - due_date_label - amount - amount_label - payment_method_label - is_on_hold - hold_label - restart_date - restart_label properties: id: type: integer example: 123 consumer_id: type: integer example: 109 bill_name: type: - string - 'null' example: Sem Karan due_date: type: - string - 'null' format: date example: '2026-07-10' due_date_label: type: - string - 'null' example: Jul 10, 2026 amount: type: - string - 'null' example: '125.00' amount_label: type: string example: $125.00 payment_method_label: type: - string - 'null' examples: - Card (xx-4242) - ACH (xx-6789) is_on_hold: type: boolean hold_label: type: - string - 'null' example: Consumer Hold restart_date: type: - string - 'null' format: date example: '2026-07-14' restart_label: type: - string - 'null' example: Restart on Jul 14, 2026 ConsumerUpcomingPaymentCalendarItem: type: object required: - id - consumer_id - title - date - amount_label - is_on_hold - hold_label - restart_label properties: id: type: integer example: 123 consumer_id: type: integer example: 109 title: type: - string - 'null' example: Sem Karan date: type: - string - 'null' format: date example: '2026-07-10' amount_label: type: string example: $125.00 is_on_hold: type: boolean hold_label: type: - string - 'null' example: Consumer Hold restart_label: type: - string - 'null' example: Restart on Jul 14, 2026 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' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Sanctum token ````