> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt
> Use this file to discover all available pages before exploring further.

# List invoice events

> Retrieve billable events for an invoice, with per-event pricing computed against the invoice's billing rules. Works for any invoice status: draft and open invoices compute pricing live, finalized invoices serve the snapshot taken at issuance. Per-event amounts are gross — discounts (coupons, percentage, fixed amount) are applied at the line-item or invoice level, not redistributed across events. Use the invoice endpoint to read `discount_amount` if you need the net.



## OpenAPI

````yaml get /v1/invoices/{id}/events
openapi: 3.1.0
info:
  title: Hyperline API
  version: 0.0.0
servers:
  - url: https://api.hyperline.co
  - url: https://sandbox.api.hyperline.co
security: []
paths:
  /v1/invoices/{id}/events:
    get:
      tags:
        - Invoices > Events
      summary: List invoice events
      description: >-
        Retrieve billable events for an invoice, with per-event pricing computed
        against the invoice's billing rules. Works for any invoice status: draft
        and open invoices compute pricing live, finalized invoices serve the
        snapshot taken at issuance. Per-event amounts are gross — discounts
        (coupons, percentage, fixed amount) are applied at the line-item or
        invoice level, not redistributed across events. Use the invoice endpoint
        to read `discount_amount` if you need the net.
      operationId: listInvoiceEvents
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
        - schema:
            type:
              - number
              - 'null'
            minimum: 0
            maximum: 100
            default: 50
          required: false
          name: take
          in: query
        - schema:
            type:
              - number
              - 'null'
            minimum: 0
            default: 0
          required: false
          name: skip
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
            description: Sort direction.
            example: desc
          required: false
          description: Sort direction.
          name: order
          in: query
        - schema:
            type: string
            enum:
              - timestamp
            description: Field used to sort the results.
          required: false
          description: Field used to sort the results.
          name: sort
          in: query
        - schema:
            type: string
          required: false
          name: product_id
          in: query
        - schema:
            type: string
          required: false
          name: product_id__not
          in: query
        - schema:
            type: string
          required: false
          name: product_id__isNull
          in: query
        - schema:
            type: string
          required: false
          name: product_id__isNotNull
          in: query
        - schema:
            type: string
          required: false
          name: product_id__equals
          in: query
        - schema:
            type: string
          required: false
          name: product_id__contains
          in: query
        - schema:
            type: string
          required: false
          name: product_id__startsWith
          in: query
        - schema:
            type: string
          required: false
          name: product_id__endWith
          in: query
        - schema:
            type: string
          required: false
          name: event_type
          in: query
        - schema:
            type: string
          required: false
          name: event_type__not
          in: query
        - schema:
            type: string
          required: false
          name: event_type__isNull
          in: query
        - schema:
            type: string
          required: false
          name: event_type__isNotNull
          in: query
        - schema:
            type: string
          required: false
          name: event_type__equals
          in: query
        - schema:
            type: string
          required: false
          name: event_type__contains
          in: query
        - schema:
            type: string
          required: false
          name: event_type__startsWith
          in: query
        - schema:
            type: string
          required: false
          name: event_type__endWith
          in: query
        - schema:
            type: string
            format: date-time
          required: false
          name: timestamp
          in: query
        - schema:
            type: string
            format: date-time
          required: false
          name: timestamp__not
          in: query
        - schema:
            type: string
            format: date-time
          required: false
          name: timestamp__isNull
          in: query
        - schema:
            type: string
            format: date-time
          required: false
          name: timestamp__isNotNull
          in: query
        - schema:
            type: string
            format: date-time
          required: false
          name: timestamp__equals
          in: query
        - schema:
            type: string
            format: date-time
          required: false
          name: timestamp__lt
          in: query
        - schema:
            type: string
            format: date-time
          required: false
          name: timestamp__lte
          in: query
        - schema:
            type: string
            format: date-time
          required: false
          name: timestamp__gt
          in: query
        - schema:
            type: string
            format: date-time
          required: false
          name: timestamp__gte
          in: query
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedInvoiceEvent'
        '404':
          description: Invoice not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
      security:
        - bearer: []
