# Partners API Documentation - [OpenLoop Partners API](https://openloop.mintlify.app/index.md): The clinical backend for consumer health. One API that carries a patient from your checkout through licensed clinical review, fulfillment, and every refill after. - [Quickstart](https://openloop.mintlify.app/quickstart.md): Exchange client credentials for a bearer token, verify the connection, and create your first patient. - [FAQ](https://openloop.mintlify.app/faq.md): Whether the integration is event-driven today, how the token exchange works, what the happy path is, which programs are live, and why there are no SDKs yet. - [Start here](https://openloop.mintlify.app/cookbook/index.md): Start here: the seven build stages in order, the five calls that prove your tenant is provisioned, and what to read before writing code. - [Getting started](https://openloop.mintlify.app/cookbook/getting-started.md): Get a bearer token from POST /v0.1/auth/token on staging, use the fixed audience, and reach your first resource endpoint. - [Integration flow](https://openloop.mintlify.app/cookbook/integration-flow.md): Intake end to end: create the patient, fetch the questionnaire, submit answers keyed by link_id, and store the encounter id the submit returns. - [Questionnaire workflow — who defines what](https://openloop.mintlify.app/cookbook/questionnaire-workflow.md): Who owns intake content: fetch the definition, render by link_id, and return answers — single, multi-select or free text — as given. - [Programs and identifiers](https://openloop.mintlify.app/cookbook/programs-and-identifiers.md): How a program is identified in the catalogue, how to verify which programs, forms, products and prices your tenant has, and how to hold the ids. - [Payments and checkout](https://openloop.mintlify.app/cookbook/payments-and-checkout.md): Create a checkout session with provider_price_id, match type to the price interval, and understand what payment does and does not trigger on the platform side. - [Order status and tracking](https://openloop.mintlify.app/cookbook/order-status-and-tracking.md): Receive the signed prescription webhook events, render order status and tracking from them, and match each event to your patient without an order read. - [Prescription events](https://openloop.mintlify.app/cookbook/prescription-events.md): Reference for the four prescription lifecycle events, with a pointer to the four billing events: the signed envelope, the data payload, the status enum and the timestamps behind status and tracking. - [Encounter notes](https://openloop.mintlify.app/cookbook/encounter-notes.md): Get the clinician's encounter note for an intake: keep the encounter id, add the charting events, and read the note by encounter from the response list. - [Appointments and scheduling](https://openloop.mintlify.app/cookbook/appointments-and-scheduling.md): What can be booked, when it is available, how to book and change a visit, and how appointments relate to intake and orders. - [Refills](https://openloop.mintlify.app/cookbook/refills.md): Find the refill questionnaire, submit it, follow the approved refill through the prescription webhook events, and handle the commercial side of a refill. - [Upsell and cross-sell](https://openloop.mintlify.app/cookbook/upsell-and-cross-sell.md): Cross-sell at checkout, upgrade a subscription with PUT /v0.1/subscriptions, and retain with pauses, billing portals and coupons. - [Lab ordering](https://openloop.mintlify.app/cookbook/lab-ordering.md): Order lab tests for a patient with POST /v0.1/laboratories: patient fields, test ids, retries, errors and current gaps. - [Payment failure](https://openloop.mintlify.app/cookbook/payment-failure.md): Abandoned checkout, declined card, declined prorated upgrade, or a declined off-session charge (a 400): what to read, and what to tell the patient. - [Not eligible](https://openloop.mintlify.app/cookbook/not-eligible.md): How a clinician's decision surfaces today when a patient is not eligible, why no prescription event arrives, and how to message the patient without guessing. - [Cancel, pause and refund](https://openloop.mintlify.app/cookbook/cancel-pause-refund.md): Cancel now or at period end, pause for N cycles and resume, refund an invoice — which call does what to the subscription and the order. - [Order exceptions](https://openloop.mintlify.app/cookbook/order-exceptions.md): Act on the prescription event that means trouble, prescription.cancelled, and on the order that has simply stopped sending events. - [Retries and idempotency](https://openloop.mintlify.app/cookbook/retries-and-idempotency.md): Which calls are safe to retry, how an email read avoids duplicate patients you cannot delete, and why a repeated subscription update adds a line. - [Errors](https://openloop.mintlify.app/cookbook/errors.md): The error envelope and request_id, what 400 to 404 and 5xx mean per endpoint family, the response envelopes you will meet, and what to log. - [API status at a glance](https://openloop.mintlify.app/cookbook/api-status.md): Which /v0.1 endpoints work as documented, which differ, and how order status arrives as webhook events, checked against staging. - [Assumptions, checked](https://openloop.mintlify.app/cookbook/assumptions-checked.md): Assumptions integrators arrive with, each confirmed or corrected against the live API, so you do not build on the wrong one. - [FAQ and troubleshooting](https://openloop.mintlify.app/cookbook/faq.md): Errors and surprises integrators hit first — auth, empty collections, validation, hosts — with the cause and the fix for each. - [Known gaps and staging setup](https://openloop.mintlify.app/cookbook/known-gaps-and-staging.md): What is not available yet, what your staging tenant should contain, and how to tell "not seeded yet" from "broken" before you build. - [User migration](https://openloop.mintlify.app/cookbook/user-migration.md): Migrating patients and removing a wrongly created one are requested from OpenLoop; you can still correct a record and re-submit. - [API Overview](https://openloop.mintlify.app/api-reference/introduction.md): One API for the full patient journey, from checkout through clinical review, fulfillment, and every refill after. - [Data Standards](https://openloop.mintlify.app/api-reference/data-standards.md): Formatting and validation standards for the OpenLoop Health Partners API - [Best Practices](https://openloop.mintlify.app/best-practices.md): Rate limits, retry with exponential backoff, the error envelope and its status codes, credential handling, and the tests to write before you go live. - [Product & Price IDs](https://openloop.mintlify.app/api-reference/product-and-price-ids.md): Canonical vs. provider IDs for Products and Prices, and how to chain them together - [Scheduling](https://openloop.mintlify.app/api-reference/scheduling-guide.md): Search provider availability, reserve a slot, book an appointment, and manage its lifecycle. - [Eligibility](https://openloop.mintlify.app/api-reference/eligibility-guide.md): Find the payer id to send, verify coverage, discover coverage you do not know about, coordinate benefits across payers, resolve a Medicare identifier, and check network status. - [User Registration](https://openloop.mintlify.app/api-reference/user-registration-guide.md): The order of calls that takes a patient from no identity to holding their own access and refresh tokens. - [How orders are created](https://openloop.mintlify.app/orders/order-model.md): The order lifecycle for partners: payment and clinical review create the order; its status reaches you as prescription webhook events, not as a read. - [Events](https://openloop.mintlify.app/events.md): The signed webhook contract for clinical, lab, document, scheduling, prescription and billing state changes. One envelope, one signature scheme, one delivery policy across every event. - [Obtain a service token](https://openloop.mintlify.app/auth/obtain-token.md): Get an M2M access token via the client_credentials grant. - [Register a user](https://openloop.mintlify.app/auth/register.md): Create the identity for a patient-facing app user with a service token, the first call in the registration flow. - [Send a one-time code](https://openloop.mintlify.app/auth/send-otp.md): Send a one-time login or verification code to a registering user's email or phone. - [Verify a one-time code](https://openloop.mintlify.app/auth/verify-otp.md): Redeem the one-time code a user received and get the verification code you exchange for tokens. - [Exchange a verification code](https://openloop.mintlify.app/auth/exchange-verification-code.md): Redeem a verification code from Verify a one-time code for user tokens. - [Refresh a token](https://openloop.mintlify.app/auth/refresh-token.md): Get new patient tokens from a refresh token, without re-authenticating. - [Revoke a session](https://openloop.mintlify.app/auth/revoke.md): End a patient session by revoking its refresh token, so the tokens issued with it stop working. - [Find a user by email](https://openloop.mintlify.app/users/find-user.md): Looks up a single user by email within the caller's organization. - [Read a user's patient link](https://openloop.mintlify.app/users/get-user-link.md): Look up which patient identifier a registered user id is linked to. - [Delete the current user](https://openloop.mintlify.app/users/delete-user.md): Delete the identity behind the presented user token, ending that user's access. - [List allergy intolerances](https://openloop.mintlify.app/api-reference/allergy-intolerances/list-allergy-intolerances.md): List allergies and intolerances across your organization's patients, filterable by `patient_id`, `category`, `clinical_status`, and `type`. - [Create allergy intolerance](https://openloop.mintlify.app/api-reference/allergy-intolerances/create-allergy-intolerance.md): Record an allergy or intolerance for a patient. - [Get allergy intolerance](https://openloop.mintlify.app/api-reference/allergy-intolerances/get-allergy-intolerance.md): Retrieve a single allergy or intolerance record by id. Returns 404 if the id doesn't exist or belongs to another organization. - [Update allergy intolerance](https://openloop.mintlify.app/api-reference/allergy-intolerances/update-allergy-intolerance.md): Update an existing allergy or intolerance record by id. - [List consents](https://openloop.mintlify.app/api-reference/consents/list-consents.md): List consents across your organization's patients, filterable by `patient_id` and `status`. - [Create consent](https://openloop.mintlify.app/api-reference/consents/create-consent.md): Record a patient's consent — for example to telehealth treatment, data sharing, or a privacy policy. Requires the consenting patient (`patient_id`), a `scope`, a `category`, and the `policy` consented to. - [Get consent](https://openloop.mintlify.app/api-reference/consents/get-consent.md): Retrieve a single consent by id. Returns 404 if the id doesn't exist or belongs to another organization. - [Update consent](https://openloop.mintlify.app/api-reference/consents/update-consent.md): Update an existing consent by id. - [List document references](https://openloop.mintlify.app/api-reference/document-references/list-document-references.md): List document references across your organization, filterable by `subject_id` and `status`. - [Create document reference](https://openloop.mintlify.app/api-reference/document-references/create-document-reference.md): Attach a document to your organization's record — an intake PDF, lab report, or ID photo. Link it to a patient with `subject_id`; the file itself is supplied in `content`. - [Upload document content](https://openloop.mintlify.app/api-reference/document-references/upload-document-content.md): Upload a file's bytes and get back a content reference to attach to a document. Send the file base64-encoded in `data` together with its `contentType`; the response returns an `id` that you then place in a document reference's `content[].attachment.url` (see [Create document reference](/document-ref… - [Get document reference](https://openloop.mintlify.app/api-reference/document-references/get-document-reference.md): Retrieve a single document reference by id. Returns 404 if the id doesn't exist or belongs to another organization. - [Update document reference](https://openloop.mintlify.app/api-reference/document-references/update-document-reference.md): Update an existing document reference by id. - [Get document reference content](https://openloop.mintlify.app/api-reference/document-references/get-document-reference-content.md): Retrieve the content payload of a document reference. - [Create lab requisition](https://openloop.mintlify.app/api-reference/laboratories/create-lab-requisition.md): Order one or more lab tests for a patient in your organization. The order is placed with OpenLoop's lab network using the patient's name, date of birth, gender, phone, email and home address as stored on the patient record, so those fields must be present before you call this endpoint (see the `400`… - [List medication statements](https://openloop.mintlify.app/api-reference/medication-statements/list-medication-statements.md): List medication statements across your organization's patients, filterable by `subject_id` and `status`. - [Create medication statement](https://openloop.mintlify.app/api-reference/medication-statements/create-medication-statement.md): Record a medication statement — an assertion that a patient is taking, has taken, or plans to take a medication, such as self-reported meds captured at intake. A statement is a record of usage, not an order. - [Get medication statement](https://openloop.mintlify.app/api-reference/medication-statements/get-medication-statement.md): Retrieve a single medication statement by id. Returns 404 if the id doesn't exist or belongs to another organization. - [List observations](https://openloop.mintlify.app/api-reference/observations/list-observations.md): List observations across your organization's patients, filterable by `subject_id`, `category`, `code`, and `status`. - [Create observation](https://openloop.mintlify.app/api-reference/observations/create-observation.md): Record an observation — a measurement, lab value, vital sign, or survey answer — for a patient. Survey observations may also be generated automatically from completed questionnaire responses. - [Get observation](https://openloop.mintlify.app/api-reference/observations/get-observation.md): Retrieve a single observation by id. Returns 404 if the id doesn't exist or belongs to another organization. - [Get organization](https://openloop.mintlify.app/api-reference/organizations/get-organization.md): Retrieve a single organization by id. Returns 404 if the id doesn't exist or belongs to another organization. - [List patients](https://openloop.mintlify.app/api-reference/patients/list-patients.md): List patients across your organization, filterable by `name` and `active`. Omitting `active` returns both active and inactive patients. - [Create patient](https://openloop.mintlify.app/api-reference/patients/create-patient.md): Create a patient record in your organization. A patient is the anchor for their encounters, documents, and orders, which reference a patient id. - [Get patient](https://openloop.mintlify.app/api-reference/patients/get-patient.md): Retrieve a single patient by id. Returns 404 if the id doesn't exist or belongs to another organization. - [Update patient](https://openloop.mintlify.app/api-reference/patients/update-patient.md): Update an existing patient by id. - [Delete your account](https://openloop.mintlify.app/api-reference/users/delete-your-account.md): Deletes the caller's own user identity. There is no `id` parameter — the account to delete is resolved from the `sub` claim of the bearer token itself, so a caller can only ever delete their own account. - [Get a user's linked record](https://openloop.mintlify.app/api-reference/users/get-a-users-linked-record.md): Returns the link for a `user_id` + `link_type` pair. - [Find a user by email](https://openloop.mintlify.app/api-reference/users/find-a-user-by-email.md): Looks up a single user by email within the caller's organization. - [List questionnaire responses](https://openloop.mintlify.app/api-reference/questionnaire-responses/list-questionnaire-responses.md): List questionnaire responses across your organization, filterable by `questionnaire_id`, `status`, `subject`, and `encounter_id` — for example, all completed responses to your refill questionnaire, or every response captured during a given encounter. - [Create questionnaire response](https://openloop.mintlify.app/api-reference/questionnaire-responses/create-questionnaire-response.md): Submit a patient's answers to a questionnaire; `answers` maps the questionnaire's item `link_id`s to typed values. `questionnaire_id` is required and identifies the Questionnaire the response belongs to (get it from `GET /questionnaires`); if you also send `questionnaire_canonical`, it must referenc… - [Get questionnaire response](https://openloop.mintlify.app/api-reference/questionnaire-responses/get-questionnaire-response.md): Retrieve a single questionnaire response with its answers. Returns 404 if the id doesn't exist or belongs to another organization. - [Update questionnaire response](https://openloop.mintlify.app/api-reference/questionnaire-responses/update-questionnaire-response.md): Update an existing questionnaire response by id. - [List questionnaires](https://openloop.mintlify.app/api-reference/questionnaires/list-questionnaires.md): List questionnaire definitions available to your organization — both those created through this API and those authored for you on the OpenLoop clinical platform. Filter by `status` or `title`. - [Get questionnaire](https://openloop.mintlify.app/api-reference/questionnaires/get-questionnaire.md): Retrieve a questionnaire definition, including its full nested item tree — use this to render the form's questions to a patient. - [List related persons](https://openloop.mintlify.app/api-reference/related-persons/list-related-persons.md): List the related persons attached to one patient. `patient_id` is required. - [Create related person](https://openloop.mintlify.app/api-reference/related-persons/create-related-person.md): Create a person related to a patient — a guardian, caregiver, or emergency contact — always attached to the patient via the required `patient_id`. - [Get related person](https://openloop.mintlify.app/api-reference/related-persons/get-related-person.md): Retrieve a single related person by id. Returns 404 if the id doesn't exist or belongs to another organization. - [Update related person](https://openloop.mintlify.app/api-reference/related-persons/update-related-person.md): Update an existing related person by id. - [List sites](https://openloop.mintlify.app/api-reference/sites/list-sites.md): List your organization's sites. - [Create site](https://openloop.mintlify.app/api-reference/sites/create-site.md): Create a site — a web-property configuration record (domain, brand, template, page sections) keyed by a URL-safe `key_name` unique within your organization. The `value` payload is free-form JSON that you define. Returns 409 if the key already exists. - [Get site](https://openloop.mintlify.app/api-reference/sites/get-site.md): Retrieve a single site by its key. Returns 404 if the key doesn't exist or belongs to another organization. - [Delete site](https://openloop.mintlify.app/api-reference/sites/delete-site.md): Delete a site by its key. Deleted resources cannot be recovered. - [Update site](https://openloop.mintlify.app/api-reference/sites/update-site.md): Update a site's `value` payload and/or `status`. At least one of the two must be provided. - [List tasks](https://openloop.mintlify.app/api-reference/tasks/list-tasks.md): List tasks across your organization, filterable by `status`, the patient or resource the task is for (`for_id`), and the assigned owner (`owner_id`, `owner_type`). - [Create task](https://openloop.mintlify.app/api-reference/tasks/create-task.md): Create a task — a tracked unit of work such as reviewing a document or following up with a patient. Requires `status` and `intent`; link the subject of the work via `for` and assign it via `owner`. - [Get task](https://openloop.mintlify.app/api-reference/tasks/get-task.md): Retrieve a single task by id. Returns 404 if the id doesn't exist or belongs to another organization. - [Update task](https://openloop.mintlify.app/api-reference/tasks/update-task.md): Update an existing task by id. - [Delete task](https://openloop.mintlify.app/api-reference/tasks/delete-task.md): Delete a task. Deleted resources cannot be recovered. - [List bookable appointment types](https://openloop.mintlify.app/api-reference/scheduling/list-bookable-appointment-types.md): Lists the appointment types your organization has adopted — the set you can book against — as `{ id, name }`. Your organization is read from the access token, so there is no org parameter. An organization that has adopted nothing gets an empty list. - [Retrieve an appointment type](https://openloop.mintlify.app/api-reference/scheduling/retrieve-an-appointment-type.md): Returns one appointment type with the rules that govern a slot search for it: when `requires_state_license` is true, the search must send `state`. - [Search available slots](https://openloop.mintlify.app/api-reference/scheduling/search-available-slots.md): Returns the bookable slots for one appointment type in a time window, each with an opaque `slot_token`. - [Reserve a slot](https://openloop.mintlify.app/api-reference/scheduling/reserve-a-slot.md): Reserves a slot so it is no longer offered while your patient finishes the flow. Optional — you can book straight from a `slot_token` — but it closes the window in which two patients can pick the same time. - [Release a slot reservation](https://openloop.mintlify.app/api-reference/scheduling/release-a-slot-reservation.md): Releases an unconfirmed reservation, offering the slot again immediately instead of waiting out its expiry. Fire this when the patient leaves the flow — back button, reload, or navigating away. - [List appointments](https://openloop.mintlify.app/api-reference/scheduling/list-appointments.md): Lists your appointments in ascending start order (`sort=desc` reverses it), filterable by patient, provider, appointment type, status, and outcome. - [Book an appointment](https://openloop.mintlify.app/api-reference/scheduling/book-an-appointment.md): Books an appointment. Send **exactly one** of: - [Retrieve an appointment](https://openloop.mintlify.app/api-reference/scheduling/retrieve-an-appointment.md): Returns one of your appointments, including the assigned provider and the current status and outcome. - [Update an appointment](https://openloop.mintlify.app/api-reference/scheduling/update-an-appointment.md): Changes one of your appointments. The body carries **exactly one** named change: `cancel`, `reschedule`, `complete`, or `reopen`. Two together is a `400` (`conflicting-patch`); none is a `400` (`empty-patch`). - [Get Price](https://openloop.mintlify.app/api-reference/prices/get-price.md): Retrieves a single price by ID. - [List Products](https://openloop.mintlify.app/api-reference/products/list-products.md): List the products in your own configuration, resolved from your token — there is no caller-supplied configuration id. Optionally filtered to active or inactive products with `active`. This route always lists OpenLoop's own synced catalog: it has no provider passthrough mode and no pagination, so eve… - [Get Product By Id](https://openloop.mintlify.app/api-reference/products/get-product-by-id.md): Retrieves a single product by ID. - [List Product Prices](https://openloop.mintlify.app/api-reference/products/list-product-prices.md): Lists every price for a product in your own configuration. No pagination — the product's full price list is returned in one response. - [Create Checkout Session](https://openloop.mintlify.app/api-reference/checkout/create-checkout-session.md): Creates a payment provider Checkout session with embedded, hosted, or elements UI, supporting payment, setup, or subscription modes. A subscription session may carry both recurring and one-time prices in one cart and accepts an optional trial. - [List Coupons](https://openloop.mintlify.app/api-reference/coupons/list-coupons.md): Lists all coupons for your configuration. - [Create Coupons](https://openloop.mintlify.app/api-reference/coupons/create-coupons.md): Creates one or more coupons in bulk for your configuration. - [Get Coupon](https://openloop.mintlify.app/api-reference/coupons/get-coupon.md): Retrieves a specific coupon by ID for the given configuration. - [Delete Coupon](https://openloop.mintlify.app/api-reference/coupons/delete-coupon.md): Deletes a coupon from the payment provider and local records. - [Get Payment Intent](https://openloop.mintlify.app/api-reference/intents/get-payment-intent.md): Retrieves a single payment intent by `provider_payment_intent_id` within your configuration, used to verify that a payment completed successfully. - [Get Setup Intent](https://openloop.mintlify.app/api-reference/intents/get-setup-intent.md): Retrieves a single setup intent by `provider_setup_intent_id` within your configuration, used to verify that a setup completed successfully. - [Create Setup Intent](https://openloop.mintlify.app/api-reference/intents/create-setup-intent.md): Creates a setup intent so a customer can save a payment method without being charged. Confirm it client-side with the returned `client_secret`, then verify the result with `GET /intents/setups/{provider_setup_intent_id}`. - [Get Invoices](https://openloop.mintlify.app/api-reference/invoices/get-invoices.md): Lists invoices for a customer identified by email. Supports limit and status filtering. - [Create Invoice Preview](https://openloop.mintlify.app/api-reference/invoices/create-invoice-preview.md): Previews the upcoming invoice for a subscription — the pending charges, line items, and applicable discounts — without creating a real invoice. - [Pay Invoice](https://openloop.mintlify.app/api-reference/invoices/pay-invoice.md): Forces an on-demand payment on a finalized invoice, outside the normal collection schedule. Charges the customer's default payment method off-session and returns the full updated invoice. - [Create Refund](https://openloop.mintlify.app/api-reference/invoices/create-refund.md): Issues a refund against a paid invoice, recorded on one credit note. The card part of `amount` goes back to the invoice's card payments; `balance_amount`, when sent, goes back to the billing customer's credit balance instead. - [Get Payment Methods](https://openloop.mintlify.app/api-reference/payment-methods/get-payment-methods.md): Returns the payment methods a connected account has configured and that OpenLoop supports, resolved from your configuration. The provider's enabled methods are intersected with the OpenLoop allowlist (`card`, `klarna`) and wallet aliases (`apple_pay`, `google_pay`) are normalized to `card`. - [List Promotion Codes](https://openloop.mintlify.app/api-reference/promotion-codes/list-promotion-codes.md): Lists promotion codes for your configuration, optionally filtered by coupon, active status, and/or code (exact-match lookup by code). - [Create Promotion Code](https://openloop.mintlify.app/api-reference/promotion-codes/create-promotion-code.md): Creates a new promotion code for a coupon. - [Deactivate Promotion Code](https://openloop.mintlify.app/api-reference/promotion-codes/deactivate-promotion-code.md): Deactivates a promotion code (`active: false`); the code remains in the system but cannot be used. Promotion codes cannot be hard-deleted, so `DELETE` maps to deactivation. - [Get Subscriptions](https://openloop.mintlify.app/api-reference/subscriptions/get-subscriptions.md): Lists subscriptions for a customer identified by email. Supports limit and status filtering. - [Create Subscription](https://openloop.mintlify.app/api-reference/subscriptions/create-subscription.md): Creates a subscription for a saved customer against a saved payment method, with no new checkout — the one-click post-purchase upsell path, given a saved `provider_customer_id` and one or more `provider_price_id`s. Recurring and one-time prices are sent together in `items`; there is no separate `one… - [Get Subscription](https://openloop.mintlify.app/api-reference/subscriptions/get-subscription.md): Retrieves a single subscription by `provider_subscription_id` within your configuration, in the same shape as each item returned by `GET /subscriptions`. - [Update Subscription](https://openloop.mintlify.app/api-reference/subscriptions/update-subscription.md): Partially updates an existing subscription. Immediate cancels, pauses and resumes are not accepted on this endpoint — use [`DELETE /subscriptions/{provider_subscription_id}`](./cancel-subscription.md) (cancel), [`POST /subscriptions/{provider_subscription_id}/pauses`](./pause-subscription.md) (pause… - [Cancel Subscription](https://openloop.mintlify.app/api-reference/subscriptions/cancel-subscription.md): Cancels a subscription. Supports three cancellation timing modes selected by the request body's `cancel_at` field: immediate (`"now"`), at the end of the current billing period (`"period_end"`), or at a specific future timestamp (``). The body is optional: without one, or without `canc… - [List Subscription Invoices](https://openloop.mintlify.app/api-reference/subscriptions/list-subscription-invoices.md): Lists the invoices belonging to a single subscription, identified by `provider_subscription_id` in the path. Supports `status` filtering and cursor pagination (`size` + `starting_after` / `after`). The per-invoice shape mirrors `GET /invoices`. - [Pause Subscription](https://openloop.mintlify.app/api-reference/subscriptions/pause-subscription.md): Pauses a subscription so it stops generating invoices and will not advance to new billing periods (resumable later via a separate resume endpoint). This does not change the subscription's `status` — check `paused` and `resumes_at` in the response instead. A subscription that has an attached schedule… - [Resume Subscription](https://openloop.mintlify.app/api-reference/subscriptions/resume-subscription.md): Resumes a paused subscription by deleting its pause. The pause is modeled as a sub-resource (`/pauses`) on the subscription — `POST` to create it, `DELETE` to remove it (= resume; this endpoint). The response returns the resumed subscription in the same shape as [`GET /subscriptions/{provider_subscr… - [Get Config](https://openloop.mintlify.app/api-reference/configs/get-config.md): Returns the caller's own configuration record. The target config is resolved from the caller's identity, not from a path or query parameter, so there is no way to look up any config other than your own. Provider secret keys are never stored on the config, so the response never includes one. - [List Billing Portals](https://openloop.mintlify.app/api-reference/billing-portals/list-billing-portals.md): Lists all billing portal configurations available for your configuration. - [Create Retention Portal Session](https://openloop.mintlify.app/api-reference/billing-portals/create-retention-portal-session.md): Creates a Chargebee Retention pre-cancel hosted-page session for a subscription scoped to a configuration that has retention enabled. Returns a redirect URL the customer is sent to in order to enter the retention flow. Sibling endpoint to `POST /billing-portals/{provider_billing_portal_id}/sessions`… - [Create Portal Session](https://openloop.mintlify.app/api-reference/billing-portals/create-portal-session.md): Creates a billing portal session for a customer. Returns a session URL that can be used to redirect the customer to the portal. > **Sibling endpoint**: tenants who have Chargebee Retention enabled (`retention_app_id` set on their config) should call [`POST /billing-portals/retention-sessions`](./cre… - [Get Customers](https://openloop.mintlify.app/api-reference/billing-customers/get-customers.md): Searches for customers by email within your configuration. Returns a summarized view aggregated across all matching customers, plus the full list of matching provider customer IDs. - [Create Customer](https://openloop.mintlify.app/api-reference/billing-customers/create-customer.md): Create-or-update ("upsert") a customer, keyed on `email`, within the config's payment-provider account. Searches for an existing customer by email; if found, updates the most recently created match; otherwise creates a new customer. Idempotent on email. - [Get Customer](https://openloop.mintlify.app/api-reference/billing-customers/get-customer.md): Retrieves a single customer by `provider_customer_id` within your configuration. - [Update Customer](https://openloop.mintlify.app/api-reference/billing-customers/update-customer.md): Partial update of a customer. At least one update field is required. - [List Billing Customer Subscriptions](https://openloop.mintlify.app/api-reference/billing-customers/list-billing-customer-subscriptions.md): Lists the subscriptions belonging to one of your billing customers, with optional `status` filtering. Returns up to 100 subscriptions under a `subscriptions` key; pagination is not yet supported, so a customer holding more than 100 is truncated with no signal on the wire. - [List Balance Transactions](https://openloop.mintlify.app/api-reference/billing-customers/list-balance-transactions.md): Lists one of your billing customers' balance transactions, newest first: the record of credit granted or clawed back through `POST /billing-customers/{provider_customer_id}/balance-transactions`, and of credit applied to invoices. Paginated: pass the previous page's `after` as `starting_after`. - [Create Balance Transaction](https://openloop.mintlify.app/api-reference/billing-customers/create-balance-transaction.md): Grants account credit to one of your billing customers, or claws unused credit back. `amount` uses the payment provider's sign, the same convention as the billing customer's `balance`: **a negative amount grants credit (at most `10000`, $100.00 in USD, per request), and a positive amount claws credi… - [Submit an eligibility verification](https://openloop.mintlify.app/api-reference/eligibility/submit-an-eligibility-verification.md): Asks a payer whether a patient's coverage is active and what it covers. The check runs out of band: this call answers 202 with an `id`, and the answer arrives on `GET /eligibility-verifications/{id}`. - [Retrieve an eligibility verification](https://openloop.mintlify.app/api-reference/eligibility/retrieve-an-eligibility-verification.md): Returns the check's current state, and its `result` once the payer has answered. This route reads what was stored and never calls a payer, so a `PENDING` answer means the check is still running. - [Submit an insurance discovery](https://openloop.mintlify.app/api-reference/eligibility/submit-an-insurance-discovery.md): Finds coverage a patient may have when you do not know their payer or member id, from demographics alone. Queued rather than answered inline: this call answers 202 with an `id` and `status: PENDING`, and the result arrives on `GET /insurance-discoveries/{id}`. - [Retrieve an insurance discovery](https://openloop.mintlify.app/api-reference/eligibility/retrieve-an-insurance-discovery.md): Returns the discovery's current state, and once it has finished either the coverages found or the reason the payer network could not answer. **The two shapes never mix.** - [Coordinate benefits across payers](https://openloop.mintlify.app/api-reference/eligibility/coordinate-benefits-across-payers.md): Asks a payer you already know the patient has what other coverage they have, and which coverage pays first. **Answered inline** — there is nothing to poll. - [Resolve a Medicare Beneficiary Identifier](https://openloop.mintlify.app/api-reference/eligibility/resolve-a-medicare-beneficiary-identifier.md): Resolves a Medicare Beneficiary Identifier from a patient's demographics, with a minimal coverage summary. **Answered inline** — there is nothing to poll, and the identifier is at `data.member_id`. - [Check network status for a payer in a state](https://openloop.mintlify.app/api-reference/eligibility/check-network-status-for-a-payer-in-a-state.md): Asks whether OpenLoop holds contracted, credentialed providers for a payer in a state, within your organization. **Answered inline**: there is nothing to poll. - [List or search payers](https://openloop.mintlify.app/api-reference/payer-directory/list-or-search-payers.md): Lists the payers whose `payer_id` an eligibility verification and a coordination check accept. Send an entry's `payer_id` unchanged, character for character. - [Retrieve a payer](https://openloop.mintlify.app/api-reference/payer-directory/retrieve-a-payer.md): Resolves a stored `payer_id` back to its directory entry. **Exact match only**: aliases and other ids do not resolve, and letter case must match. - [Get a patient's Passport profile](https://openloop.mintlify.app/api-reference/patient-passport/get-a-patients-passport-profile.md): The patient's profile as Patient Passport holds it: name, birth date, phone, time zone and shipping address. - [List a patient's Passport appointments](https://openloop.mintlify.app/api-reference/patient-passport/list-a-patients-passport-appointments.md): The patient's upcoming or past appointments. Returns the first page only: `pagination.after` is `PAGING_NOT_SUPPORTED` when the list may have more items than `limit`, and `null` when the list is complete. Sending `cursor` answers 400 until paging is supported. - [List a patient's Passport orders](https://openloop.mintlify.app/api-reference/patient-passport/list-a-patients-passport-orders.md): The patient's pharmacy orders, with each order's current step and shipment tracking. Returns the first page only: `pagination.after` is `PAGING_NOT_SUPPORTED` when the list may have more items than `limit`, and `null` when the list is complete. Sending `cursor` answers 400 until paging is supported. - [List a patient's Passport subscriptions](https://openloop.mintlify.app/api-reference/patient-passport/list-a-patients-passport-subscriptions.md): The patient's subscriptions, with price, next charge, last payment and discounts. Amounts are in minor units (cents). Returns every item in one page, so `pagination.after` and `pagination.before` are `null`. - [Get a patient's Passport journey](https://openloop.mintlify.app/api-reference/patient-passport/get-a-patients-passport-journey.md): Where the patient is in each of their programs, and whether the current step is theirs to take. Returns every item in one page, so `pagination.after` and `pagination.before` are `null`. ## OpenAPI Specs - [openapi](/_archived/legacy/openapi.json) - [openapi](/_archived/openapi.json) - [openapi](/openapi.json) ## Optional - [OpenLoop Health](https://openloophealth.com) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.