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

# List Payments

> List payments received by the org (most recent first).

Scoped directly by `organization_id`. Filter by student, tutor, status, or
date range.



## OpenAPI

````yaml /openapi.json get /v1/payments
openapi: 3.1.0
info:
  title: EquateIt Public API
  description: >-
    REST API for EquateIt tutoring organisations. Pipe your sessions, invoices,
    payments, tutor earnings, students, and more into your own tools. Most
    endpoints are reads; a focused set of writes (each gated by a *:write scope)
    create or update data, including creating student/tutor/parent accounts.


    Authenticate every request with an org API key:

        Authorization: Token token=ei_live_...

    Mint keys in the EquateIt app under Settings → Developers.
  version: 1.0.0
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: General
  - name: Sessions
  - name: Tutors
  - name: Students & Parents
  - name: Billing
  - name: Curriculum
  - name: Coursework
  - name: Operations
  - name: Pricing
  - name: Bookings
  - name: Blog
  - name: Reports
paths:
  /v1/payments:
    get:
      tags:
        - Billing
      summary: List Payments
      description: >-
        List payments received by the org (most recent first).


        Scoped directly by `organization_id`. Filter by student, tutor, status,
        or

        date range.
      operationId: list_payments_v1_payments_get
      parameters:
        - name: student_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by student UUID
            title: Student Id
          description: Filter by student UUID
        - name: tutor_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by tutor UUID
            title: Tutor Id
          description: Filter by tutor UUID
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: succeeded, pending, refunded, failed, ...
            title: Status
          description: succeeded, pending, refunded, failed, ...
        - name: from
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: created_at >= ISO date
            title: From
          description: created_at >= ISO date
        - name: to
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: created_at <= ISO date
            title: To
          description: created_at <= ISO date
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Records per page (default 20, max 100)
            default: 20
            title: Limit
          description: Records per page (default 20, max 100)
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: Pagination offset
            default: 0
            title: Offset
          description: Pagination offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_Payment_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Page_Payment_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Payment'
          type: array
          title: Data
        meta:
          $ref: '#/components/schemas/PageMeta'
      type: object
      required:
        - data
        - meta
      title: Page[Payment]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Payment:
      properties:
        id:
          type: string
          title: Id
        session_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Session Id
        student_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Student Id
        tutor_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Tutor Id
        amount_cents:
          anyOf:
            - type: integer
            - type: 'null'
          title: Amount Cents
        refund_amount_cents:
          anyOf:
            - type: integer
            - type: 'null'
          title: Refund Amount Cents
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        payment_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Payment Type
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        stripe_payment_intent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Stripe Payment Intent Id
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
      type: object
      required:
        - id
      title: Payment
    PageMeta:
      properties:
        limit:
          type: integer
          title: Limit
        offset:
          type: integer
          title: Offset
        count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Count
        total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total
      type: object
      required:
        - limit
        - offset
      title: PageMeta
      description: |-
        Pagination envelope metadata. `count` is the size of the returned page;
        `total` (when present) is the full result-set size for offset paging.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=ei_live_...`

````