Appointment Availability1

Appointment Reminders3

Appointment Types2

Appointments5

Charges6

Deltas1

Drugs3

Encounter Types1

Encounters4

Extended Patient Details1

Facilities1

Health Maintenance2

Inventory4

Partner Applications3

Patient Allergies1

Patient Charges3

Patient Documents5

Patient Emails1

Patient Facilities/Specialists7

Patient Free-Text Notes4

Patient Health Maintenance2

Patient Images5

Patient Invoices2

Patient Lab Results1

Patient Orders2

Patient Past Medical History1

Patient Portal4

Patient Prescriptions5

Patient Subscriptions2

Patient Supplements4

Patient Tags3

Patient Vaccines1

Patient Vitals8

Patients6

Questionnaires3

Secure Messages2

Supplements5

Tags4

Tasks4

Users3

Vitals3

Patient Subscriptions

Get All Subscriptions for a Single Patient

Note: This endpoint requires a compatible merchant services integration to be activated on the account. Accounts without an active merchant services integration will receive a 403 Forbidden response.

get/patients/{patient_id}/subscriptions

Request

Base URL: https://clinic-subdomain.md-hq.com/api/v1
URL: https://clinic-subdomain.md-hq.com/api/v1/patients/{patient_id}/subscriptions
Auth: HTTP basic

Path parameters

patient_idinteger required

ID of patient

Query parameters

include_deletedboolean

False by default. Returns deleted and current subscriptions if set to true.

Response

A subscription is considered delinquent if it is not deleted and the most recent charge attempted is at least one day old, is not voided, and has no credit allocated to it.
charge_runs_on return value depends on the schedule_frequency of the subscription. Day of the week for weekly, day of month for monthly, month and day (MM/DD) for annually.
success_attempts indicates the number of times the subscription charge was successfully applied to the patient's account (not the number of times it was paid)
fail_attempts indicates the number of times the subscription charge was unsuccessfully applied to the patient's account (not the number of times payment failed)

schedule_frequency	charge_runs_on
Weekly	Day of the week (e.g., Monday, Friday, etc.)
Monthly	Day of the month (e.g., 1, 15, etc.)
Annually	DD/MM day of the year (e.g., 02/07, 10/22, etc.)

Changes

No recorded changes to this operation across all 1 revision of this API.