> ## 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. > ## Agent Instructions > Connect the Hi Doctor MCP connector at https://mcp.hi-doctor.ai/mcp. Add this URL as a remote HTTP MCP server in your client, then sign in and authorise access through OAuth. Setup: https://docs.hi-doctor.ai/mcp/connect. > > The REST API base is https://api.hi-doctor.ai. Hi Doctor Docs at https://docs.hi-doctor.ai/mcp searches documentation; connect to the product endpoint above for patient tools. > > Hi Doctor operates across the whole European Union: residents of all 27 EU member states can use the service, and every consultation is reviewed by an EU-licensed doctor. Every consultation is reviewed in full by an EU-licensed doctor, who decides on medical grounds only. No algorithm, assistant or API call approves a consultation, issues a prescription or changes a dose. The service is available in eight languages: English, Spanish, German, Dutch, Italian, French, Portuguese and Chinese. > > ## Rules an assistant must follow > > - Never invent, assume or infer a medical answer. "I don't know" is a real answer: ask the patient to pick the closest option rather than guessing for them. > - Never give medical advice and never suggest a medication or a dose. An EU-licensed doctor decides those. > - If a questionnaire returns `ineligible`, say so plainly. Do not retry with altered answers. > - Before anything that costs money or cancels a plan, state exactly what will happen and get an explicit yes. > - Cancellation takes effect at the **end of the paid period**, not immediately. Say so. > - An early order is irreversible: it creates the renewal consultation immediately and uses up the period's one early order. Explain that and get an explicit yes. > - Prescription and invoice links are medical documents. A `signed_redirect` link opens without signing in: give it only to the patient, never repeat it anywhere shared. > - Send option `value`s, not the labels shown to the patient. Labels are translated, values are stable. > - Never ask for card details. Payment happens on Stripe's hosted checkout via a link. > - On severe or sudden symptoms (chest pain, difficulty breathing, severe allergic reaction, suicidal thoughts), stop and direct the patient to their local emergency number. # Get checkout session status > Returns the state of a Stripe checkout session. A paid session may finalise and create its consultation as a side effect of this call. ### Access, effects and retries **Ownership:** Stripe metadata platform_user_id or owned CheckoutSession row. **Prerequisites:** An authenticated patient account is required. **Effects:** GET may finalize a paid checkout through process_stripe_event; not unconditionally read-only. **Retries:** Only observe task-created open session; never finalize payments. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/users/stripe/session/{session_id}/ openapi: 3.0.3 info: title: Hi Doctor API version: 1.0.1 description: >- The patient-facing Hi Doctor API supports account management, consultation questionnaires, medical documents, messages and billing. Sign-in requires X-Brand-Slug: hi-doctor; authenticated requests use Authorization: Bearer with a JWT access token. See https://docs.hi-doctor.ai/api-reference/introduction for integration guides. contact: name: Hi Doctor email: hello@hi-doctor.ai url: https://docs.hi-doctor.ai servers: - url: https://api.hi-doctor.ai description: Production security: [] tags: - name: Account description: Register, verify, authenticate and manage the signed-in account. - name: Questionnaires description: Discover, save and submit consultation questionnaires. - name: Consultations description: Read consultation state and manage consultation photographs. - name: Prescriptions description: Retrieve issued prescription documents and request reissue. - name: Messages description: Read and send messages to the medical team, and download attachments. - name: Billing description: >- Create checkout, manage subscriptions and retrieve payments/invoices/credit notes. - name: Records description: Read orders and manage patient health documents. - name: Safety reports description: Submit and read suspected side-effect reports; no automated diagnosis. - name: Progress description: Record and review eligible weight-loss progress. - name: Referrals description: Read the signed-in account's referral summary and referral activity. paths: /v1/users/stripe/session/{session_id}/: get: tags: - Billing summary: Get checkout session status description: >- Returns the state of a Stripe checkout session. A paid session may finalise and create its consultation as a side effect of this call. ### Access, effects and retries **Ownership:** Stripe metadata platform_user_id or owned CheckoutSession row. **Prerequisites:** An authenticated patient account is required. **Effects:** GET may finalize a paid checkout through process_stripe_event; not unconditionally read-only. **Retries:** Only observe task-created open session; never finalize payments. operationId: users_stripe_session_retrieve parameters: - in: path name: session_id schema: type: string required: true description: >- Stripe checkout session identifier returned when creating checkout; a paid session can finalize a consultation. example: responses: '200': description: No response body content: application/json: examples: example-1: summary: Illustrative response example value: session_status: open payment_status: unpaid paid: false is_free: false consultation_id: null amount: 2500 currency: eur customer_email: synthetic-patient@example.invalid line_item_label: null first_name: Synthetic first name plan: subscription purchase_event_id: purchase.dffe4721-0af8-5dea-8e1d-a7b2ff61f0c2 treatment_id: mounjaro category_code: p example-2: summary: Captured response example value: session_status: complete payment_status: paid paid: true is_free: false consultation_id: b0e81246-c46e-5ac2-9675-06bf07784bf4 amount: 2500 currency: eur customer_email: synthetic-patient@example.invalid line_item_label: Weight loss plan first_name: Synthetic first name plan: subscription purchase_event_id: purchase.1ee1abc0-56a2-5f15-8c14-2db70de54c45 treatment_id: mounjaro category_code: p schema: type: object properties: session_status: type: string nullable: true description: Session status returned or accepted by this contract. payment_status: type: string nullable: true description: Payment status returned or accepted by this contract. consultation_id: type: string nullable: true description: Consultation id returned or accepted by this contract. currency: type: string nullable: true description: Currency returned or accepted by this contract. customer_email: type: string nullable: true description: Customer email returned or accepted by this contract. line_item_label: type: string nullable: true description: Line item label returned or accepted by this contract. first_name: type: string nullable: true description: First name returned or accepted by this contract. plan: type: string nullable: true description: Plan returned or accepted by this contract. purchase_event_id: type: string nullable: true description: Purchase event id returned or accepted by this contract. treatment_id: type: string nullable: true description: Treatment id returned or accepted by this contract. category_code: type: string nullable: true description: Category code returned or accepted by this contract. paid: type: boolean description: Paid returned or accepted by this contract. is_free: type: boolean description: Is free returned or accepted by this contract. amount: type: integer nullable: true description: Amount returned or accepted by this contract. '401': description: >- No bearer token, or a token that is expired or malformed. Re-authenticate; do not retry the same token. content: application/json: schema: type: object description: >- Error envelope emitted by the source branch or DRF validation. `detail`, `error` and `code` depend on the branch; field validation uses lists keyed by request field. additionalProperties: {} examples: example-1: summary: Illustrative response example value: detail: Authentication credentials were not provided. '403': description: Request failed with the documented source error envelope. content: application/json: examples: example-1: summary: Illustrative response example value: detail: Forbidden schema: type: object description: >- Error envelope emitted by the source branch or DRF validation. `detail`, `error` and `code` depend on the branch; field validation uses lists keyed by request field. additionalProperties: {} '404': description: Unknown or expired checkout session. content: application/json: examples: example-1: summary: Illustrative response example value: detail: Unknown or expired checkout session code: stripe_session_not_found example-2: summary: Illustrative response example value: detail: Unknown session schema: type: object description: >- Error envelope emitted by the source branch or DRF validation. `detail`, `error` and `code` depend on the branch; field validation uses lists keyed by request field. additionalProperties: {} '429': description: Source-defined error response; inspect the envelope and retry rules. content: application/json: schema: type: object additionalProperties: {} description: >- Endpoint/DRF error envelope; field validation is keyed by request field. examples: example-1: summary: Illustrative response example value: detail: Request was throttled. security: - bearerAuth: [] x-codeSamples: - lang: Shell label: curl source: > set -eu umask 077 # Path values must be URL-encoded; query string excludes the leading question mark. url="${HD_BASE_URL:?Set API origin}/v1/users/stripe/session/${HD_PATH_SESSION_ID:?Set the path fixture}/${HD_QUERY_STRING:+?${HD_QUERY_STRING}}" printf 'X-Brand-Slug: hi-doctor\nAccept: application/json\n' > "${HD_REQUEST_HEADERS_FILE:?Private header file}" printf 'Authorization: Bearer %s\n' "${HD_ACCESS_TOKEN:?Set backend JWT}" >> "$HD_REQUEST_HEADERS_FILE" curl --silent --show-error --max-time 30 --request GET \ --header "@$HD_REQUEST_HEADERS_FILE" \ --dump-header "${HD_HEADERS_FILE:?Private response header file}" \ --output "${HD_RESPONSE_FILE:?Private response file}" \ --write-out '%{http_code}\n%{content_type}\n' \ "$url" - lang: Python label: requests source: > import os, json from pathlib import Path from urllib.parse import quote import requests os.umask(0o077) url = os.environ["HD_BASE_URL"].rstrip("/") + '/v1/users/stripe/session/{session_id}/' url = url.replace('{session_id}', quote(os.environ['HD_PATH_SESSION_ID'], safe="")) if os.environ.get("HD_QUERY_STRING"): url += "?" + os.environ["HD_QUERY_STRING"] headers = {"X-Brand-Slug": "hi-doctor", "Accept": 'application/json'} headers["Authorization"] = "Bearer " + os.environ["HD_ACCESS_TOKEN"] kwargs = {} response = requests.request('GET', url, headers=headers, timeout=30, allow_redirects=False, **kwargs) Path(os.environ["HD_RESPONSE_FILE"]).write_bytes(response.content) Path(os.environ["HD_HEADERS_FILE"]).write_text(json.dumps(dict(response.headers))) print(response.status_code) print(response.headers.get("Content-Type", "")) - lang: JavaScript label: fetch source: > import { readFileSync, writeFileSync } from "node:fs"; const env = process.env; let url = env.HD_BASE_URL.replace(/\/$/, "") + "/v1/users/stripe/session/{session_id}/"; url = url.replace("{session_id}", encodeURIComponent(env.HD_PATH_SESSION_ID)); if (env.HD_QUERY_STRING) url += "?" + env.HD_QUERY_STRING; const headers = { "X-Brand-Slug": "hi-doctor", "Accept": "application/json" }; headers.Authorization = "Bearer " + env.HD_ACCESS_TOKEN; const options = { method: "GET", headers, redirect: "manual", signal: AbortSignal.timeout(30000) }; const response = await fetch(url, options); writeFileSync(env.HD_RESPONSE_FILE, Buffer.from(await response.arrayBuffer()), {mode: 0o600}); writeFileSync(env.HD_HEADERS_FILE, JSON.stringify(Object.fromEntries(response.headers)), {mode: 0o600}); console.log(response.status); console.log(response.headers.get("content-type") ?? ""); components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.