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

# Get a checkout session

> Whether the link was acted on: `orderId` names the order the buyer placed from it, null until they do. A session outside your business unit answers 404.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/events/{eventId}/checkout-sessions/{checkoutSessionId}
openapi: 3.1.0
info:
  title: orriven Developer API
  version: '2026-08-22'
  description: >-
    Workspace-scoped access to events, ticket types, registrations (each
    carrying its hosted pass link), redemption codes, add-ons, bundles, orders
    and checkout sessions (the hosted checkout handoff), check-ins and
    exhibitors (read-only). Authenticate every request with `Authorization:
    Bearer <secret>`; the key's business unit is the entire scope, and a
    resource outside it answers 404, never 403.


    **Versioning** — the API uses date versions (this spec documents
    `2026-08-22`, the current one). A key is pinned to the version current at
    its creation and keeps that behaviour forever; send an `orriven-version:
    YYYY-MM-DD` header to serve a single request in another version (unknown
    dates answer 400). Every response echoes the effective version in the
    `orriven-version` response header.
servers:
  - url: https://openapi.orriven.com
    description: Production
  - url: http://localhost:3002
    description: Local development
security:
  - bearerAuth: []
paths:
  /v1/events/{eventId}/checkout-sessions/{checkoutSessionId}:
    get:
      tags:
        - Orders
      summary: Get a checkout session
      description: >-
        Whether the link was acted on: `orderId` names the order the buyer
        placed from it, null until they do. A session outside your business unit
        answers 404.
      parameters:
        - schema:
            type: string
          required: true
          name: eventId
          in: path
        - schema:
            type: string
          required: true
          name: checkoutSessionId
          in: path
      responses:
        '200':
          description: The session.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CheckoutSession'
                  - type: object
                    properties:
                      orderId:
                        type:
                          - string
                          - 'null'
                    required:
                      - orderId
        '401':
          description: >-
            Missing, unknown, revoked or expired API key — all indistinguishable
            on purpose.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RpcStatus'
        '404':
          description: >-
            The resource does not exist in this key's business unit. A foreign
            id answers the same way.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RpcStatus'
        '429':
          description: Rate limit exceeded for this API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RpcStatus'
components:
  schemas:
    CheckoutSession:
      type: object
      properties:
        id:
          type: string
        url:
          type: string
        expiresAt:
          type: string
      required:
        - id
        - url
        - expiresAt
    RpcStatus:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
              example: 404
            status:
              type: string
              example: NOT_FOUND
            message:
              type: string
              example: Event not found.
            details:
              type: array
              items: {}
          required:
            - code
            - status
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The API key's secret (`osk_…`), shown once when the key is created in
        the console.

````