> ## 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 billing history

> List creditor billing history rows for membership hosting, consumer payment revenue share, profile communications, auto communications, member notifications, vault hosting, delivered ecoLetters, and over-limit accounts. This endpoint belongs to the creditor profile/billing menu and is available even when the active plan has expired so failed membership billing can be resolved.



## OpenAPI

````yaml /api/creditor.openapi.yaml get /billing-history
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:
  /billing-history:
    get:
      tags:
        - Account Profile
      summary: List billing history
      description: >-
        List creditor billing history rows for membership hosting, consumer
        payment revenue share, profile communications, auto communications,
        member notifications, vault hosting, delivered ecoLetters, and
        over-limit accounts. This endpoint belongs to the creditor
        profile/billing menu and is available even when the active plan has
        expired so failed membership billing can be resolved.
      operationId: creditorListBillingHistory
      parameters:
        - name: search
          in: query
          required: false
          description: Search invoice number, description, or payment status.
          schema:
            type: string
            maxLength: 255
        - name: sort
          in: query
          required: false
          description: Billing history sort field.
          schema:
            type: string
            default: payment-date
            enum:
              - payment-date
              - invoice-number
              - description
              - total-amount
              - payment-status
        - $ref: '#/components/parameters/SortDirection'
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: Billing history rows returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingHistoryListResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  parameters:
    SortDirection:
      name: direction
      in: query
      required: false
      description: Sort direction.
      schema:
        type: string
        default: desc
        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:
    BillingHistoryListResponse:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BillingHistoryRow'
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
    BillingHistoryRow:
      type: object
      required:
        - id
        - type
        - invoice_id
        - description
        - billing_category
        - payment_date
        - payment_date_label
        - total_amount
        - total_amount_label
        - payment_method
        - status
        - contact_billing
        - action_items
      properties:
        id:
          type: integer
          description: Source billing record ID.
        type:
          type: string
          enum:
            - membership
            - yn
            - over_limit
        invoice_id:
          type: string
          example: M123
        description:
          type: string
          example: Membership - Hosting
        description_tooltip:
          type: string
          nullable: true
          example: >-
            When a user sends an individual text or email from the consumer
            profile.
        billing_category:
          type: string
          enum:
            - membership_hosting
            - yn_consumer_payments
            - yn_profile_communications
            - yn_auto_communications
            - yn_creditor_notifications
            - yn_vault_hosting
            - yn_ecoletters
            - over_limit_add_on_accounts
        payment_date:
          type: string
          format: date-time
          nullable: true
        payment_date_label:
          type: string
          nullable: true
          example: Jun 01, 2026 10:00 AM
        total_amount:
          type: number
          format: float
          example: 30
        total_amount_label:
          type: string
          example: $30.00
        payment_method:
          $ref: '#/components/schemas/BillingHistoryPaymentMethod'
        status:
          $ref: '#/components/schemas/BillingHistoryStatus'
        contact_billing:
          $ref: '#/components/schemas/BillingHistoryContactBilling'
        action_items:
          type: array
          description: >-
            Filtered list of available row actions. Failed membership rows
            include `reprocess_payment`; successful rows do not.
          items:
            $ref: '#/components/schemas/BillingHistoryActionItem'
    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
    BillingHistoryPaymentMethod:
      type: object
      required:
        - label
      properties:
        label:
          type: string
          example: '*** *** *** 1111'
    BillingHistoryStatus:
      type: object
      required:
        - value
        - label
      properties:
        value:
          type: string
          enum:
            - success
            - failed
        label:
          type: string
          enum:
            - Paid
            - Failed
        failure_reason:
          type: string
          nullable: true
          example: Card declined.
    BillingHistoryContactBilling:
      type: object
      required:
        - email
        - subject
        - mailto
      properties:
        email:
          type: string
          format: email
          example: help@younegotiate.com
        subject:
          type: string
          example: 'Billing inquiry for invoice id: M123'
        mailto:
          type: string
          example: >-
            mailto:help@younegotiate.com?subject=Billing inquiry for invoice id:
            M123
    BillingHistoryActionItem:
      type: object
      required:
        - key
        - label
        - available
      properties:
        key:
          type: string
          enum:
            - open_invoice
            - reprocess_payment
            - contact_billing
        label:
          type: string
          example: Open
        available:
          type: boolean
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````