{ "bill_date": "Date when the membership is billed", "billed_through_date": "Date through which the membership has been billed", "billing_start_date": "Date when billing started for the membership", "bills_at_end_of_period": "Whether the membership bills at the end of the billing period", "contract_expiration_action": "Action taken when the contract expires", "contract_expires": "Whether the membership contract expires", "contract_period_in_months": "Length of the contract period in months", "coupon": { "amount_off_in_cents": "Amount off in cents", "apply_to_each_patient": "Whether the coupon applies to each patient on the membership", "code": "Coupon code", "created_at": "Timestamp when the coupon was created", "description": "Description of the coupon", "duration_in_months": "Duration of the coupon in months", "id": "Unique identifier for the coupon", "is_archived": "Whether the coupon is archived", "is_redeemable": "Whether the coupon is redeemable", "percent_off": "Percentage off provided by the coupon", "redeemable_from": "Start date from which the coupon is redeemable", "redeemable_until": "End date until which the coupon is redeemable", "updated_at": "Timestamp when the coupon was last updated" }, "created_at": "Timestamp when the membership was created", "end_date": "End date of the membership", "enrollment_status": "Current enrollment status of the membership", "fixed_period_rate_in_cents": "Fixed period rate in cents", "fixed_registration_fee_in_cents": "Fixed registration fee in cents", "group_code": "Group code associated with the membership", "id": "Unique identifier for the membership", "is_confirmed": "Whether the membership is confirmed", "is_current": "Whether the membership is currently active", "is_processing": "Whether the membership is being processed", "is_restartable": "Whether the membership can be restarted", "list_price_in_cents": "List price of the membership in cents", "membership_patients": { "end_date": "End date for this patient on the membership", "fixed_period_rate_in_cents": "Fixed period rate in cents for this patient", "id": "Unique identifier for the membership patient", "list_price_in_cents": "List price in cents for this patient", "member_type": "Type of member (e.g., primary, spouse, dependent)", "patient": { "account": { "name": "Name on the billing account", "past_due_in_cents": "Amount past due in cents" }, "address_city": "City of the patient's address", "address_country": "Country of the patient's address", "address_line1": "First line of the patient's address", "address_line2": "Second line of the patient's address", "address_state": "State of the patient's address", "address_zip": "ZIP code of the patient's address", "age": "Age of the patient", "chosen_first_name": "Patient's chosen or preferred first name", "chosen_last_name": "Patient's chosen or preferred last name", "chosen_middle_name": "Patient's chosen or preferred middle name", "chosen_suffix": "Patient's chosen or preferred suffix", "chosen_title": "Patient's chosen or preferred title", "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "created_at": "Timestamp when the patient record was created", "dob": "Patient's date of birth", "electronic_communication_consent_accepted": "Whether the patient accepted electronic communication consent", "electronic_communication_consent_accepted_at": "Timestamp when the patient accepted electronic communication consent", "email": "Patient's email address", "external_link_id": "External link identifier for the patient", "external_records": { "external_id": "External identifier in the source system", "source": "Source system of the external record" }, "first_name": "Patient's first name", "gender": "Patient's gender", "gender_identity": "Patient's gender identity", "gender_other": "Patient's gender if not covered by standard options", "health_insurance_group_id": "Health insurance group ID", "health_insurance_member_id": "Health insurance member ID", "health_insurance_payer_id": "Health insurance payer ID", "health_insurance_payer_name": "Health insurance payer name", "hipaa_authorization_accepted": "Whether the patient accepted the HIPAA authorization", "hipaa_authorization_accepted_at": "Timestamp when the patient accepted the HIPAA authorization", "id": "Unique identifier for the patient", "import_id": "Import batch identifier", "import_source": "Source system of the import", "joined_practice_date": "Date the patient joined the practice", "known_practice": { "id": "Unique identifier for the known practice", "name": "Name of the known practice" }, "last_name": "Patient's last name", "lead_source": { "created_at": "Timestamp when the lead source was created", "id": "Unique identifier for the lead source", "name": "Name of the lead source", "updated_at": "Timestamp when the lead source was last updated" }, "lead_source_other": "Description of the lead source when 'Other' is selected", "location": { "address_city": "City of the location's address", "address_country": "Country of the location's address", "address_latitude": "Latitude of the location's address", "address_line1": "First line of the location's address", "address_line2": "Second line of the location's address", "address_longitude": "Longitude of the location's address", "address_state": "State of the location's address", "address_zip": "ZIP code of the location's address", "distance": "Distance from the patient to the location", "id": "Unique identifier for the location", "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "name": "Name of the location", "phone_number": "Phone number of the location", "virtual": "Whether the location is virtual" }, "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "master_record_sponsor": "Master record sponsor identifier", "membership_status": "Current membership status of the patient", "memberships": { "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "division": { "id": "Unique identifier for the division", "name": "Name of the division" }, "end_date": "End date of the membership", "enrollment_requested_on": "Date when enrollment was requested", "enrollment_status": "Current enrollment status", "member_type": "Type of membership (e.g., employee, spouse, dependent)", "payer": { "id": "Unique identifier for the payer", "name": "Name of the payer" }, "plan": { "id": "Unique identifier for the plan", "name": "Name of the plan" }, "start_date": "Start date of the membership", "status": "Current status of the membership", "uses_tobacco": "Whether the member uses tobacco" }, "merged_into": { "id": "Unique identifier of the patient record this was merged into", "name": "Name of the patient record this was merged into" }, "middle_name": "Patient's middle name", "name": "Patient's full name", "patient_agreement_accepted": "Whether the patient accepted the patient agreement", "patient_agreement_accepted_at": "Timestamp when the patient accepted the patient agreement", "phones": { "number": "Phone number", "type": "Type of phone number (e.g., mobile, home, work)" }, "practitioner": { "accepts_enrollments_from_employer": "Whether the practitioner accepts enrollments from employers", "accepts_enrollments_from_retail": "Whether the practitioner accepts enrollments from retail", "bio": "Practitioner's biography", "created_at": "Timestamp when the practitioner record was created", "education": "Practitioner's education background", "email": "Practitioner's email address", "gender": "Practitioner's gender", "gender_other": "Practitioner's gender if not covered by standard options", "id": "Unique identifier for the practitioner", "integration_record_id": "Integration record identifier for the practitioner", "locations": { "address_city": "City of the location's address", "address_country": "Country of the location's address", "address_latitude": "Latitude of the location's address", "address_line1": "First line of the location's address", "address_line2": "Second line of the location's address", "address_longitude": "Longitude of the location's address", "address_state": "State of the location's address", "address_zip": "ZIP code of the location's address", "distance": "Distance from the patient to the location", "id": "Unique identifier for the location", "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "name": "Name of the location", "phone_number": "Phone number of the location", "virtual": "Whether the location is virtual" }, "max_patient_age": "Maximum patient age the practitioner serves", "min_patient_age": "Minimum patient age the practitioner serves", "name": "Practitioner's full name", "npi": { "id": "NPI number", "name": "Name associated with the NPI" }, "online_signup_visibility": "Practitioner's visibility for online signup", "panel_size": "Current number of patients in the practitioner's panel", "panel_size_limit": "Maximum number of patients allowed in the practitioner's panel", "photo_url": "URL to the practitioner's photo", "specialties": { "id": "Unique identifier for the specialty", "name": "Name of the specialty" }, "updated_at": "Timestamp when the practitioner record was last updated" }, "practitioner_group": { "created_at": "Timestamp when the practitioner group was created", "id": "Unique identifier for the practitioner group", "integration_record_id": "Integration record identifier for the practitioner group", "name": "Name of the practitioner group", "updated_at": "Timestamp when the practitioner group was last updated" }, "preferred_language": "Patient's preferred language", "pronouns": "Patient's preferred pronouns", "provider_web_link": "URL link to the patient's profile in the provider portal", "sex": "Patient's biological sex", "sponsorships": { "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "external_id": "External identifier from another system", "family": { "id": "Unique identifier for the family", "name": "Name of the family" }, "id": "Unique identifier for the sponsorship", "is_subscriber": "Whether this person is the subscriber", "type": "Type of sponsorship (e.g., employee, spouse, dependent)" }, "suffix": "Patient's name suffix", "terms_accepted": "Whether the patient accepted the terms of service", "terms_accepted_at": "Timestamp when the patient accepted the terms of service", "updated_at": "Timestamp when the patient record was last updated", "uses_tobacco": "Whether the patient uses tobacco" }, "period_rate_in_cents": "Rate per billing period in cents for this patient", "revenue_in_cents": "Revenue in cents for this patient", "start_date": "Start date for this patient on the membership", "uses_tobacco": "Whether the patient uses tobacco" }, "next_bill_date": "Date of the next bill", "owner": { "account": { "name": "Name on the billing account", "past_due_in_cents": "Amount past due in cents" }, "address_city": "City of the patient's address", "address_country": "Country of the patient's address", "address_line1": "First line of the patient's address", "address_line2": "Second line of the patient's address", "address_state": "State of the patient's address", "address_zip": "ZIP code of the patient's address", "age": "Age of the patient", "chosen_first_name": "Patient's chosen or preferred first name", "chosen_last_name": "Patient's chosen or preferred last name", "chosen_middle_name": "Patient's chosen or preferred middle name", "chosen_suffix": "Patient's chosen or preferred suffix", "chosen_title": "Patient's chosen or preferred title", "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "created_at": "Timestamp when the patient record was created", "dob": "Patient's date of birth", "electronic_communication_consent_accepted": "Whether the patient accepted electronic communication consent", "electronic_communication_consent_accepted_at": "Timestamp when the patient accepted electronic communication consent", "email": "Patient's email address", "external_link_id": "External link identifier for the patient", "external_records": { "external_id": "External identifier in the source system", "source": "Source system of the external record" }, "first_name": "Patient's first name", "gender": "Patient's gender", "gender_identity": "Patient's gender identity", "gender_other": "Patient's gender if not covered by standard options", "health_insurance_group_id": "Health insurance group ID", "health_insurance_member_id": "Health insurance member ID", "health_insurance_payer_id": "Health insurance payer ID", "health_insurance_payer_name": "Health insurance payer name", "hipaa_authorization_accepted": "Whether the patient accepted the HIPAA authorization", "hipaa_authorization_accepted_at": "Timestamp when the patient accepted the HIPAA authorization", "id": "Unique identifier for the patient", "import_id": "Import batch identifier", "import_source": "Source system of the import", "joined_practice_date": "Date the patient joined the practice", "known_practice": { "id": "Unique identifier for the known practice", "name": "Name of the known practice" }, "last_name": "Patient's last name", "lead_source": { "created_at": "Timestamp when the lead source was created", "id": "Unique identifier for the lead source", "name": "Name of the lead source", "updated_at": "Timestamp when the lead source was last updated" }, "lead_source_other": "Description of the lead source when 'Other' is selected", "location": { "address_city": "City of the location's address", "address_country": "Country of the location's address", "address_latitude": "Latitude of the location's address", "address_line1": "First line of the location's address", "address_line2": "Second line of the location's address", "address_longitude": "Longitude of the location's address", "address_state": "State of the location's address", "address_zip": "ZIP code of the location's address", "distance": "Distance from the patient to the location", "id": "Unique identifier for the location", "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "name": "Name of the location", "phone_number": "Phone number of the location", "virtual": "Whether the location is virtual" }, "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "master_record_sponsor": "Master record sponsor identifier", "membership_status": "Current membership status of the patient", "memberships": { "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "division": { "id": "Unique identifier for the division", "name": "Name of the division" }, "end_date": "End date of the membership", "enrollment_requested_on": "Date when enrollment was requested", "enrollment_status": "Current enrollment status", "member_type": "Type of membership (e.g., employee, spouse, dependent)", "payer": { "id": "Unique identifier for the payer", "name": "Name of the payer" }, "plan": { "id": "Unique identifier for the plan", "name": "Name of the plan" }, "start_date": "Start date of the membership", "status": "Current status of the membership", "uses_tobacco": "Whether the member uses tobacco" }, "merged_into": { "id": "Unique identifier of the patient record this was merged into", "name": "Name of the patient record this was merged into" }, "middle_name": "Patient's middle name", "name": "Patient's full name", "patient_agreement_accepted": "Whether the patient accepted the patient agreement", "patient_agreement_accepted_at": "Timestamp when the patient accepted the patient agreement", "phones": { "number": "Phone number", "type": "Type of phone number (e.g., mobile, home, work)" }, "practitioner": { "accepts_enrollments_from_employer": "Whether the practitioner accepts enrollments from employers", "accepts_enrollments_from_retail": "Whether the practitioner accepts enrollments from retail", "bio": "Practitioner's biography", "created_at": "Timestamp when the practitioner record was created", "education": "Practitioner's education background", "email": "Practitioner's email address", "gender": "Practitioner's gender", "gender_other": "Practitioner's gender if not covered by standard options", "id": "Unique identifier for the practitioner", "integration_record_id": "Integration record identifier for the practitioner", "locations": { "address_city": "City of the location's address", "address_country": "Country of the location's address", "address_latitude": "Latitude of the location's address", "address_line1": "First line of the location's address", "address_line2": "Second line of the location's address", "address_longitude": "Longitude of the location's address", "address_state": "State of the location's address", "address_zip": "ZIP code of the location's address", "distance": "Distance from the patient to the location", "id": "Unique identifier for the location", "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "name": "Name of the location", "phone_number": "Phone number of the location", "virtual": "Whether the location is virtual" }, "max_patient_age": "Maximum patient age the practitioner serves", "min_patient_age": "Minimum patient age the practitioner serves", "name": "Practitioner's full name", "npi": { "id": "NPI number", "name": "Name associated with the NPI" }, "online_signup_visibility": "Practitioner's visibility for online signup", "panel_size": "Current number of patients in the practitioner's panel", "panel_size_limit": "Maximum number of patients allowed in the practitioner's panel", "photo_url": "URL to the practitioner's photo", "specialties": { "id": "Unique identifier for the specialty", "name": "Name of the specialty" }, "updated_at": "Timestamp when the practitioner record was last updated" }, "practitioner_group": { "created_at": "Timestamp when the practitioner group was created", "id": "Unique identifier for the practitioner group", "integration_record_id": "Integration record identifier for the practitioner group", "name": "Name of the practitioner group", "updated_at": "Timestamp when the practitioner group was last updated" }, "preferred_language": "Patient's preferred language", "pronouns": "Patient's preferred pronouns", "provider_web_link": "URL link to the patient's profile in the provider portal", "sex": "Patient's biological sex", "sponsorships": { "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "external_id": "External identifier from another system", "family": { "id": "Unique identifier for the family", "name": "Name of the family" }, "id": "Unique identifier for the sponsorship", "is_subscriber": "Whether this person is the subscriber", "type": "Type of sponsorship (e.g., employee, spouse, dependent)" }, "suffix": "Patient's name suffix", "terms_accepted": "Whether the patient accepted the terms of service", "terms_accepted_at": "Timestamp when the patient accepted the terms of service", "updated_at": "Timestamp when the patient record was last updated", "uses_tobacco": "Whether the patient uses tobacco" }, "period_in_months": "Billing period length in months", "period_rate_in_cents": "Rate per billing period in cents", "plan": { "id": "Unique identifier for the plan", "name": "Name of the plan", "plan_type": "Type of plan (e.g., retail, employer)" }, "rate_in_cents": "Rate in cents for the membership", "source_status": "Status from the source system", "sponsorship": { "company": { "id": "Unique identifier for the sponsor company", "name": "Name of the sponsor company" }, "id": "Unique identifier for the sponsorship" }, "start_date": "Start date of the membership", "status": "Current status of the membership", "upcoming_bills": { "amount_in_cents": "Total amount of the upcoming bill in cents", "charges_amount_in_cents": "Charges amount in cents", "coupon_discount_in_cents": "Coupon discount amount in cents", "coupon_discount_months": "Number of months the coupon discount applies", "coupon_percent_off": "Percentage off from the coupon", "customer_invoice": { "id": "Unique identifier for the invoice" }, "date": "Date of the upcoming bill", "end_date": "End date of the billing period", "list_price_in_cents": "List price in cents", "membership_amount_in_cents": "Membership amount in cents", "period_in_months": "Billing period length in months", "rate_in_cents": "Rate in cents", "registration_fee_in_cents": "Registration fee in cents", "start_date": "Start date of the billing period" }, "updated_at": "Timestamp when the membership was last updated"}
Hint Health
Membership
Event payload details and trigger documentation for Membership data from Hint Health
{ "bill_date": "Date when the membership is billed", "billed_through_date": "Date through which the membership has been billed", "billing_start_date": "Date when billing started for the membership", "bills_at_end_of_period": "Whether the membership bills at the end of the billing period", "contract_expiration_action": "Action taken when the contract expires", "contract_expires": "Whether the membership contract expires", "contract_period_in_months": "Length of the contract period in months", "coupon": { "amount_off_in_cents": "Amount off in cents", "apply_to_each_patient": "Whether the coupon applies to each patient on the membership", "code": "Coupon code", "created_at": "Timestamp when the coupon was created", "description": "Description of the coupon", "duration_in_months": "Duration of the coupon in months", "id": "Unique identifier for the coupon", "is_archived": "Whether the coupon is archived", "is_redeemable": "Whether the coupon is redeemable", "percent_off": "Percentage off provided by the coupon", "redeemable_from": "Start date from which the coupon is redeemable", "redeemable_until": "End date until which the coupon is redeemable", "updated_at": "Timestamp when the coupon was last updated" }, "created_at": "Timestamp when the membership was created", "end_date": "End date of the membership", "enrollment_status": "Current enrollment status of the membership", "fixed_period_rate_in_cents": "Fixed period rate in cents", "fixed_registration_fee_in_cents": "Fixed registration fee in cents", "group_code": "Group code associated with the membership", "id": "Unique identifier for the membership", "is_confirmed": "Whether the membership is confirmed", "is_current": "Whether the membership is currently active", "is_processing": "Whether the membership is being processed", "is_restartable": "Whether the membership can be restarted", "list_price_in_cents": "List price of the membership in cents", "membership_patients": { "end_date": "End date for this patient on the membership", "fixed_period_rate_in_cents": "Fixed period rate in cents for this patient", "id": "Unique identifier for the membership patient", "list_price_in_cents": "List price in cents for this patient", "member_type": "Type of member (e.g., primary, spouse, dependent)", "patient": { "account": { "name": "Name on the billing account", "past_due_in_cents": "Amount past due in cents" }, "address_city": "City of the patient's address", "address_country": "Country of the patient's address", "address_line1": "First line of the patient's address", "address_line2": "Second line of the patient's address", "address_state": "State of the patient's address", "address_zip": "ZIP code of the patient's address", "age": "Age of the patient", "chosen_first_name": "Patient's chosen or preferred first name", "chosen_last_name": "Patient's chosen or preferred last name", "chosen_middle_name": "Patient's chosen or preferred middle name", "chosen_suffix": "Patient's chosen or preferred suffix", "chosen_title": "Patient's chosen or preferred title", "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "created_at": "Timestamp when the patient record was created", "dob": "Patient's date of birth", "electronic_communication_consent_accepted": "Whether the patient accepted electronic communication consent", "electronic_communication_consent_accepted_at": "Timestamp when the patient accepted electronic communication consent", "email": "Patient's email address", "external_link_id": "External link identifier for the patient", "external_records": { "external_id": "External identifier in the source system", "source": "Source system of the external record" }, "first_name": "Patient's first name", "gender": "Patient's gender", "gender_identity": "Patient's gender identity", "gender_other": "Patient's gender if not covered by standard options", "health_insurance_group_id": "Health insurance group ID", "health_insurance_member_id": "Health insurance member ID", "health_insurance_payer_id": "Health insurance payer ID", "health_insurance_payer_name": "Health insurance payer name", "hipaa_authorization_accepted": "Whether the patient accepted the HIPAA authorization", "hipaa_authorization_accepted_at": "Timestamp when the patient accepted the HIPAA authorization", "id": "Unique identifier for the patient", "import_id": "Import batch identifier", "import_source": "Source system of the import", "joined_practice_date": "Date the patient joined the practice", "known_practice": { "id": "Unique identifier for the known practice", "name": "Name of the known practice" }, "last_name": "Patient's last name", "lead_source": { "created_at": "Timestamp when the lead source was created", "id": "Unique identifier for the lead source", "name": "Name of the lead source", "updated_at": "Timestamp when the lead source was last updated" }, "lead_source_other": "Description of the lead source when 'Other' is selected", "location": { "address_city": "City of the location's address", "address_country": "Country of the location's address", "address_latitude": "Latitude of the location's address", "address_line1": "First line of the location's address", "address_line2": "Second line of the location's address", "address_longitude": "Longitude of the location's address", "address_state": "State of the location's address", "address_zip": "ZIP code of the location's address", "distance": "Distance from the patient to the location", "id": "Unique identifier for the location", "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "name": "Name of the location", "phone_number": "Phone number of the location", "virtual": "Whether the location is virtual" }, "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "master_record_sponsor": "Master record sponsor identifier", "membership_status": "Current membership status of the patient", "memberships": { "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "division": { "id": "Unique identifier for the division", "name": "Name of the division" }, "end_date": "End date of the membership", "enrollment_requested_on": "Date when enrollment was requested", "enrollment_status": "Current enrollment status", "member_type": "Type of membership (e.g., employee, spouse, dependent)", "payer": { "id": "Unique identifier for the payer", "name": "Name of the payer" }, "plan": { "id": "Unique identifier for the plan", "name": "Name of the plan" }, "start_date": "Start date of the membership", "status": "Current status of the membership", "uses_tobacco": "Whether the member uses tobacco" }, "merged_into": { "id": "Unique identifier of the patient record this was merged into", "name": "Name of the patient record this was merged into" }, "middle_name": "Patient's middle name", "name": "Patient's full name", "patient_agreement_accepted": "Whether the patient accepted the patient agreement", "patient_agreement_accepted_at": "Timestamp when the patient accepted the patient agreement", "phones": { "number": "Phone number", "type": "Type of phone number (e.g., mobile, home, work)" }, "practitioner": { "accepts_enrollments_from_employer": "Whether the practitioner accepts enrollments from employers", "accepts_enrollments_from_retail": "Whether the practitioner accepts enrollments from retail", "bio": "Practitioner's biography", "created_at": "Timestamp when the practitioner record was created", "education": "Practitioner's education background", "email": "Practitioner's email address", "gender": "Practitioner's gender", "gender_other": "Practitioner's gender if not covered by standard options", "id": "Unique identifier for the practitioner", "integration_record_id": "Integration record identifier for the practitioner", "locations": { "address_city": "City of the location's address", "address_country": "Country of the location's address", "address_latitude": "Latitude of the location's address", "address_line1": "First line of the location's address", "address_line2": "Second line of the location's address", "address_longitude": "Longitude of the location's address", "address_state": "State of the location's address", "address_zip": "ZIP code of the location's address", "distance": "Distance from the patient to the location", "id": "Unique identifier for the location", "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "name": "Name of the location", "phone_number": "Phone number of the location", "virtual": "Whether the location is virtual" }, "max_patient_age": "Maximum patient age the practitioner serves", "min_patient_age": "Minimum patient age the practitioner serves", "name": "Practitioner's full name", "npi": { "id": "NPI number", "name": "Name associated with the NPI" }, "online_signup_visibility": "Practitioner's visibility for online signup", "panel_size": "Current number of patients in the practitioner's panel", "panel_size_limit": "Maximum number of patients allowed in the practitioner's panel", "photo_url": "URL to the practitioner's photo", "specialties": { "id": "Unique identifier for the specialty", "name": "Name of the specialty" }, "updated_at": "Timestamp when the practitioner record was last updated" }, "practitioner_group": { "created_at": "Timestamp when the practitioner group was created", "id": "Unique identifier for the practitioner group", "integration_record_id": "Integration record identifier for the practitioner group", "name": "Name of the practitioner group", "updated_at": "Timestamp when the practitioner group was last updated" }, "preferred_language": "Patient's preferred language", "pronouns": "Patient's preferred pronouns", "provider_web_link": "URL link to the patient's profile in the provider portal", "sex": "Patient's biological sex", "sponsorships": { "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "external_id": "External identifier from another system", "family": { "id": "Unique identifier for the family", "name": "Name of the family" }, "id": "Unique identifier for the sponsorship", "is_subscriber": "Whether this person is the subscriber", "type": "Type of sponsorship (e.g., employee, spouse, dependent)" }, "suffix": "Patient's name suffix", "terms_accepted": "Whether the patient accepted the terms of service", "terms_accepted_at": "Timestamp when the patient accepted the terms of service", "updated_at": "Timestamp when the patient record was last updated", "uses_tobacco": "Whether the patient uses tobacco" }, "period_rate_in_cents": "Rate per billing period in cents for this patient", "revenue_in_cents": "Revenue in cents for this patient", "start_date": "Start date for this patient on the membership", "uses_tobacco": "Whether the patient uses tobacco" }, "next_bill_date": "Date of the next bill", "owner": { "account": { "name": "Name on the billing account", "past_due_in_cents": "Amount past due in cents" }, "address_city": "City of the patient's address", "address_country": "Country of the patient's address", "address_line1": "First line of the patient's address", "address_line2": "Second line of the patient's address", "address_state": "State of the patient's address", "address_zip": "ZIP code of the patient's address", "age": "Age of the patient", "chosen_first_name": "Patient's chosen or preferred first name", "chosen_last_name": "Patient's chosen or preferred last name", "chosen_middle_name": "Patient's chosen or preferred middle name", "chosen_suffix": "Patient's chosen or preferred suffix", "chosen_title": "Patient's chosen or preferred title", "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "created_at": "Timestamp when the patient record was created", "dob": "Patient's date of birth", "electronic_communication_consent_accepted": "Whether the patient accepted electronic communication consent", "electronic_communication_consent_accepted_at": "Timestamp when the patient accepted electronic communication consent", "email": "Patient's email address", "external_link_id": "External link identifier for the patient", "external_records": { "external_id": "External identifier in the source system", "source": "Source system of the external record" }, "first_name": "Patient's first name", "gender": "Patient's gender", "gender_identity": "Patient's gender identity", "gender_other": "Patient's gender if not covered by standard options", "health_insurance_group_id": "Health insurance group ID", "health_insurance_member_id": "Health insurance member ID", "health_insurance_payer_id": "Health insurance payer ID", "health_insurance_payer_name": "Health insurance payer name", "hipaa_authorization_accepted": "Whether the patient accepted the HIPAA authorization", "hipaa_authorization_accepted_at": "Timestamp when the patient accepted the HIPAA authorization", "id": "Unique identifier for the patient", "import_id": "Import batch identifier", "import_source": "Source system of the import", "joined_practice_date": "Date the patient joined the practice", "known_practice": { "id": "Unique identifier for the known practice", "name": "Name of the known practice" }, "last_name": "Patient's last name", "lead_source": { "created_at": "Timestamp when the lead source was created", "id": "Unique identifier for the lead source", "name": "Name of the lead source", "updated_at": "Timestamp when the lead source was last updated" }, "lead_source_other": "Description of the lead source when 'Other' is selected", "location": { "address_city": "City of the location's address", "address_country": "Country of the location's address", "address_latitude": "Latitude of the location's address", "address_line1": "First line of the location's address", "address_line2": "Second line of the location's address", "address_longitude": "Longitude of the location's address", "address_state": "State of the location's address", "address_zip": "ZIP code of the location's address", "distance": "Distance from the patient to the location", "id": "Unique identifier for the location", "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "name": "Name of the location", "phone_number": "Phone number of the location", "virtual": "Whether the location is virtual" }, "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "master_record_sponsor": "Master record sponsor identifier", "membership_status": "Current membership status of the patient", "memberships": { "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "division": { "id": "Unique identifier for the division", "name": "Name of the division" }, "end_date": "End date of the membership", "enrollment_requested_on": "Date when enrollment was requested", "enrollment_status": "Current enrollment status", "member_type": "Type of membership (e.g., employee, spouse, dependent)", "payer": { "id": "Unique identifier for the payer", "name": "Name of the payer" }, "plan": { "id": "Unique identifier for the plan", "name": "Name of the plan" }, "start_date": "Start date of the membership", "status": "Current status of the membership", "uses_tobacco": "Whether the member uses tobacco" }, "merged_into": { "id": "Unique identifier of the patient record this was merged into", "name": "Name of the patient record this was merged into" }, "middle_name": "Patient's middle name", "name": "Patient's full name", "patient_agreement_accepted": "Whether the patient accepted the patient agreement", "patient_agreement_accepted_at": "Timestamp when the patient accepted the patient agreement", "phones": { "number": "Phone number", "type": "Type of phone number (e.g., mobile, home, work)" }, "practitioner": { "accepts_enrollments_from_employer": "Whether the practitioner accepts enrollments from employers", "accepts_enrollments_from_retail": "Whether the practitioner accepts enrollments from retail", "bio": "Practitioner's biography", "created_at": "Timestamp when the practitioner record was created", "education": "Practitioner's education background", "email": "Practitioner's email address", "gender": "Practitioner's gender", "gender_other": "Practitioner's gender if not covered by standard options", "id": "Unique identifier for the practitioner", "integration_record_id": "Integration record identifier for the practitioner", "locations": { "address_city": "City of the location's address", "address_country": "Country of the location's address", "address_latitude": "Latitude of the location's address", "address_line1": "First line of the location's address", "address_line2": "Second line of the location's address", "address_longitude": "Longitude of the location's address", "address_state": "State of the location's address", "address_zip": "ZIP code of the location's address", "distance": "Distance from the patient to the location", "id": "Unique identifier for the location", "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "name": "Name of the location", "phone_number": "Phone number of the location", "virtual": "Whether the location is virtual" }, "max_patient_age": "Maximum patient age the practitioner serves", "min_patient_age": "Minimum patient age the practitioner serves", "name": "Practitioner's full name", "npi": { "id": "NPI number", "name": "Name associated with the NPI" }, "online_signup_visibility": "Practitioner's visibility for online signup", "panel_size": "Current number of patients in the practitioner's panel", "panel_size_limit": "Maximum number of patients allowed in the practitioner's panel", "photo_url": "URL to the practitioner's photo", "specialties": { "id": "Unique identifier for the specialty", "name": "Name of the specialty" }, "updated_at": "Timestamp when the practitioner record was last updated" }, "practitioner_group": { "created_at": "Timestamp when the practitioner group was created", "id": "Unique identifier for the practitioner group", "integration_record_id": "Integration record identifier for the practitioner group", "name": "Name of the practitioner group", "updated_at": "Timestamp when the practitioner group was last updated" }, "preferred_language": "Patient's preferred language", "pronouns": "Patient's preferred pronouns", "provider_web_link": "URL link to the patient's profile in the provider portal", "sex": "Patient's biological sex", "sponsorships": { "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "external_id": "External identifier from another system", "family": { "id": "Unique identifier for the family", "name": "Name of the family" }, "id": "Unique identifier for the sponsorship", "is_subscriber": "Whether this person is the subscriber", "type": "Type of sponsorship (e.g., employee, spouse, dependent)" }, "suffix": "Patient's name suffix", "terms_accepted": "Whether the patient accepted the terms of service", "terms_accepted_at": "Timestamp when the patient accepted the terms of service", "updated_at": "Timestamp when the patient record was last updated", "uses_tobacco": "Whether the patient uses tobacco" }, "period_in_months": "Billing period length in months", "period_rate_in_cents": "Rate per billing period in cents", "plan": { "id": "Unique identifier for the plan", "name": "Name of the plan", "plan_type": "Type of plan (e.g., retail, employer)" }, "rate_in_cents": "Rate in cents for the membership", "source_status": "Status from the source system", "sponsorship": { "company": { "id": "Unique identifier for the sponsor company", "name": "Name of the sponsor company" }, "id": "Unique identifier for the sponsorship" }, "start_date": "Start date of the membership", "status": "Current status of the membership", "upcoming_bills": { "amount_in_cents": "Total amount of the upcoming bill in cents", "charges_amount_in_cents": "Charges amount in cents", "coupon_discount_in_cents": "Coupon discount amount in cents", "coupon_discount_months": "Number of months the coupon discount applies", "coupon_percent_off": "Percentage off from the coupon", "customer_invoice": { "id": "Unique identifier for the invoice" }, "date": "Date of the upcoming bill", "end_date": "End date of the billing period", "list_price_in_cents": "List price in cents", "membership_amount_in_cents": "Membership amount in cents", "period_in_months": "Billing period length in months", "rate_in_cents": "Rate in cents", "registration_fee_in_cents": "Registration fee in cents", "start_date": "Start date of the billing period" }, "updated_at": "Timestamp when the membership was last updated"}
Events
Triggering Webhook Types
The following event types are associated with the Membership event payload from Hint Health.
{ "bill_date": "Date when the membership is billed", "billed_through_date": "Date through which the membership has been billed", "billing_start_date": "Date when billing started for the membership", "bills_at_end_of_period": "Whether the membership bills at the end of the billing period", "contract_expiration_action": "Action taken when the contract expires", "contract_expires": "Whether the membership contract expires", "contract_period_in_months": "Length of the contract period in months", "coupon": { "amount_off_in_cents": "Amount off in cents", "apply_to_each_patient": "Whether the coupon applies to each patient on the membership", "code": "Coupon code", "created_at": "Timestamp when the coupon was created", "description": "Description of the coupon", "duration_in_months": "Duration of the coupon in months", "id": "Unique identifier for the coupon", "is_archived": "Whether the coupon is archived", "is_redeemable": "Whether the coupon is redeemable", "percent_off": "Percentage off provided by the coupon", "redeemable_from": "Start date from which the coupon is redeemable", "redeemable_until": "End date until which the coupon is redeemable", "updated_at": "Timestamp when the coupon was last updated" }, "created_at": "Timestamp when the membership was created", "end_date": "End date of the membership", "enrollment_status": "Current enrollment status of the membership", "fixed_period_rate_in_cents": "Fixed period rate in cents", "fixed_registration_fee_in_cents": "Fixed registration fee in cents", "group_code": "Group code associated with the membership", "id": "Unique identifier for the membership", "is_confirmed": "Whether the membership is confirmed", "is_current": "Whether the membership is currently active", "is_processing": "Whether the membership is being processed", "is_restartable": "Whether the membership can be restarted", "list_price_in_cents": "List price of the membership in cents", "membership_patients": { "end_date": "End date for this patient on the membership", "fixed_period_rate_in_cents": "Fixed period rate in cents for this patient", "id": "Unique identifier for the membership patient", "list_price_in_cents": "List price in cents for this patient", "member_type": "Type of member (e.g., primary, spouse, dependent)", "patient": { "account": { "name": "Name on the billing account", "past_due_in_cents": "Amount past due in cents" }, "address_city": "City of the patient's address", "address_country": "Country of the patient's address", "address_line1": "First line of the patient's address", "address_line2": "Second line of the patient's address", "address_state": "State of the patient's address", "address_zip": "ZIP code of the patient's address", "age": "Age of the patient", "chosen_first_name": "Patient's chosen or preferred first name", "chosen_last_name": "Patient's chosen or preferred last name", "chosen_middle_name": "Patient's chosen or preferred middle name", "chosen_suffix": "Patient's chosen or preferred suffix", "chosen_title": "Patient's chosen or preferred title", "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "created_at": "Timestamp when the patient record was created", "dob": "Patient's date of birth", "electronic_communication_consent_accepted": "Whether the patient accepted electronic communication consent", "electronic_communication_consent_accepted_at": "Timestamp when the patient accepted electronic communication consent", "email": "Patient's email address", "external_link_id": "External link identifier for the patient", "external_records": { "external_id": "External identifier in the source system", "source": "Source system of the external record" }, "first_name": "Patient's first name", "gender": "Patient's gender", "gender_identity": "Patient's gender identity", "gender_other": "Patient's gender if not covered by standard options", "health_insurance_group_id": "Health insurance group ID", "health_insurance_member_id": "Health insurance member ID", "health_insurance_payer_id": "Health insurance payer ID", "health_insurance_payer_name": "Health insurance payer name", "hipaa_authorization_accepted": "Whether the patient accepted the HIPAA authorization", "hipaa_authorization_accepted_at": "Timestamp when the patient accepted the HIPAA authorization", "id": "Unique identifier for the patient", "import_id": "Import batch identifier", "import_source": "Source system of the import", "joined_practice_date": "Date the patient joined the practice", "known_practice": { "id": "Unique identifier for the known practice", "name": "Name of the known practice" }, "last_name": "Patient's last name", "lead_source": { "created_at": "Timestamp when the lead source was created", "id": "Unique identifier for the lead source", "name": "Name of the lead source", "updated_at": "Timestamp when the lead source was last updated" }, "lead_source_other": "Description of the lead source when 'Other' is selected", "location": { "address_city": "City of the location's address", "address_country": "Country of the location's address", "address_latitude": "Latitude of the location's address", "address_line1": "First line of the location's address", "address_line2": "Second line of the location's address", "address_longitude": "Longitude of the location's address", "address_state": "State of the location's address", "address_zip": "ZIP code of the location's address", "distance": "Distance from the patient to the location", "id": "Unique identifier for the location", "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "name": "Name of the location", "phone_number": "Phone number of the location", "virtual": "Whether the location is virtual" }, "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "master_record_sponsor": "Master record sponsor identifier", "membership_status": "Current membership status of the patient", "memberships": { "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "division": { "id": "Unique identifier for the division", "name": "Name of the division" }, "end_date": "End date of the membership", "enrollment_requested_on": "Date when enrollment was requested", "enrollment_status": "Current enrollment status", "member_type": "Type of membership (e.g., employee, spouse, dependent)", "payer": { "id": "Unique identifier for the payer", "name": "Name of the payer" }, "plan": { "id": "Unique identifier for the plan", "name": "Name of the plan" }, "start_date": "Start date of the membership", "status": "Current status of the membership", "uses_tobacco": "Whether the member uses tobacco" }, "merged_into": { "id": "Unique identifier of the patient record this was merged into", "name": "Name of the patient record this was merged into" }, "middle_name": "Patient's middle name", "name": "Patient's full name", "patient_agreement_accepted": "Whether the patient accepted the patient agreement", "patient_agreement_accepted_at": "Timestamp when the patient accepted the patient agreement", "phones": { "number": "Phone number", "type": "Type of phone number (e.g., mobile, home, work)" }, "practitioner": { "accepts_enrollments_from_employer": "Whether the practitioner accepts enrollments from employers", "accepts_enrollments_from_retail": "Whether the practitioner accepts enrollments from retail", "bio": "Practitioner's biography", "created_at": "Timestamp when the practitioner record was created", "education": "Practitioner's education background", "email": "Practitioner's email address", "gender": "Practitioner's gender", "gender_other": "Practitioner's gender if not covered by standard options", "id": "Unique identifier for the practitioner", "integration_record_id": "Integration record identifier for the practitioner", "locations": { "address_city": "City of the location's address", "address_country": "Country of the location's address", "address_latitude": "Latitude of the location's address", "address_line1": "First line of the location's address", "address_line2": "Second line of the location's address", "address_longitude": "Longitude of the location's address", "address_state": "State of the location's address", "address_zip": "ZIP code of the location's address", "distance": "Distance from the patient to the location", "id": "Unique identifier for the location", "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "name": "Name of the location", "phone_number": "Phone number of the location", "virtual": "Whether the location is virtual" }, "max_patient_age": "Maximum patient age the practitioner serves", "min_patient_age": "Minimum patient age the practitioner serves", "name": "Practitioner's full name", "npi": { "id": "NPI number", "name": "Name associated with the NPI" }, "online_signup_visibility": "Practitioner's visibility for online signup", "panel_size": "Current number of patients in the practitioner's panel", "panel_size_limit": "Maximum number of patients allowed in the practitioner's panel", "photo_url": "URL to the practitioner's photo", "specialties": { "id": "Unique identifier for the specialty", "name": "Name of the specialty" }, "updated_at": "Timestamp when the practitioner record was last updated" }, "practitioner_group": { "created_at": "Timestamp when the practitioner group was created", "id": "Unique identifier for the practitioner group", "integration_record_id": "Integration record identifier for the practitioner group", "name": "Name of the practitioner group", "updated_at": "Timestamp when the practitioner group was last updated" }, "preferred_language": "Patient's preferred language", "pronouns": "Patient's preferred pronouns", "provider_web_link": "URL link to the patient's profile in the provider portal", "sex": "Patient's biological sex", "sponsorships": { "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "external_id": "External identifier from another system", "family": { "id": "Unique identifier for the family", "name": "Name of the family" }, "id": "Unique identifier for the sponsorship", "is_subscriber": "Whether this person is the subscriber", "type": "Type of sponsorship (e.g., employee, spouse, dependent)" }, "suffix": "Patient's name suffix", "terms_accepted": "Whether the patient accepted the terms of service", "terms_accepted_at": "Timestamp when the patient accepted the terms of service", "updated_at": "Timestamp when the patient record was last updated", "uses_tobacco": "Whether the patient uses tobacco" }, "period_rate_in_cents": "Rate per billing period in cents for this patient", "revenue_in_cents": "Revenue in cents for this patient", "start_date": "Start date for this patient on the membership", "uses_tobacco": "Whether the patient uses tobacco" }, "next_bill_date": "Date of the next bill", "owner": { "account": { "name": "Name on the billing account", "past_due_in_cents": "Amount past due in cents" }, "address_city": "City of the patient's address", "address_country": "Country of the patient's address", "address_line1": "First line of the patient's address", "address_line2": "Second line of the patient's address", "address_state": "State of the patient's address", "address_zip": "ZIP code of the patient's address", "age": "Age of the patient", "chosen_first_name": "Patient's chosen or preferred first name", "chosen_last_name": "Patient's chosen or preferred last name", "chosen_middle_name": "Patient's chosen or preferred middle name", "chosen_suffix": "Patient's chosen or preferred suffix", "chosen_title": "Patient's chosen or preferred title", "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "created_at": "Timestamp when the patient record was created", "dob": "Patient's date of birth", "electronic_communication_consent_accepted": "Whether the patient accepted electronic communication consent", "electronic_communication_consent_accepted_at": "Timestamp when the patient accepted electronic communication consent", "email": "Patient's email address", "external_link_id": "External link identifier for the patient", "external_records": { "external_id": "External identifier in the source system", "source": "Source system of the external record" }, "first_name": "Patient's first name", "gender": "Patient's gender", "gender_identity": "Patient's gender identity", "gender_other": "Patient's gender if not covered by standard options", "health_insurance_group_id": "Health insurance group ID", "health_insurance_member_id": "Health insurance member ID", "health_insurance_payer_id": "Health insurance payer ID", "health_insurance_payer_name": "Health insurance payer name", "hipaa_authorization_accepted": "Whether the patient accepted the HIPAA authorization", "hipaa_authorization_accepted_at": "Timestamp when the patient accepted the HIPAA authorization", "id": "Unique identifier for the patient", "import_id": "Import batch identifier", "import_source": "Source system of the import", "joined_practice_date": "Date the patient joined the practice", "known_practice": { "id": "Unique identifier for the known practice", "name": "Name of the known practice" }, "last_name": "Patient's last name", "lead_source": { "created_at": "Timestamp when the lead source was created", "id": "Unique identifier for the lead source", "name": "Name of the lead source", "updated_at": "Timestamp when the lead source was last updated" }, "lead_source_other": "Description of the lead source when 'Other' is selected", "location": { "address_city": "City of the location's address", "address_country": "Country of the location's address", "address_latitude": "Latitude of the location's address", "address_line1": "First line of the location's address", "address_line2": "Second line of the location's address", "address_longitude": "Longitude of the location's address", "address_state": "State of the location's address", "address_zip": "ZIP code of the location's address", "distance": "Distance from the patient to the location", "id": "Unique identifier for the location", "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "name": "Name of the location", "phone_number": "Phone number of the location", "virtual": "Whether the location is virtual" }, "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "master_record_sponsor": "Master record sponsor identifier", "membership_status": "Current membership status of the patient", "memberships": { "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "division": { "id": "Unique identifier for the division", "name": "Name of the division" }, "end_date": "End date of the membership", "enrollment_requested_on": "Date when enrollment was requested", "enrollment_status": "Current enrollment status", "member_type": "Type of membership (e.g., employee, spouse, dependent)", "payer": { "id": "Unique identifier for the payer", "name": "Name of the payer" }, "plan": { "id": "Unique identifier for the plan", "name": "Name of the plan" }, "start_date": "Start date of the membership", "status": "Current status of the membership", "uses_tobacco": "Whether the member uses tobacco" }, "merged_into": { "id": "Unique identifier of the patient record this was merged into", "name": "Name of the patient record this was merged into" }, "middle_name": "Patient's middle name", "name": "Patient's full name", "patient_agreement_accepted": "Whether the patient accepted the patient agreement", "patient_agreement_accepted_at": "Timestamp when the patient accepted the patient agreement", "phones": { "number": "Phone number", "type": "Type of phone number (e.g., mobile, home, work)" }, "practitioner": { "accepts_enrollments_from_employer": "Whether the practitioner accepts enrollments from employers", "accepts_enrollments_from_retail": "Whether the practitioner accepts enrollments from retail", "bio": "Practitioner's biography", "created_at": "Timestamp when the practitioner record was created", "education": "Practitioner's education background", "email": "Practitioner's email address", "gender": "Practitioner's gender", "gender_other": "Practitioner's gender if not covered by standard options", "id": "Unique identifier for the practitioner", "integration_record_id": "Integration record identifier for the practitioner", "locations": { "address_city": "City of the location's address", "address_country": "Country of the location's address", "address_latitude": "Latitude of the location's address", "address_line1": "First line of the location's address", "address_line2": "Second line of the location's address", "address_longitude": "Longitude of the location's address", "address_state": "State of the location's address", "address_zip": "ZIP code of the location's address", "distance": "Distance from the patient to the location", "id": "Unique identifier for the location", "location_group": { "created_at": "Timestamp when the location group was created", "id": "Unique identifier for the location group", "integration_record_id": "Integration record identifier for the location group", "name": "Name of the location group", "updated_at": "Timestamp when the location group was last updated" }, "name": "Name of the location", "phone_number": "Phone number of the location", "virtual": "Whether the location is virtual" }, "max_patient_age": "Maximum patient age the practitioner serves", "min_patient_age": "Minimum patient age the practitioner serves", "name": "Practitioner's full name", "npi": { "id": "NPI number", "name": "Name associated with the NPI" }, "online_signup_visibility": "Practitioner's visibility for online signup", "panel_size": "Current number of patients in the practitioner's panel", "panel_size_limit": "Maximum number of patients allowed in the practitioner's panel", "photo_url": "URL to the practitioner's photo", "specialties": { "id": "Unique identifier for the specialty", "name": "Name of the specialty" }, "updated_at": "Timestamp when the practitioner record was last updated" }, "practitioner_group": { "created_at": "Timestamp when the practitioner group was created", "id": "Unique identifier for the practitioner group", "integration_record_id": "Integration record identifier for the practitioner group", "name": "Name of the practitioner group", "updated_at": "Timestamp when the practitioner group was last updated" }, "preferred_language": "Patient's preferred language", "pronouns": "Patient's preferred pronouns", "provider_web_link": "URL link to the patient's profile in the provider portal", "sex": "Patient's biological sex", "sponsorships": { "company": { "id": "Unique identifier for the company", "name": "Name of the company" }, "external_id": "External identifier from another system", "family": { "id": "Unique identifier for the family", "name": "Name of the family" }, "id": "Unique identifier for the sponsorship", "is_subscriber": "Whether this person is the subscriber", "type": "Type of sponsorship (e.g., employee, spouse, dependent)" }, "suffix": "Patient's name suffix", "terms_accepted": "Whether the patient accepted the terms of service", "terms_accepted_at": "Timestamp when the patient accepted the terms of service", "updated_at": "Timestamp when the patient record was last updated", "uses_tobacco": "Whether the patient uses tobacco" }, "period_in_months": "Billing period length in months", "period_rate_in_cents": "Rate per billing period in cents", "plan": { "id": "Unique identifier for the plan", "name": "Name of the plan", "plan_type": "Type of plan (e.g., retail, employer)" }, "rate_in_cents": "Rate in cents for the membership", "source_status": "Status from the source system", "sponsorship": { "company": { "id": "Unique identifier for the sponsor company", "name": "Name of the sponsor company" }, "id": "Unique identifier for the sponsorship" }, "start_date": "Start date of the membership", "status": "Current status of the membership", "upcoming_bills": { "amount_in_cents": "Total amount of the upcoming bill in cents", "charges_amount_in_cents": "Charges amount in cents", "coupon_discount_in_cents": "Coupon discount amount in cents", "coupon_discount_months": "Number of months the coupon discount applies", "coupon_percent_off": "Percentage off from the coupon", "customer_invoice": { "id": "Unique identifier for the invoice" }, "date": "Date of the upcoming bill", "end_date": "End date of the billing period", "list_price_in_cents": "List price in cents", "membership_amount_in_cents": "Membership amount in cents", "period_in_months": "Billing period length in months", "rate_in_cents": "Rate in cents", "registration_fee_in_cents": "Registration fee in cents", "start_date": "Start date of the billing period" }, "updated_at": "Timestamp when the membership was last updated"}
Payload Field Details
Event Payload
Hide fields
string
required
Unique identifier for the membership
CEL
id
Example
"mem-ab12C345DeF6"
values.v1.Date
Date when the membership is billed
CEL
bill_date
Example
null
values.v1.Date
Date through which the membership has been billed
CEL
billed_through_date
Example
null
values.v1.Date
Date when billing started for the membership
CEL
billing_start_date
Example
null
bool
Whether the membership bills at the end of the billing period
CEL
bills_at_end_of_period
Example
false
string
Action taken when the contract expires
CEL
contract_expiration_action
Example
"auto-renew"
bool
Whether the membership contract expires
CEL
contract_expires
Example
true
int64
Length of the contract period in months
CEL
contract_period_in_months
Example
12
timing.v1.Timestamp
Timestamp when the membership was created
CEL
created_at
Example
null
values.v1.Date
End date of the membership
CEL
end_date
Example
null
string
Current enrollment status of the membership
CEL
enrollment_status
Example
"active"
int64
Fixed period rate in cents
CEL
fixed_period_rate_in_cents
Example
6000
int64
Fixed registration fee in cents
CEL
fixed_registration_fee_in_cents
Example
2500
string
Group code associated with the membership
CEL
group_code
Example
"GRP-001"
bool
Whether the membership is confirmed
CEL
is_confirmed
Example
true
bool
Whether the membership is currently active
CEL
is_current
Example
true
bool
Whether the membership is being processed
CEL
is_processing
Example
false
bool
Whether the membership can be restarted
CEL
is_restartable
Example
false
int64
List price of the membership in cents
CEL
list_price_in_cents
Example
5000
values.v1.Date
Date of the next bill
CEL
next_bill_date
Example
null
int64
Billing period length in months
CEL
period_in_months
Example
1
int64
Rate per billing period in cents
CEL
period_rate_in_cents
Example
5000
int64
Rate in cents for the membership
CEL
rate_in_cents
Example
5000
string
Status from the source system
CEL
source_status
Example
"active"
values.v1.Date
Start date of the membership
CEL
start_date
Example
null
string
Current status of the membership
CEL
status
Example
"unpaid"
timing.v1.Timestamp
Timestamp when the membership was last updated
CEL
updated_at
Example
null
object
Coupon applied to the membership
CEL
coupon
Example
{"amount_off_in_cents": 1000,"apply_to_each_patient": true,"code": "SAVE20","created_at": null,"description": "20% off first 3 months","duration_in_months": 3,"id": "cpn-ab12C345DeF6","is_archived": false,"is_redeemable": true,"percent_off": 20,"redeemable_from": null,"redeemable_until": null,"updated_at": null}
string
Unique identifier for the coupon
CEL
coupon.id
Example
"cpn-ab12C345DeF6"
string
Coupon code
CEL
coupon.code
Example
"SAVE20"
string
Description of the coupon
CEL
coupon.description
Example
"20% off first 3 months"
int64
Amount off in cents
CEL
coupon.amount_off_in_cents
Example
1000
bool
Whether the coupon applies to each patient on the membership