Skip to main content
GET
Get Member

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

member_id
string
required

Response

Successful Response

id
string
required

Unique identifier for the member

patientId
string
required

ID of the patient

membershipId
string
required

ID of the membership

membership
MembershipDetail · object
required

Membership information

startDate
string<date-time>
required

When the patient joined the membership

status
enum<string>
required

Current status of the membership

Available options:
ACTIVE,
EXPIRED,
CANCELLED,
DELINQUENT,
FROZEN
autoRenew
boolean
required

Whether the membership auto-renews

billingFrequency
enum<string>
required

Billing frequency for this member

Available options:
DAILY,
WEEKLY,
BIWEEKLY,
MONTHLY,
QUARTERLY,
SEMI_ANNUALLY,
YEARLY
patient
PatientSummary · object
required

Patient information

charges
ChargeTiny · object[]
required

Charges for this member

soldByProviderId
string | null

ID of the provider who sold this membership

endDate
string<date-time> | null

When the membership ended (if applicable)

nextBillingDate
string<date-time> | null

Next scheduled billing date (if custom)

unfreezeDate
string<date-time> | null

When the membership should be automatically unfrozen

soldByProvider
ProviderCreator · object | null

Provider who sold this membership

createdDate
string<date-time> | null

When the member record was created

updatedDate
string<date-time> | null

When the member record was last updated

paymentMethod
PaymentMethodSummary · object | null

Payment method for this member

logs
MemberLogTiny · object[]

Activity logs for this member