components:
  schemas:
    PaginatedInvoiceEvent:
      type: object
      properties:
        meta:
          type: object
          properties:
            total:
              type: number
              description: Total of existing items.
              example: 1
            taken:
              type: number
              description: Number of items returned.
              example: 1
            skipped:
              type: number
              description: Number of items skipped.
              example: 0
          required:
            - total
            - taken
            - skipped
        data:
          type: array
          items:
            $ref: '#/components/schemas/InvoiceEvent'
          description: List of InvoiceEvent.
      required:
        - meta
        - data
    InvoiceEvent:
      type: object
      properties:
        id:
          type: string
          description: Event record ID (unique identifier of the billable event).
          example: evt_01HW8R3K2N9YV5Z7TQXJ4M2GHD
        name:
          type:
            - string
            - 'null'
          description: >-
            Display name rendered from the product's event-name template. `null`
            when no template is configured.
          example: API call from europe-west1
        event_type:
          type: string
          description: Raw event type as ingested.
          example: api_call
        timestamp:
          type: string
          format: date-time
          description: Date the event occurred.
          example: '2024-10-20T14:32:11.000Z'
        properties:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: number
              - type: boolean
              - type: 'null'
              - type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
                    - type: boolean
                    - type: 'null'
                    - type: 'null'
              - type: 'null'
          description: Raw event properties as ingested.
          example:
            region: europe-west1
            endpoint: /v1/customers
        billing:
          $ref: '#/components/schemas/InvoiceEventBilling'
      required:
        - id
        - name
        - event_type
        - timestamp
        - properties
        - billing
    InvoiceEventBilling:
      type: object
      properties:
        invoice_id:
          type: string
          description: ID of the invoice the event is attached to.
          example: inv_1eTaiytfA0i2Va
        invoice_line_item_id:
          type:
            - string
            - 'null'
          description: >-
            ID of the invoice line item the event is attributed to. `null` for
            events not bound to a specific line item.
          example: ili_0FACNpeoEFkGu3
        product_id:
          type:
            - string
            - 'null'
          description: >-
            ID of the product the event is attributed to. `null` for events not
            bound to a specific product.
          example: itm_KbLcWt2qm5p1S2
        price_name:
          type:
            - string
            - 'null'
          description: >-
            Name of the price group (aggregator filter) the event was charged
            against. `null` if the product has a single price.
          example: null
        amount:
          type:
            - number
            - 'null'
          description: >-
            Amount billed for this event, including tax, in the invoice
            currency. Expressed in currency's smallest unit.
          example: 12
        amount_excluding_tax:
          type:
            - number
            - 'null'
          description: >-
            Amount billed for this event, excluding tax, in the invoice
            currency. Expressed in currency's smallest unit.
          example: 10
        currency:
          type: string
          enum:
            - EUR
            - AED
            - AFN
            - XCD
            - ALL
            - AMD
            - AOA
            - ARS
            - USD
            - AUD
            - AWG
            - AZN
            - BAM
            - BBD
            - BDT
            - BGN
            - BHD
            - BIF
            - XOF
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BTN
            - NOK
            - BWP
            - BYR
            - BZD
            - CAD
            - CDF
            - XAF
            - CHF
            - NZD
            - CLP
            - CNY
            - COP
            - CRC
            - CUP
            - CVE
            - ANG
            - CZK
            - DJF
            - DKK
            - DOP
            - DZD
            - EGP
            - MAD
            - ERN
            - ETB
            - FJD
            - FKP
            - GBP
            - GEL
            - GHS
            - GIP
            - GMD
            - GNF
            - GTQ
            - GYD
            - HKD
            - HNL
            - HRK
            - HTG
            - HUF
            - IDR
            - ILS
            - INR
            - IQD
            - IRR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KGS
            - KHR
            - KMF
            - KPW
            - KRW
            - KWD
            - KYD
            - KZT
            - LAK
            - LBP
            - LKR
            - LRD
            - LSL
            - LYD
            - MDL
            - MGA
            - MKD
            - MMK
            - MNT
            - MOP
            - MRO
            - MUR
            - MVR
            - MWK
            - MXN
            - MYR
            - MZN
            - NAD
            - XPF
            - NGN
            - NIO
            - NPR
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - PYG
            - QAR
            - RON
            - RSD
            - RUB
            - RWF
            - SAR
            - SBD
            - SCR
            - SDG
            - SEK
            - SGD
            - SHP
            - SLL
            - SOS
            - SRD
            - SSP
            - STD
            - SYP
            - SZL
            - THB
            - TJS
            - TMT
            - TND
            - TOP
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - UGX
            - UYU
            - UZS
            - VEF
            - VND
            - VUV
            - WST
            - YER
            - ZAR
            - ZMW
            - ZWL
          description: Currency of the invoice (and of the event amounts).
          example: EUR
      required:
        - invoice_id
        - invoice_line_item_id
        - product_id
        - price_name
        - amount
        - amount_excluding_tax
        - currency
      description: Billing attribution and pricing data for the event on this invoice.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````