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

# Skip Consumer Profile scheduled payment

> Skip the first eligible scheduled or failed payment from the Consumer Profiles detail Payment Plans tab. The account must belong to the authenticated creditor company and assigned sub-account when applicable. The selected payment must belong to the consumer, must not be today's payment, must be the first active scheduled row, and cannot be the last active scheduled row. The skipped payment is moved behind the last active scheduled row using the active payment-plan frequency.



## OpenAPI

````yaml /api/creditor.openapi.yaml post /manage-consumers/{consumer}/scheduled-transactions/{scheduleTransaction}/skip
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:
  /manage-consumers/{consumer}/scheduled-transactions/{scheduleTransaction}/skip:
    post:
      tags:
        - Consumer Profiles
      summary: Skip Consumer Profile scheduled payment
      description: >-
        Skip the first eligible scheduled or failed payment from the Consumer
        Profiles detail Payment Plans tab. The account must belong to the
        authenticated creditor company and assigned sub-account when applicable.
        The selected payment must belong to the consumer, must not be today's
        payment, must be the first active scheduled row, and cannot be the last
        active scheduled row. The skipped payment is moved behind the last
        active scheduled row using the active payment-plan frequency.
      operationId: creditorSkipManageConsumerScheduledTransaction
      parameters:
        - name: consumer
          in: path
          required: true
          description: Consumer account ID.
          schema:
            type: integer
        - name: scheduleTransaction
          in: path
          required: true
          description: Scheduled transaction ID that belongs to the consumer account.
          schema:
            type: integer
      responses:
        '200':
          description: Payment skipped and the updated scheduled transaction row returned.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SkipManageConsumerScheduledTransactionResponse
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/ActiveMembershipRequired'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: >-
            Account status, scheduled transaction status, date, or row position
            does not allow skipping this payment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    SkipManageConsumerScheduledTransactionResponse:
      type: object
      required:
        - message
        - data
      properties:
        message:
          type: string
          example: Payment skipped.
        data:
          $ref: '#/components/schemas/ManageConsumerScheduledTransaction'
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ManageConsumerScheduledTransaction:
      type: object
      additionalProperties: false
      required:
        - id
        - schedule_date
        - amount
        - payment_profile_label
        - frequency_label
        - previous_schedule_date
        - original_date_label
        - status
        - remaining_balance
        - actions
        - action_items
      properties:
        id:
          type: integer
        schedule_date:
          type: string
          format: date
        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
        original_date_label:
          type: string
          example: Apr 10, 2026
        status:
          type: object
          additionalProperties: false
          required:
            - value
            - label
          properties:
            value:
              type: string
              enum:
                - scheduled
                - failed
            label:
              type: string
              description: >-
                Uses `Consumer Hold` while the consumer account is on hold;
                otherwise the scheduled transaction status label.
              example: Scheduled
        remaining_balance:
          type: string
          description: >-
            Projected remaining balance after this scheduled row in
            schedule-date order.
          example: '110.00'
        actions:
          type: object
          additionalProperties: false
          required:
            - can_change_date
            - can_skip
          properties:
            can_change_date:
              type: boolean
            can_skip:
              type: boolean
        action_items:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - key
              - label
              - available
            properties:
              key:
                type: string
                enum:
                  - change_date
                  - skip
              label:
                type: string
              available:
                type: boolean
  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.
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````