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

# List your payments

> Self-scoped.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/users/payments/
openapi: 3.0.3
info:
  title: Hi-Doctor API
  version: 1.0.0
  description: >-
    Patient-facing REST API for Hi-Doctor.


    Authenticate with email and password to receive a JWT pair, then send the
    access token as `Authorization: Bearer <token>` on every subsequent request.


    Only patient-accessible endpoints are documented here. Clinician and
    back-office endpoints are intentionally omitted.
  contact:
    name: Hi-Doctor
    email: hello@hi-doctor.ai
    url: https://hi-doctor.ai
servers:
  - url: https://api.hi-doctor.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Registration, email verification, sign-in and profile.
  - name: Questionnaires
    description: Complete a consultation questionnaire and submit it for medical review.
  - name: Consultations
    description: Consultations a doctor has reviewed or is reviewing.
  - name: Prescriptions
    description: Prescriptions and reissue requests.
  - name: Billing
    description: Checkout, subscription management and the Stripe billing portal.
  - name: Records
    description: Orders, invoices and side-effect reports.
  - name: Messages
    description: The patient's private thread with their medical team.
  - name: Progress
    description: Weight, injection and note tracking. Requires an active treatment plan.
  - name: Referrals
    description: Referral summary and transactions.
paths:
  /v1/users/payments/:
    get:
      tags:
        - Records
      summary: List your payments
      description: Self-scoped.
      operationId: users_payments_list
      parameters:
        - name: ordering
          required: false
          in: query
          description: Which field to use when ordering the results.
          schema:
            type: string
        - name: limit
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - name: offset
          required: false
          in: query
          description: The initial index from which to return the results.
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPaymentList'
              example:
                count: 1
                next: null
                previous: null
                results:
                  - id: 0a1b2c3d-4e5f-4a6b-8c9d-000000000004
                    consultation_id: 0a1b2c3d-4e5f-4a6b-8c9d-000000000002
                    patient_email: patient@example.com
                    patient_id: 0a1b2c3d-4e5f-4a6b-8c9d-000000000001
                    provider: stripe
                    provider_payment_id: pi_3QexampleExample
                    provider_checkout_id: cs_test_exampleExample
                    provider_order_id: null
                    provider_order_name: null
                    subscription_id: null
                    is_recurring: false
                    billing_reason: ''
                    amount_cents: 2500
                    refunded_amount_cents: 0
                    net_amount_cents: 2500
                    currency: EUR
                    status: succeeded
                    failure_code: ''
                    failed_at: null
                    description: Consultation payment
                    captured_at: '2026-08-02T06:46:49.811696Z'
                    invoice_url: >-
                      https://api.hi-doctor.ai/v1/users/payments/0a1b2c3d-4e5f-4a6b-8c9d-000000000004/invoice/
                    refund: null
                    created_at: '2026-08-02T11:43:49.813651Z'
                    updated_at: '2026-08-02T11:43:49.813653Z'
          description: ''
        '401':
          description: >-
            No bearer token, or a token that is expired or malformed.
            Re-authenticate; do not retry the same token.
          content:
            application/json:
              example:
                detail: Given token not valid for any token type
                code: token_not_valid
                messages:
                  - token_class: AccessToken
                    token_type: access
                    message: Token is invalid
      security:
        - jwtAuth: []
components:
  schemas:
    PaginatedPaymentList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/Payment'
    Payment:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        consultation_id:
          type: string
          format: uuid
          readOnly: true
        patient_email:
          type: string
          format: email
          readOnly: true
        patient_id:
          type: string
          format: uuid
          readOnly: true
        provider:
          $ref: '#/components/schemas/Provider906Enum'
        provider_payment_id:
          type: string
          nullable: true
          maxLength: 255
        provider_checkout_id:
          type: string
          nullable: true
          maxLength: 255
        provider_order_id:
          type: string
          nullable: true
          maxLength: 255
        provider_order_name:
          type: string
          nullable: true
          maxLength: 100
        subscription_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
        is_recurring:
          type: boolean
        billing_reason:
          type: string
          maxLength: 50
        amount_cents:
          type: integer
          maximum: 2147483647
          minimum: 0
        refunded_amount_cents:
          type: integer
          maximum: 2147483647
          minimum: 0
        net_amount_cents:
          type: integer
          readOnly: true
        currency:
          type: string
          maxLength: 3
        status:
          $ref: '#/components/schemas/PaymentStatusEnum'
        failure_code:
          type: string
          maxLength: 100
        failed_at:
          type: string
          format: date-time
          nullable: true
        description:
          type: string
          maxLength: 255
        captured_at:
          type: string
          format: date-time
          nullable: true
        invoice_url:
          type: string
          readOnly: true
        refund:
          allOf:
            - $ref: '#/components/schemas/PaymentRefund'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - consultation_id
        - created_at
        - id
        - invoice_url
        - net_amount_cents
        - patient_email
        - patient_id
        - provider
        - refund
        - subscription_id
        - updated_at
    Provider906Enum:
      enum:
        - shopify
        - stripe
      type: string
    PaymentStatusEnum:
      enum:
        - pending
        - succeeded
        - failed
        - partially_refunded
        - refunded
        - disputed
      type: string
    PaymentRefund:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        provider:
          $ref: '#/components/schemas/Provider906Enum'
        provider_refund_id:
          type: string
          nullable: true
          maxLength: 255
        amount_cents:
          type: integer
          maximum: 2147483647
          minimum: 0
        currency:
          type: string
          maxLength: 3
        status:
          $ref: '#/components/schemas/PaymentRefundStatusEnum'
        reason:
          type: string
        requested_by_email:
          type: string
          format: email
          readOnly: true
          nullable: true
        requested_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - created_at
        - id
        - provider
        - requested_by_email
        - updated_at
    PaymentRefundStatusEnum:
      enum:
        - pending
        - processing
        - succeeded
        - failed
        - canceled
      type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token from POST /v1/users/token/
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````