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

# List order events

> Returns a paginated list of timeline events for an order (e.g. order created, order completed, order receipt sent, invoice paid), newest first. This includes every order tied to the same underlying subscription as the given order, not just that single order record.

<Info>Click the base URL in the API playground and select the **Sandbox** host for test data or the **Production** host for live data. Use credentials from the same environment.</Info>


## OpenAPI

````yaml /api-reference/openapi.json get /orders/{id}/events/
openapi: 3.0.0
info:
  title: kelviq API
  version: 1.0.0
  description: >-
    API for interacting with kelviq services, derived from Python SDK
    documentation.
servers:
  - url: https://sandboxapi.kelviq.com/api/v1
    description: Sandbox — Test payments
  - url: https://api.kelviq.com/api/v1
    description: Production — Live payments
security:
  - bearerAuth: []
tags:
  - name: Products
    description: Catalog products.
  - name: Product Settings
    description: Per-product settings (currency, VPN/Tor/proxy, product URL).
  - name: Product Files
    description: Product images and downloadable assets.
  - name: Features
    description: Catalog features that can be granted as plan entitlements.
  - name: Plans
    description: Catalog plans (CRUD, publish, versions, prices).
  - name: Plan Entitlements
    description: Feature entitlements attached to a plan.
  - name: Plan Files
    description: Files attached to plans, and signed download links.
  - name: Media
    description: Generate presigned S3 upload URLs for product/plan images and files.
  - name: Partner
    description: Partner integration APIs (organization provisioning, lookup).
  - name: Charges
    description: >-
      One-time payments charged immediately against a customer's default payment
      method.
  - name: Refunds
    description: Full and partial refunds for paid orders.
  - name: Transactions
    description: >-
      Charges, refunds, disputes, and other financial movements for the
      authenticated organization.
  - name: Payment Methods
    description: Saved customer payment methods (cards, etc.).
  - name: Orders
    description: Completed and resolved orders for the authenticated organization.
  - name: Order Events
    description: Timeline events for a specific order.
  - name: Webhooks
    description: Delivery logs for webhook events sent to your configured endpoints.
  - name: Checkout Sessions
    description: Merchant-side view of checkout sessions created by customers.
  - name: Checkout Session Events
    description: Timeline events for a specific checkout session.
paths:
  /orders/{id}/events/:
    get:
      tags:
        - Order Events
      summary: List order events
      description: >-
        Returns a paginated list of timeline events for an order (e.g. order
        created, order completed, order receipt sent, invoice paid), newest
        first. This includes every order tied to the same underlying
        subscription as the given order, not just that single order record.
      operationId: listOrderEvents
      parameters:
        - name: id
          in: path
          required: true
          description: The order ID.
          schema:
            type: string
          example: ORD-20260729103000-AB3K9
        - name: page_size
          in: query
          required: false
          description: Number of results per page. Defaults to 10, maximum 100.
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: page
          in: query
          required: false
          description: Page number to return.
          schema:
            type: integer
            minimum: 1
      responses:
        '200':
          description: A paginated list of order timeline events.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderEventListResponse'
        '401':
          description: Unauthorized — missing or invalid API key.
        '404':
          description: No order with that ID for the authenticated organization.
components:
  schemas:
    OrderEventListResponse:
      type: object
      properties:
        count:
          type: integer
          example: 1
        next:
          type: string
          format: uri
          nullable: true
          example: null
        previous:
          type: string
          format: uri
          nullable: true
          example: null
        results:
          type: array
          items:
            $ref: '#/components/schemas/OrderEventResponse'
    OrderEventResponse:
      type: object
      description: A single entry in an order's timeline.
      properties:
        id:
          type: integer
          example: 4821
        order:
          type: string
          description: The order ID this event belongs to.
          example: ORD-20260729103000-AB3K9
        title:
          type: string
          example: Order completed
        code:
          type: string
          description: Machine-readable event code.
          example: order.completed
        status:
          type: string
          enum:
            - pending
            - success
            - failed
          example: success
        timestamp:
          type: string
          format: date-time
          example: '2026-07-29T10:31:12Z'
        metadata:
          type: object
          description: >-
            Event-specific extra data (e.g. amounts, card details, failure
            reasons). Shape varies by `code`.
          additionalProperties: true
          example:
            primary: '+112.50'
            secondary: card ending 4242
      required:
        - id
        - order
        - title
        - code
        - status
        - timestamp
        - metadata
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The Server API Key obtained from the kelviq application. Pass as a
        Bearer token in the Authorization header. Example: 'Authorization:
        Bearer __YOUR_API_KEY__'

````