Event list
Below is a list of the events sent by Capable Health.
Acuity Orders
Acuity Order Completed
{
"event_name": "Acuity Order Completed",
"event_type": "acuity_order",
"event_topic": "completed",
"patient_identity_id": "1d367d5d-c7a2-46af-ade9-c687ee624fda",
"payload": {
"total": 100,
"time": "2021-12-10 13:40:27",
"first_name": "Nate",
"last_name": "Test",
"phone": "(123) 456-7890",
"email": "[email protected]",
"notes": "",
"status": "paid",
"title": "PT subscription",
"products": [
{
"id": 1193825,
"name": "PT subscription",
"quantity": 1,
"total": 100
}
],
"order_id": "83300919",
"topic": "completed"
},
"time": 1668735459
}
Appointments
Appointment Canceled
{
"event_name": "Appointment Canceled",
"event_type": "appointment",
"event_topic": "canceled",
"patient_identity_id": "1d367d5d-c7a2-46af-ade9-c687ee624fda",
"payload": {
"id": 805108836,
"topic": "canceled",
"appointment_id": 805108836,
"start": "2022-05-31 10:15:00 -0400",
"end": "2022-05-31 10:45:00 -0400",
"appointment_type": "Virtual Initial Consultation",
"appointment_type_id": 29748772,
"calendar": "Dr Test",
"calendar_id": 6625762,
"location": "https://capablehealt-dev.daily.co/SmW2TwOmvBKOP4iLR09l?t=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyIjoiU21XMlR3T212QktPUDRpTFIwOWwiLCJkIjoiOWQwMjg0NGUtZTMyMy00Yzk1LTk4MmMtODZhNTZhZDczMzVlIiwiaWF0IjoxNjQ5Nzg0MjY3fQ.U-qK9SNTN_4u3WX9LOk5eNyK29I01o0kNmq5iW2hRR0",
"attendees": [
{
"id": "db95e992-bf0f-4786-b355-0df890348729",
"type": "Patient"
}
],
"metadata": {
}
},
"time": 1668735459
}
Appointment Rescheduled
{
"event_name": "Appointment Rescheduled",
"event_type": "appointment",
"event_topic": "rescheduled",
"patient_identity_id": "1d367d5d-c7a2-46af-ade9-c687ee624fda",
"payload": {
"id": 805108836,
"topic": "rescheduled",
"appointment_id": 805108836,
"start": "2022-05-31 10:15:00 -0400",
"end": "2022-05-31 10:45:00 -0400",
"appointment_type": "Virtual Initial Consultation",
"appointment_type_id": 29748772,
"calendar": "Dr Test",
"calendar_id": 6625762,
"location": "https://capablehealt-dev.daily.co/SmW2TwOmvBKOP4iLR09l?t=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyIjoiU21XMlR3T212QktPUDRpTFIwOWwiLCJkIjoiOWQwMjg0NGUtZTMyMy00Yzk1LTk4MmMtODZhNTZhZDczMzVlIiwiaWF0IjoxNjQ5Nzg0MjY3fQ.U-qK9SNTN_4u3WX9LOk5eNyK29I01o0kNmq5iW2hRR0",
"attendees": [
{
"id": "db95e992-bf0f-4786-b355-0df890348729",
"type": "Patient"
}
],
"metadata": {
}
},
"time": 1668735459
}
Appointment Scheduled
{
"event_name": "Appointment Scheduled",
"event_type": "appointment",
"event_topic": "scheduled",
"patient_identity_id": "1d367d5d-c7a2-46af-ade9-c687ee624fda",
"payload": {
"id": 805108836,
"topic": "scheduled",
"appointment_id": 805108836,
"start": "2022-10-22 16:30:00 -0400",
"end": "2022-10-22 17:00:00 -0400",
"appointment_type": "Virtual Initial Consultation",
"appointment_type_id": 29748772,
"calendar": "Dr. No Appointments",
"calendar_id": 6778315,
"location": "",
"attendees": [
{
"id": "db95e992-bf0f-4786-b355-0df890348729",
"type": "Patient"
}
],
"metadata": {
"this": "is valid json"
}
},
"time": 1668735459
}
Care Plans
Care Plan Create
{
"event_name": "Care Plan Create",
"event_type": "care_plan",
"event_topic": "create",
"patient_identity_id": "9065b364-79d3-4189-abc3-0432242d9fc1",
"payload": {
"id": "b29aa120-2dc2-4727-af7c-e038cec760d2",
"name": "Fahey LLC",
"care_plan_template_id": "846a3e36-0f25-4269-a338-27e824207551",
"description": null,
"status": "active",
"created_at": "2022-11-18T01:37:38.552Z",
"updated_at": "2022-11-18T01:37:38.552Z",
"tag_list": [
],
"cms_entry_id": null,
"topic": "create",
"version": "1.0"
},
"time": 1668735458
}
Care Plan Update
{
"event_name": "Care Plan Update",
"event_type": "care_plan",
"event_topic": "update",
"patient_identity_id": "9065b364-79d3-4189-abc3-0432242d9fc1",
"payload": {
"id": "b29aa120-2dc2-4727-af7c-e038cec760d2",
"name": "Fahey LLC",
"care_plan_template_id": "846a3e36-0f25-4269-a338-27e824207551",
"description": null,
"status": "completed",
"created_at": "2022-11-18T01:37:38.552Z",
"updated_at": "2022-11-18T01:37:38.562Z",
"tag_list": [
],
"cms_entry_id": null,
"before_update": {
"id": "b29aa120-2dc2-4727-af7c-e038cec760d2",
"name": "Fahey LLC",
"care_plan_template_id": "846a3e36-0f25-4269-a338-27e824207551",
"description": null,
"status": "active",
"created_at": null,
"updated_at": "2022-11-18T01:37:38.552Z",
"tag_list": [
],
"cms_entry_id": null
},
"topic": "update",
"version": "1.0"
},
"time": 1668735458
}
Encounters
The following events are related to Encounters. These events relate both to Encounters created in the Capable portal and Patient Cases created in MD Integrations.
Provider status
These are the possible provider_status
values for Encounter events: created
, assigned
, waiting
, transferred
, processing
, completed
, cancelled
, and need_support
.
If an Encounter created by an MDI Case progresses as expected, Encounter Update
events will be triggered with the following provider_status
values: created
, assigned
, processing
, completed
.
Provider topic
These are the possible provider_topic
values for Encounter events: capable_encounter
, encounter_order
, medication_order
, external_encounter
.
capable_encounter
: Indicates an Encounter created by a Practitioner in the Capable portal.encounter_order
: Indicates an Encounter initiated by an Order for a doctor consultation.medication_order
: Indicates an Encounter initiated by an Order that includes medications.
Encounter Create
{
"event_name": "Encounter Create",
"event_type": "encounter",
"event_topic": "create",
"patient_identity_id": "1bbf779e-e1bc-4e3f-a448-f253fbb27f0c",
"payload": {
"id": "9369650a-6712-4e8e-829e-8166384f5fa6",
"patient_id": "00ff12e2-e340-4a3e-8e77-abe1cd41e5af",
"practitioner_id": "78f9d5ff-ab22-4a63-9d46-d22ee2bc7b45",
"start_on": "2022-11-18T01:37:38.668Z",
"end_on": "2022-11-18T02:50:04.668Z",
"source": "in_person",
"provider_status": "created",
"provider_name": null,
"provider_id": null,
"provider_topic": "capable_encounter",
"prescription_ids": [
],
"created_at": "2022-11-18T01:37:38.668Z",
"updated_at": "2022-11-18T01:37:38.668Z",
"notes": [
],
"topic": "create",
"version": "1.0"
},
"time": 1668735458
}
Encounter Update
{
"event_name": "Encounter Update",
"event_type": "encounter",
"event_topic": "update",
"patient_identity_id": "1bbf779e-e1bc-4e3f-a448-f253fbb27f0c",
"payload": {
"id": "9369650a-6712-4e8e-829e-8166384f5fa6",
"patient_id": "00ff12e2-e340-4a3e-8e77-abe1cd41e5af",
"practitioner_id": "78f9d5ff-ab22-4a63-9d46-d22ee2bc7b45",
"start_on": "2022-11-18T01:37:38.668Z",
"end_on": "2022-11-18T02:50:04.668Z",
"source": "in_person",
"provider_status": "created",
"provider_name": null,
"provider_id": null,
"provider_topic": "capable_encounter",
"prescription_ids": [
],
"created_at": "2022-11-18T01:37:38.668Z",
"updated_at": "2022-11-18T01:37:38.668Z",
"notes": [
],
"before_update": {
"id": null,
"patient_id": null,
"practitioner_id": null,
"start_on": null,
"end_on": null,
"source": null,
"provider_status": "created",
"provider_name": null,
"provider_id": null,
"provider_topic": "capable_encounter",
"prescription_ids": [
],
"created_at": null,
"updated_at": null,
"notes": [
]
},
"topic": "update",
"version": "1.0"
},
"time": 1668735458
}
Goals
Goal Create
{
"event_name": "Goal Create",
"event_type": "goal",
"event_topic": "create",
"patient_identity_id": "9aa041d7-a923-44eb-b178-a193aa027c01",
"payload": {
"id": "eb537756-767a-46a2-b2c6-6af48549b111",
"name": "Express Coffee",
"description": null,
"goal_template_id": "d1271daf-9ed6-44f0-85b1-5185999ea311",
"achievement_status": "in_progress",
"start_on": null,
"due_on": null,
"care_plan_id": "bc75ee93-4cae-4094-bee9-3160608bfaae",
"tag_list": [
],
"cms_entry_id": null,
"created_at": "2022-11-18T01:37:36.902Z",
"updated_at": "2022-11-18T01:37:36.902Z",
"care_plan_template_id": "aad8bf31-7c4f-44af-a005-697e95bc4994",
"topic": "create",
"version": "1.0"
},
"time": 1668735456
}
Goal Update
{
"event_name": "Goal Update",
"event_type": "goal",
"event_topic": "update",
"patient_identity_id": "9aa041d7-a923-44eb-b178-a193aa027c01",
"payload": {
"id": "eb537756-767a-46a2-b2c6-6af48549b111",
"name": "Express Coffee",
"description": null,
"goal_template_id": "d1271daf-9ed6-44f0-85b1-5185999ea311",
"achievement_status": "not_achieved",
"start_on": null,
"due_on": null,
"care_plan_id": "bc75ee93-4cae-4094-bee9-3160608bfaae",
"tag_list": [
],
"cms_entry_id": null,
"created_at": "2022-11-18T01:37:36.902Z",
"updated_at": "2022-11-18T01:37:36.927Z",
"care_plan_template_id": "aad8bf31-7c4f-44af-a005-697e95bc4994",
"before_update": {
"id": "eb537756-767a-46a2-b2c6-6af48549b111",
"name": "Express Coffee",
"description": null,
"goal_template_id": "d1271daf-9ed6-44f0-85b1-5185999ea311",
"achievement_status": "in_progress",
"start_on": null,
"due_on": null,
"care_plan_id": "bc75ee93-4cae-4094-bee9-3160608bfaae",
"tag_list": [
],
"cms_entry_id": null,
"created_at": null,
"updated_at": "2022-11-18T01:37:36.902Z",
"care_plan_template_id": "aad8bf31-7c4f-44af-a005-697e95bc4994"
},
"topic": "update",
"version": "1.0"
},
"time": 1668735456
}
Lab Test Orders
The following events are related to Lab Test Orders. They are triggered by analogous events sent to Capable Health by a lab test vendor. They will only be sent if you have set up an account with a lab test vendor and create Lab Test Orders through Capable Health.
event_name: "Lab Test Order Create"
, order_status: "draft"
event_name: "Lab Test Order Update"
, order_status: "order_placed"
event_name: "Lab Test Order Update"
, order_status: "shipped_to_patient"
event_name: "Lab Test Order Update"
, order_status: "delivered_to_patient"
event_name: "Lab Test Order Update"
, order_status: "shipped_to_lab"
event_name: "Lab Test Order Update"
, order_status: "delivered_to_lab"
event_name: "Lab Test Order Update"
, order_status: "results_ready"
Alternatively, you could have some error status: on_hold
, cancelled
In that case, you should refer to the order#status_details property to know more
Lab Test Order Create
{
"event_name": "Lab Test Order Create",
"event_type": "lab_test_order",
"event_topic": "create",
"patient_identity_id": "7dd62bd1-164c-458a-84ad-4fa832f240dd",
"payload": {
"id": "920cfc7d-6f67-48ad-ae0b-8919f3f32ca5",
"order_status": null,
"patient_id": "b2c890bf-df1c-4d0d-84f1-dad8de86af00",
"patient_lab_tests": [
{
"id": "20a4df07-294b-4477-9859-f4874f2b83a5",
"product_id": "bb8623e1-37c3-4861-af75-234bd3f43b77",
"lab_test_order_id": "920cfc7d-6f67-48ad-ae0b-8919f3f32ca5",
"provider_product_id": "920bf944-d766-49bc-91fb-adbe514187ae",
"provider_product_type": "lab_test",
"created_at": "2022-11-18T01:37:37.143Z",
"updated_at": "2022-11-18T01:37:37.143Z"
}
],
"provider_order_id": null,
"created_at": "2022-11-18T01:37:37.138Z",
"updated_at": "2022-11-18T01:37:37.138Z",
"observation_ids": [
],
"activated": false,
"carrier_service": null,
"tracking_number": null,
"shipping_tracking_url": null,
"patient_to_lab_carrier_service": null,
"patient_to_lab_tracking_number": null,
"patient_to_lab_shipping_tracking_url": null,
"status_details": null,
"topic": "create",
"version": "1.0"
},
"time": 1668735457
}
Lab Test Order Update
{
"event_name": "Lab Test Order Update",
"event_type": "lab_test_order",
"event_topic": "update",
"patient_identity_id": "7dd62bd1-164c-458a-84ad-4fa832f240dd",
"payload": {
"id": "920cfc7d-6f67-48ad-ae0b-8919f3f32ca5",
"order_status": null,
"patient_id": "b2c890bf-df1c-4d0d-84f1-dad8de86af00",
"patient_lab_tests": [
{
"id": "20a4df07-294b-4477-9859-f4874f2b83a5",
"product_id": "bb8623e1-37c3-4861-af75-234bd3f43b77",
"lab_test_order_id": "920cfc7d-6f67-48ad-ae0b-8919f3f32ca5",
"provider_product_id": "920bf944-d766-49bc-91fb-adbe514187ae",
"provider_product_type": "lab_test",
"created_at": "2022-11-18T01:37:37.143Z",
"updated_at": "2022-11-18T01:37:37.143Z"
}
],
"provider_order_id": null,
"created_at": "2022-11-18T01:37:37.138Z",
"updated_at": "2022-11-18T01:37:37.138Z",
"observation_ids": [
],
"activated": false,
"carrier_service": null,
"tracking_number": null,
"shipping_tracking_url": null,
"patient_to_lab_carrier_service": null,
"patient_to_lab_tracking_number": null,
"patient_to_lab_shipping_tracking_url": null,
"status_details": null,
"before_update": {
"id": null,
"order_status": null,
"patient_id": null,
"patient_lab_tests": [
],
"provider_order_id": null,
"created_at": null,
"updated_at": null,
"observation_ids": [
],
"activated": false,
"carrier_service": null,
"tracking_number": null,
"shipping_tracking_url": null,
"patient_to_lab_carrier_service": null,
"patient_to_lab_tracking_number": null,
"patient_to_lab_shipping_tracking_url": null,
"status_details": null
},
"topic": "update",
"version": "1.0"
},
"time": 1668735457
}
MDI Patients
MDI Patient Update
{
"event_name": "MDI Patient Update",
"event_type": "mdi_patient",
"event_topic": "update",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
},
"time": 1668735457
}
Medication Cases
The following events are related to Patient Cases. They are triggered by analogous events sent to Capable Health by MD Integrations. They will only be sent if you have set up an account with MDI and create Patient Cases through Capable Health.
These are the possible statuses of Medication Cases:
- Assigned: Indicates a Case is ready to be worked by the assigned clinician.
- Cancelled: A Case goes to cancelled when manually set by the clinician or support.
- Completed: A Case is completed when all the Case prescriptions are created on DoseSpot and are automatically sent to the pharmacies, or moved manually without prescriptions.
- Created: Indicates that a Case has been created.
- Processing: Indicates that a Case has been submitted to DoseSpot and is waiting for confirmation.
- Transferred: The MDI clinician transferred the case to support.
- Waiting: Case is still assigned and waiting for a response from the Patient (no staff or clinician action required).
Medication Case Assigned
{
"event_name": "Medication Case Assigned",
"event_type": "medication_case",
"event_topic": "assigned",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"case_id": "7ec918df-983d-434e-88f1-14b46232673b"
},
"time": 1668735457
}
Medication Case Canceled
{
"event_name": "Medication Case Canceled",
"event_type": "medication_case",
"event_topic": "canceled",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"case_id": "b52dd9b3-7410-4749-ae61-c2311970ca8d"
},
"time": 1668735457
}
Medication Case Completed
{
"event_name": "Medication Case Completed",
"event_type": "medication_case",
"event_topic": "completed",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"case_id": "124cbb8b-8599-4f6c-b8d4-81d6c7622765"
},
"time": 1668735457
}
Medication Case Created
{
"event_name": "Medication Case Created",
"event_type": "medication_case",
"event_topic": "created",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"prioritized_at": null,
"prioritized_reason": null,
"created_at": "2021-10-14T16:57:49.000000Z",
"case_type": "follow-up",
"is_sync": false,
"metadata": null,
"case_id": "f4db87c8-93e0-4581-9d7e-bdda348909ab",
"patient": {
"first_name": "Darth",
"last_name": "Vader",
"email": "[email protected]",
"date_of_birth": "1983-10-17",
"gender": 1,
"phone_number": "(816) 679-2211",
"phone_type": "2",
"active": true,
"weight": null,
"height": null,
"dosespot_sync_status": "success",
"current_medications": "Prilosec",
"allergies": null,
"pregnancy": true,
"metadata": null,
"patient_id": "16175715-bc7a-463c-81ac-8bd506022c3d",
"gender_label": "Male",
"driver_license": null,
"address": {
"address": "1 swamprat rd",
"zip_code": "40207",
"city_name": "Lousiville",
"address2": null,
"address_id": "74029344-d2e9-41b1-b642-2979e4187526",
"state": {
"name": "Kentucky",
"abbreviation": "KY",
"state_id": "79e8cd04-f6bd-4732-8b97-a83748af5ea9"
}
}
},
"partner": {
"name": "Get Cleared",
"has_messaging_capability": true,
"has_support_capability": true,
"support_email": null,
"partner_id": "23060d80-bda0-4256-a823-9e1bd0fdc152"
},
"case_status": {
"name": "assigned",
"reason": null,
"updated_at": "2021-10-14T16:57:50.000000Z"
},
"case_assignment": {
"reason": "Initial assignment.",
"created_at": "2021-10-14T16:57:50.000000Z",
"case_assignment_id": "e958de2b-1def-49dc-8834-90fb56d96a2f",
"clinician": {
"specialty": "Staging Clinician",
"clinician_id": "fafc3211-ffb1-4a40-99d5-02c52c72da3c",
"full_name": "Get Cleared Staging Clinician",
"photo": null
}
},
"topic": "create",
"version": "1.0"
},
"time": 1668735457
}
Medication Case Message
{
"event_name": "Medication Case Message",
"event_type": "medication_case",
"event_topic": "message",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"case_id": "13f769c9-b735-4e5e-a1b0-466d98a2a997",
"case_message_id": "880fa324-e298-4ccd-8ae8-049b7094c4f5"
},
"time": 1668735457
}
Medication Case Processing
{
"event_name": "Medication Case Processing",
"event_type": "medication_case",
"event_topic": "processing",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"case_id": "dc6d1c16-1f29-4d35-a11a-2972605d9375"
},
"time": 1668735457
}
Medication Case Submitted
{
"event_name": "Medication Case Submitted",
"event_type": "medication_case",
"event_topic": "submitted",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"case_id": "085b2bec-3c08-4680-b48c-401dd5ea1e88",
"prescriptions": [
{
"dosespot_prescription_id": null,
"refills": 2,
"quantity": 99,
"days_supply": 30,
"directions": "Take one at the morning and another before bed...",
"dosespot_prescription_sync_status": "pending",
"dosespot_sent_pharmacy_sync_status": "pending",
"no_substitutions": true,
"pharmacy_notes": "This medication might not be suitable for people with...",
"dosespot_confirmation_status": "pending",
"dosespot_confirmation_status_details": null,
"thank_you_note": "lorem ipsum",
"clinical_note": "lorem ipsum",
"dispense_unit_id": 15,
"pharmacy_id": 13012,
"medication": {
"dosespot_medication_id": "1495316",
"dispense_unit_id": 26,
"dose_form": "tablet",
"route": "sublingual",
"strength": "2800 BAU",
"generic_product_name": "timothy grass pollen allergen extract 2800 BAU sublingual tablet",
"lexi_gen_product_id": 29589,
"lexi_drug_syn_id": 219792,
"lexi_synonym_type_id": 60,
"lexi_gen_drug_id": "d08256",
"rx_cui": "1495316",
"otc": false,
"ndc": "52709150103",
"schedule": "0",
"display_name": "Grastek 2800 BAU sublingual tablet",
"monograph_path": null,
"drug_classification": "allergenics",
"state_schedules": [
],
"metadata": "Lorem ipum",
"partner_medication_id": "29394cf1-379d-4767-abc0-982343980646"
},
"partner_compound": null
}
],
"case_services": [
{
"title": "teste",
"service_type": "device",
"directions": "direction teste",
"description": "description testante",
"additional_note": null,
"case_service_id": "747664a4-c6d0-4e7f-8b2a-67880a647edd"
},
{
"title": "teste device",
"service_type": "device",
"directions": "asdadsd",
"description": "asdads",
"additional_note": "asdads",
"case_service_id": "c42ca85b-3b98-4988-a283-cb3e9ab44eca"
}
]
},
"time": 1668735457
}
Medication Case Transferred
{
"event_name": "Medication Case Transferred",
"event_type": "medication_case",
"event_topic": "transferred",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"case_id": "4ca2ff80-4a4b-4c1d-9f32-07f8829af296"
},
"time": 1668735457
}
Medication Case Waiting
{
"event_name": "Medication Case Waiting",
"event_type": "medication_case",
"event_topic": "waiting",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"case_id": "b7c234e0-4545-41dd-8496-202f5ce4d522"
},
"time": 1668735457
}
Medication Orders
The following events are related to Medication Orders. They are triggered by analogous events sent to Capable Health by the Curexa pharmacy. They will only be sent if you have set up an account with Curexa and create medication orders through Capable Health.
The value of order_status
will always be one of the following: draft
,
order_placed
, awaiting_shipment
,
shipped
, delivered
, cancelled
, or on_hold
. The on_hold
status indicates that there was a delivery exception. In this case, the status_details
of the Medication Order will have one of the following statuses:
Bad Address
Duplicate Order
Missing Electronic Prescription
Refill too Soon
Returned to Sender
Clarification Required: Allergies
Clarification Required: Other Medications
Prescription Expired
No Refills Remaining
If a Medication Order progresses as expected, the following sequence of events will be triggered:
event_name: "Medication Order Create"
, order_status: "draft"
event_name: "Medication Order Update"
, order_status: "order_placed"
event_name: "Medication Order Update"
, order_status: "awaiting_shipment"
event_name: "Medication Order Update"
, order_status: "shipped"
event_name: "Medication Order Update"
, order_status: "delivered"
Medication Order Create
{
"event_name": "Medication Order Create",
"event_type": "medication_order",
"event_topic": "create",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"id": "aeaea13c-7416-4ed5-9172-46c75d08480c",
"order_status": "draft",
"carrier": null,
"carrier_service": null,
"tracking_number": null,
"status_details": null,
"created_at": "2022-11-18T01:37:37.344Z",
"updated_at": "2022-11-18T01:37:37.344Z",
"topic": "create",
"version": "1.0"
},
"time": 1668735457
}
Medication Order Update
{
"event_name": "Medication Order Update",
"event_type": "medication_order",
"event_topic": "update",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"id": "aeaea13c-7416-4ed5-9172-46c75d08480c",
"order_status": "shipped",
"carrier": null,
"carrier_service": null,
"tracking_number": null,
"status_details": null,
"created_at": "2022-11-18T01:37:37.344Z",
"updated_at": "2022-11-18T01:37:37.501Z",
"before_update": {
"id": "aeaea13c-7416-4ed5-9172-46c75d08480c",
"order_status": "draft",
"carrier": null,
"carrier_service": null,
"tracking_number": null,
"status_details": null,
"created_at": null,
"updated_at": "2022-11-18T01:37:37.344Z"
},
"topic": "update",
"version": "1.0"
},
"time": 1668735457
}
Messages
Message Added
{
"event_name": "Message Added",
"event_type": "message",
"event_topic": "added",
"patient_identity_id": "19be3a78-8e63-4bf9-9524-1b1c552ca5ec",
"payload": {
"msg_author_type": "patient",
"msg_author_email": "[email protected]",
"msg_author_phone": "7365302280",
"msg_author_id": "19be3a78-8e63-4bf9-9524-1b1c552ca5ec",
"msg_date_created": "2022-02-15T21:48:21.911Z",
"conversation_id": "68be51ab-a5ca-41e2-920a-b4113925722e",
"conversation_type": "sms",
"twillio_message_sid": "IM312c67acdd2c45a8a7cabecd577da886"
},
"time": 1668735457
}
Observations
Observation Create
{
"event_name": "Observation Create",
"event_type": "observation",
"event_topic": "create",
"patient_identity_id": "cf70a49e-9aeb-4c3c-b783-c93a5aff66b5",
"payload": {
"id": "a8f689ba-b00c-49b2-9398-bb5d48ca614f",
"target_id": null,
"observation_type_id": "36874657-e029-48cc-89c0-43fe47fa95e3",
"observed_value": "t",
"observed_date": "2022-11-18T01:37:39.182Z",
"created_at": "2022-11-18T01:37:39.182Z",
"source_type": "User",
"source_id": "6e7dbce7-e1f5-47a7-be24-1bf51088b1c6",
"note": null,
"data_type": "boolean",
"unit": null,
"goal_id": null,
"topic": "create",
"version": "1.0"
},
"time": 1668735459
}
Orders
Order statuses
Below are the possible status
values for Order events.
General statuses
created
: Order has been created in Capable Health.
awaiting_payment
: For tenants using Capable's Stripe integration, this status indicates the Order is awaiting payment to Stripe. See our guide on collecting payment for Orders using Stripe for more details.
awaiting_approval
: For tenants who require Orders to be approved before being fulfilled, this status indicates that the Order is awaiting approval. An Order can be approved using the /orders/{id}/approve
endpoint.
awaiting_fulfillment
: Order is awaiting fulfillment with the fulfillment partner.
awaiting_case_creation
: Order is awaiting the creation of a Patient Case with MD Integrations (MDI). See our guide on prescribing and ordering medications for more details on Capable's integration with MDI.
processing
: Order is being processed by an integration partner. A status of processing
will always be accompanied by a processing_status_details
value. The possible values for processing_status_details
are:
awaiting_prescription_approval
: Means that prescriptions requested as part of the Order are awaiting approval by an MDI doctor.awaiting_fulfillment_confirmation
: Means the Order has been sent to a fulfillment partner and is awaiting confirmation before being shipped.
Statuses related to Order fulfillment: awaiting_shipment_to_patient
, shipped_to_patient
, on_hold
, cancelled
, delivered_to_patient
.
Order Canceled
{
"event_name": "Order Canceled",
"event_type": "order",
"event_topic": "canceled",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "order_1Lz5UVAQlaVXLRiNeoMQPWzr",
"object": "order",
"amount_subtotal": 0,
"amount_total": 0,
"application": null,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_details": null,
"client_permissions": null,
"client_secret": null,
"created": 1667251555,
"currency": "usd",
"customer": null,
"description": null,
"discounts": [
],
"ip_address": null,
"livemode": false,
"metadata": {
},
"payment": {
"payment_intent": null,
"settings": {
"application_fee_amount": null,
"automatic_payment_methods": {
"enabled": false
},
"payment_method_options": null,
"payment_method_types": [
"card"
],
"return_url": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"transfer_data": null
},
"status": null
},
"shipping_cost": null,
"shipping_details": null,
"status": "open",
"total_details": {
"amount_discount": 0,
"amount_shipping": 0,
"amount_tax": 0
}
},
"time": 1668735458
}
Order Completed
{
"event_name": "Order Completed",
"event_type": "order",
"event_topic": "completed",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "order_1Lz5UVAQlaVXLRiNeoMQPWzr",
"object": "order",
"amount_subtotal": 0,
"amount_total": 0,
"application": null,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_details": null,
"client_permissions": null,
"client_secret": null,
"created": 1667251555,
"currency": "usd",
"customer": null,
"description": null,
"discounts": [
],
"ip_address": null,
"livemode": false,
"metadata": {
},
"payment": {
"payment_intent": null,
"settings": {
"application_fee_amount": null,
"automatic_payment_methods": {
"enabled": false
},
"payment_method_options": null,
"payment_method_types": [
"card"
],
"return_url": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"transfer_data": null
},
"status": null
},
"shipping_cost": null,
"shipping_details": null,
"status": "open",
"total_details": {
"amount_discount": 0,
"amount_shipping": 0,
"amount_tax": 0
}
},
"time": 1668735458
}
Order Create
{
"event_name": "Order Create",
"event_type": "order",
"event_topic": "create",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"id": "649b8870-7ed0-4902-98a3-eaf39debb5f1",
"patient_id": "cc326864-17ca-4724-b41b-df537784a30b",
"status": "created",
"carrier": null,
"carrier_service": null,
"tracking_number": null,
"status_details": null,
"created_at": "2022-11-18T01:37:37.624Z",
"updated_at": "2022-11-18T01:37:37.624Z",
"subtotal_price_cents": null,
"total_price_cents": null,
"order_date": "2022-11-18T01:37:37.000Z",
"shipping_date": null,
"delivery_date": null,
"metadata": {
},
"processing_status_details": null,
"order_line_items": [
{
"id": "a12a4714-d7cf-4910-868c-a3c37dd0e054",
"product_name": null,
"price_cents": 100,
"quantity": 1,
"vendor_name": null,
"vendor_product_id": null,
"status": "created",
"status_details": null,
"order_id": "649b8870-7ed0-4902-98a3-eaf39debb5f1",
"product_id": "b767d630-dcf6-415b-a851-86b644a09454",
"prescription_id": "3ab61312-1324-42b5-b3c7-a7c4665fdf82",
"created_at": "2022-11-18T01:37:37.639Z",
"updated_at": "2022-11-18T01:37:37.639Z",
"refill": false,
"encounter_id": null
}
],
"shipping_address": {
"line1": "816 Billie Ville",
"line2": null,
"city": "Wisokyfurt",
"state": "Nevada",
"zip": "53351-5126",
"country": "GE",
"address_type": "shipping"
},
"billing_address": {
"line1": "201 Kuphal Rest",
"line2": null,
"city": "Port Dominique",
"state": "Kentucky",
"zip": "60969",
"country": "NZ",
"address_type": "shipping"
},
"topic": "create",
"version": "1.0"
},
"time": 1668735457
}
Order Created
{
"event_name": "Order Created",
"event_type": "order",
"event_topic": "created",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "order_1Lz5UVAQlaVXLRiNeoMQPWzr",
"object": "order",
"amount_subtotal": 0,
"amount_total": 0,
"application": null,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_details": null,
"client_permissions": null,
"client_secret": null,
"created": 1667251555,
"currency": "usd",
"customer": null,
"description": null,
"discounts": [
],
"ip_address": null,
"livemode": false,
"metadata": {
},
"payment": {
"payment_intent": null,
"settings": {
"application_fee_amount": null,
"automatic_payment_methods": {
"enabled": false
},
"payment_method_options": null,
"payment_method_types": [
"card"
],
"return_url": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"transfer_data": null
},
"status": null
},
"shipping_cost": null,
"shipping_details": null,
"status": "open",
"total_details": {
"amount_discount": 0,
"amount_shipping": 0,
"amount_tax": 0
}
},
"time": 1668735458
}
Order Payment Completed
{
"event_name": "Order Payment Completed",
"event_type": "order",
"event_topic": "payment_completed",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "order_1Lz5UVAQlaVXLRiNeoMQPWzr",
"object": "order",
"amount_subtotal": 0,
"amount_total": 0,
"application": null,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_details": null,
"client_permissions": null,
"client_secret": null,
"created": 1667251555,
"currency": "usd",
"customer": null,
"description": null,
"discounts": [
],
"ip_address": null,
"livemode": false,
"metadata": {
},
"payment": {
"payment_intent": null,
"settings": {
"application_fee_amount": null,
"automatic_payment_methods": {
"enabled": false
},
"payment_method_options": null,
"payment_method_types": [
"card"
],
"return_url": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"transfer_data": null
},
"status": null
},
"shipping_cost": null,
"shipping_details": null,
"status": "open",
"total_details": {
"amount_discount": 0,
"amount_shipping": 0,
"amount_tax": 0
}
},
"time": 1668735458
}
Order Submitted
{
"event_name": "Order Submitted",
"event_type": "order",
"event_topic": "submitted",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "order_1Lz5UVAQlaVXLRiNeoMQPWzr",
"object": "order",
"amount_subtotal": 0,
"amount_total": 0,
"application": null,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_details": null,
"client_permissions": null,
"client_secret": null,
"created": 1667251555,
"currency": "usd",
"customer": null,
"description": null,
"discounts": [
],
"ip_address": null,
"livemode": false,
"metadata": {
},
"payment": {
"payment_intent": null,
"settings": {
"application_fee_amount": null,
"automatic_payment_methods": {
"enabled": false
},
"payment_method_options": null,
"payment_method_types": [
"card"
],
"return_url": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"transfer_data": null
},
"status": null
},
"shipping_cost": null,
"shipping_details": null,
"status": "open",
"total_details": {
"amount_discount": 0,
"amount_shipping": 0,
"amount_tax": 0
}
},
"time": 1668735458
}
Order Update
{
"event_name": "Order Update",
"event_type": "order",
"event_topic": "update",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"id": "649b8870-7ed0-4902-98a3-eaf39debb5f1",
"patient_id": "cc326864-17ca-4724-b41b-df537784a30b",
"status": "shipped_to_patient",
"carrier": null,
"carrier_service": null,
"tracking_number": null,
"status_details": null,
"created_at": "2022-11-18T01:37:37.624Z",
"updated_at": "2022-11-18T01:37:37.783Z",
"subtotal_price_cents": null,
"total_price_cents": null,
"order_date": "2022-11-18T01:37:37.000Z",
"shipping_date": null,
"delivery_date": null,
"metadata": {
},
"processing_status_details": null,
"order_line_items": [
{
"id": "a12a4714-d7cf-4910-868c-a3c37dd0e054",
"product_name": null,
"price_cents": 100,
"quantity": 1,
"vendor_name": null,
"vendor_product_id": null,
"status": "created",
"status_details": null,
"order_id": "649b8870-7ed0-4902-98a3-eaf39debb5f1",
"product_id": "b767d630-dcf6-415b-a851-86b644a09454",
"prescription_id": "3ab61312-1324-42b5-b3c7-a7c4665fdf82",
"created_at": "2022-11-18T01:37:37.639Z",
"updated_at": "2022-11-18T01:37:37.639Z",
"refill": false,
"encounter_id": null
}
],
"shipping_address": {
"line1": "816 Billie Ville",
"line2": null,
"city": "Wisokyfurt",
"state": "Nevada",
"zip": "53351-5126",
"country": "GE",
"address_type": "shipping"
},
"before_update": {
"id": "649b8870-7ed0-4902-98a3-eaf39debb5f1",
"patient_id": "cc326864-17ca-4724-b41b-df537784a30b",
"status": "created",
"carrier": null,
"carrier_service": null,
"tracking_number": null,
"status_details": null,
"created_at": null,
"updated_at": "2022-11-18T01:37:37.624Z",
"subtotal_price_cents": null,
"total_price_cents": null,
"order_date": "2022-11-18T01:37:37.000Z",
"shipping_date": null,
"delivery_date": null,
"metadata": {
},
"processing_status_details": null,
"order_line_items": [
{
"id": "a12a4714-d7cf-4910-868c-a3c37dd0e054",
"product_name": null,
"price_cents": 100,
"quantity": 1,
"vendor_name": null,
"vendor_product_id": null,
"status": "created",
"status_details": null,
"order_id": "649b8870-7ed0-4902-98a3-eaf39debb5f1",
"product_id": "b767d630-dcf6-415b-a851-86b644a09454",
"prescription_id": "3ab61312-1324-42b5-b3c7-a7c4665fdf82",
"created_at": "2022-11-18T01:37:37.639Z",
"updated_at": "2022-11-18T01:37:37.639Z",
"refill": false,
"encounter_id": null
}
],
"shipping_address": {
"line1": "816 Billie Ville",
"line2": null,
"city": "Wisokyfurt",
"state": "Nevada",
"zip": "53351-5126",
"country": "GE",
"address_type": "shipping"
}
},
"topic": "update",
"version": "1.0"
},
"time": 1668735457
}
Order Updated
{
"event_name": "Order Updated",
"event_type": "order",
"event_topic": "updated",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "order_1Lz5UVAQlaVXLRiNeoMQPWzr",
"object": "order",
"amount_subtotal": 0,
"amount_total": 0,
"application": null,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_details": null,
"client_permissions": null,
"client_secret": null,
"created": 1667251555,
"currency": "usd",
"customer": null,
"description": null,
"discounts": [
],
"ip_address": null,
"livemode": false,
"metadata": {
},
"payment": {
"payment_intent": null,
"settings": {
"application_fee_amount": null,
"automatic_payment_methods": {
"enabled": false
},
"payment_method_options": null,
"payment_method_types": [
"card"
],
"return_url": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"transfer_data": null
},
"status": null
},
"shipping_cost": null,
"shipping_details": null,
"status": "open",
"total_details": {
"amount_discount": 0,
"amount_shipping": 0,
"amount_tax": 0
}
},
"time": 1668735458
}
Patients
Patient Create
{
"event_name": "Patient Create",
"event_type": "patient",
"event_topic": "create",
"patient_identity_id": "5f3e34ba-e051-49ba-aa49-eb9d43a6976f",
"payload": {
"identity_id": "5f3e34ba-e051-49ba-aa49-eb9d43a6976f",
"email": "[email protected]",
"first_name": null,
"middle_name": null,
"last_name": null,
"birth_date": null,
"addresses": [
],
"phones": [
{
"id": "95d806f3-e85a-470b-9022-4120451f65a5",
"number": "100-573-7337 x2348",
"active": true,
"user_id": "a13a07b3-8150-4951-9ab8-85f0a3cf2b1c",
"created_at": "2022-11-18T01:37:38.467Z",
"updated_at": "2022-11-18T01:37:38.467Z",
"primary": true,
"label": null
}
],
"administrative_gender": null,
"gender_identity": null,
"organization_ids": [
],
"pronouns": null,
"external_id": null,
"tag_list": [
],
"created_at": "2022-11-18T01:37:38.463Z",
"updated_at": "2022-11-18T01:37:38.463Z",
"archived_at": null,
"deleted_at": null,
"primary_phone": "100-573-7337 x2348",
"archived": false,
"deleted": false,
"topic": "create",
"version": "1.0"
},
"time": 1668735458
}
Patient Invitee Invite
{
"event_name": "Patient Invitee Invite",
"event_type": "patient",
"event_topic": "invitee_invite",
"patient_identity_id": "ca53dd69-ab00-4101-a4ea-d4c6df49a32e",
"payload": {
"inviter": {
"identity_id": "fe7cd4d4-3685-4440-aea0-e94088a43ac5",
"email": "[email protected]",
"first_name": null,
"middle_name": null,
"last_name": null,
"birth_date": null,
"addresses": [
],
"phones": [
],
"administrative_gender": null,
"gender_identity": null,
"organization_ids": [
],
"pronouns": null,
"external_id": null,
"tag_list": [
],
"created_at": "2022-11-18T01:37:39.076Z",
"updated_at": "2022-11-18T01:37:39.076Z",
"archived_at": null,
"deleted_at": null,
"primary_phone": null,
"archived": false,
"deleted": false
},
"invitee": {
"identity_id": "ca53dd69-ab00-4101-a4ea-d4c6df49a32e",
"email": "[email protected]",
"first_name": null,
"middle_name": null,
"last_name": null,
"birth_date": null,
"addresses": [
],
"phones": [
],
"administrative_gender": null,
"gender_identity": null,
"organization_ids": [
],
"pronouns": null,
"external_id": null,
"tag_list": [
],
"created_at": "2022-11-18T01:37:39.103Z",
"updated_at": "2022-11-18T01:37:39.103Z",
"archived_at": null,
"deleted_at": null,
"primary_phone": null,
"archived": false,
"deleted": false
}
},
"time": 1668735459
}
Patient Inviter Invite
{
"event_name": "Patient Inviter Invite",
"event_type": "patient",
"event_topic": "inviter_invite",
"patient_identity_id": "ca53dd69-ab00-4101-a4ea-d4c6df49a32e",
"payload": {
"inviter": {
"identity_id": "fe7cd4d4-3685-4440-aea0-e94088a43ac5",
"email": "[email protected]",
"first_name": null,
"middle_name": null,
"last_name": null,
"birth_date": null,
"addresses": [
],
"phones": [
],
"administrative_gender": null,
"gender_identity": null,
"organization_ids": [
],
"pronouns": null,
"external_id": null,
"tag_list": [
],
"created_at": "2022-11-18T01:37:39.076Z",
"updated_at": "2022-11-18T01:37:39.076Z",
"archived_at": null,
"deleted_at": null,
"primary_phone": null,
"archived": false,
"deleted": false
},
"invitee": {
"identity_id": "ca53dd69-ab00-4101-a4ea-d4c6df49a32e",
"email": "[email protected]",
"first_name": null,
"middle_name": null,
"last_name": null,
"birth_date": null,
"addresses": [
],
"phones": [
],
"administrative_gender": null,
"gender_identity": null,
"organization_ids": [
],
"pronouns": null,
"external_id": null,
"tag_list": [
],
"created_at": "2022-11-18T01:37:39.103Z",
"updated_at": "2022-11-18T01:37:39.103Z",
"archived_at": null,
"deleted_at": null,
"primary_phone": null,
"archived": false,
"deleted": false
}
},
"time": 1668735459
}
Patient Update
{
"event_name": "Patient Update",
"event_type": "patient",
"event_topic": "update",
"patient_identity_id": "5f3e34ba-e051-49ba-aa49-eb9d43a6976f",
"payload": {
"identity_id": "5f3e34ba-e051-49ba-aa49-eb9d43a6976f",
"email": "[email protected]",
"first_name": "Jack",
"middle_name": null,
"last_name": null,
"birth_date": null,
"addresses": [
],
"phones": [
{
"id": "95d806f3-e85a-470b-9022-4120451f65a5",
"number": "100-573-7337 x2348",
"active": true,
"user_id": "a13a07b3-8150-4951-9ab8-85f0a3cf2b1c",
"created_at": "2022-11-18T01:37:38.467Z",
"updated_at": "2022-11-18T01:37:38.467Z",
"primary": true,
"label": null
}
],
"administrative_gender": null,
"gender_identity": null,
"organization_ids": [
],
"pronouns": null,
"external_id": null,
"tag_list": [
],
"created_at": "2022-11-18T01:37:38.463Z",
"updated_at": "2022-11-18T01:37:38.483Z",
"archived_at": null,
"deleted_at": null,
"primary_phone": "100-573-7337 x2348",
"archived": false,
"deleted": false,
"before_update": {
"identity_id": "5f3e34ba-e051-49ba-aa49-eb9d43a6976f",
"email": "[email protected]",
"first_name": null,
"middle_name": null,
"last_name": null,
"birth_date": null,
"addresses": [
],
"phones": [
{
"id": "95d806f3-e85a-470b-9022-4120451f65a5",
"number": "100-573-7337 x2348",
"active": true,
"user_id": "a13a07b3-8150-4951-9ab8-85f0a3cf2b1c",
"created_at": "2022-11-18T01:37:38.467Z",
"updated_at": "2022-11-18T01:37:38.467Z",
"primary": true,
"label": null
}
],
"administrative_gender": null,
"gender_identity": null,
"organization_ids": [
],
"pronouns": null,
"external_id": null,
"tag_list": [
],
"created_at": null,
"updated_at": "2022-11-18T01:37:38.463Z",
"archived_at": null,
"deleted_at": null,
"primary_phone": "100-573-7337 x2348",
"archived": false,
"deleted": false
},
"topic": "update",
"version": "1.0"
},
"time": 1668735458
}
Patient Billings
Patient Billing Create
{
"event_name": "Patient Billing Create",
"event_type": "patient_billing",
"event_topic": "create",
"patient_identity_id": "194d5d13-e45c-45a5-b4bf-26aa71c462c7",
"payload": {
"id": "12336eca-0b29-4ef2-a5f6-1e8eb318f090",
"patient_id": "7be43e75-99ea-4250-aaaf-e26b5874972f",
"billing_id": null,
"validated": true,
"subscription_plan_id": null,
"secret": "39e2488435238a6c6aa64ce250bd68c2",
"topic": "create",
"version": "1.0"
},
"time": 1668735458
}
Patient Medications
Patient Medication Create
{
"event_name": "Patient Medication Create",
"event_type": "patient_medication",
"event_topic": "create",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"id": "055daafa-b8dc-4b19-afa9-3d1342f245d9",
"name": "Sejak",
"external_pharmacy_name": null,
"external_pharmacy_id": null,
"external_case_id": "49661557-d9c5-467a-a261-feb6dea3ca57",
"patient_unique_email": "[email protected]",
"refills_left": 0,
"refills_prescribed": 0,
"over_the_counter": false,
"next_reorder_date": null,
"medication_order_ids": [
],
"patient_id": "9e209b6d-d29f-4d6f-acd2-918a5ec50557",
"created_at": "2022-11-18T01:37:37.390Z",
"prescribing_doctor": null,
"quantity_dispensed": null,
"external_medication_id": null,
"days_supply": null,
"directions": null,
"compound": null,
"updated_at": "2022-11-18T01:37:37.390Z",
"last_order_status": null,
"status": "created",
"topic": "create",
"version": "1.0"
},
"time": 1668735457
}
Patient Medication Update
{
"event_name": "Patient Medication Update",
"event_type": "patient_medication",
"event_topic": "update",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"id": "055daafa-b8dc-4b19-afa9-3d1342f245d9",
"name": "Sejak",
"external_pharmacy_name": null,
"external_pharmacy_id": null,
"external_case_id": "49661557-d9c5-467a-a261-feb6dea3ca57",
"patient_unique_email": "[email protected]",
"refills_left": 0,
"refills_prescribed": 0,
"over_the_counter": false,
"next_reorder_date": null,
"medication_order_ids": [
],
"patient_id": "9e209b6d-d29f-4d6f-acd2-918a5ec50557",
"created_at": "2022-11-18T01:37:37.390Z",
"prescribing_doctor": null,
"quantity_dispensed": null,
"external_medication_id": null,
"days_supply": null,
"directions": null,
"compound": null,
"updated_at": "2022-11-18T01:37:37.518Z",
"last_order_status": null,
"status": "completed",
"before_update": {
"id": "055daafa-b8dc-4b19-afa9-3d1342f245d9",
"name": "Sejak",
"external_pharmacy_name": null,
"external_pharmacy_id": null,
"external_case_id": "49661557-d9c5-467a-a261-feb6dea3ca57",
"patient_unique_email": "[email protected]",
"refills_left": 0,
"refills_prescribed": 0,
"over_the_counter": false,
"next_reorder_date": null,
"medication_order_ids": [
],
"patient_id": "9e209b6d-d29f-4d6f-acd2-918a5ec50557",
"created_at": null,
"prescribing_doctor": null,
"quantity_dispensed": null,
"external_medication_id": null,
"days_supply": null,
"directions": null,
"compound": null,
"updated_at": "2022-11-18T01:37:37.390Z",
"last_order_status": null,
"status": "created"
},
"topic": "update",
"version": "1.0"
},
"time": 1668735457
}
Patient Related Persons
Patient Related Person Create
{
"event_name": "Patient Related Person Create",
"event_type": "patient_related_person",
"event_topic": "create",
"patient_identity_id": "0baa802f-7fd4-43b6-975d-f214e1e1f679",
"payload": {
"id": "55635327-7a52-4a15-bb9c-08e8696ed0b2",
"relationship_type": "step sibling",
"patient_id": "ecfeefdd-3a70-4d20-b89d-edeb6c2876a1",
"related_person_id": "20cc3bff-40ab-4a5c-8f35-9f639e72601b",
"related_person_type": "User",
"created_at": "2022-11-18T01:37:38.405Z",
"updated_at": "2022-11-18T01:37:38.405Z",
"patient": {
"identity_id": "75e8bc45-1ba8-45f8-804f-a8b74079d2a1"
},
"related_person": {
"identity_id": "0baa802f-7fd4-43b6-975d-f214e1e1f679"
},
"topic": "create",
"version": "1.0"
},
"time": 1668735458
}
Prescriptions
Prescription Create
{
"event_name": "Prescription Create",
"event_type": "prescription",
"event_topic": "create",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"id": "3ab61312-1324-42b5-b3c7-a7c4665fdf82",
"name": "Lishan",
"external_pharmacy_name": null,
"external_pharmacy_id": null,
"external_case_id": "fd6e7fe4-4090-4b8f-9bfd-afba0e678422",
"patient_unique_email": "[email protected]",
"refills_left": 3,
"refills_prescribed": 3,
"initial_fullfil_exhausted": false,
"over_the_counter": false,
"patient_id": "cc326864-17ca-4724-b41b-df537784a30b",
"created_at": "2022-11-18T01:37:37.593Z",
"prescribing_doctor": null,
"quantity_dispensed": null,
"external_medication_id": null,
"days_supply": null,
"directions": null,
"compound": null,
"updated_at": "2022-11-18T01:37:37.593Z",
"status": "created",
"topic": "create",
"version": "1.0"
},
"time": 1668735457
}
Prescription Update
{
"event_name": "Prescription Update",
"event_type": "prescription",
"event_topic": "update",
"patient_identity_id": "696ab6a3-dedf-4983-b223-21b5297655dd",
"payload": {
"id": "3ab61312-1324-42b5-b3c7-a7c4665fdf82",
"name": "Lishan",
"external_pharmacy_name": null,
"external_pharmacy_id": null,
"external_case_id": "fd6e7fe4-4090-4b8f-9bfd-afba0e678422",
"patient_unique_email": "[email protected]",
"refills_left": 3,
"refills_prescribed": 3,
"initial_fullfil_exhausted": false,
"over_the_counter": false,
"patient_id": "cc326864-17ca-4724-b41b-df537784a30b",
"created_at": "2022-11-18T01:37:37.593Z",
"prescribing_doctor": null,
"quantity_dispensed": null,
"external_medication_id": null,
"days_supply": null,
"directions": null,
"compound": null,
"updated_at": "2022-11-18T01:37:37.807Z",
"status": "completed",
"before_update": {
"id": "3ab61312-1324-42b5-b3c7-a7c4665fdf82",
"name": "Lishan",
"external_pharmacy_name": null,
"external_pharmacy_id": null,
"external_case_id": "fd6e7fe4-4090-4b8f-9bfd-afba0e678422",
"patient_unique_email": "[email protected]",
"refills_left": 3,
"refills_prescribed": 3,
"initial_fullfil_exhausted": false,
"over_the_counter": false,
"patient_id": "cc326864-17ca-4724-b41b-df537784a30b",
"created_at": null,
"prescribing_doctor": null,
"quantity_dispensed": null,
"external_medication_id": null,
"days_supply": null,
"directions": null,
"compound": null,
"updated_at": "2022-11-18T01:37:37.593Z",
"status": "created"
},
"topic": "update",
"version": "1.0"
},
"time": 1668735457
}
Submissions
Submission Create
{
"event_name": "Submission Create",
"event_type": "submission",
"event_topic": "create",
"patient_identity_id": "a60785e6-2a55-42f6-9245-efd39d3a2839",
"payload": {
"id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"questionnaire_id": "dc251940-c73e-449f-a786-a645bc064ca2",
"metadata": {
},
"status": "draft",
"completed_at": null,
"created_at": "2022-11-18T01:37:37.940Z",
"updated_at": "2022-11-18T01:37:37.940Z",
"patient_id": "da9c7a78-632d-47a9-abac-e8e8e61fbb3a",
"user_id": "da9c7a78-632d-47a9-abac-e8e8e61fbb3a",
"survey_id": "186417fa-b88b-4334-95e9-52e9db94cdde",
"survey_name": "O'Hara Inc",
"completed": false,
"last_response": {
"id": "3aa9adf0-cf93-486d-a445-dc0390e27889",
"content": "nesciunt",
"question_content": "Natus omnis harum velit?",
"submission_id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"question_id": "a559c10b-2e1e-42fa-9e4e-e701a04df35a",
"answer_id": null,
"created_at": "2022-11-18T01:37:38.003Z",
"updated_at": "2022-11-18T01:37:38.003Z",
"status": "active"
},
"last_response_question": {
"id": "a559c10b-2e1e-42fa-9e4e-e701a04df35a",
"title": "Natus omnis harum velit?",
"position": 3,
"status": "active",
"questionnaire_id": "186417fa-b88b-4334-95e9-52e9db94cdde",
"created_at": "2022-11-18T01:37:37.999Z",
"updated_at": "2022-11-18T01:37:37.999Z",
"metadata": {
},
"required": false,
"observation_type_id": null,
"external_source": null,
"external_id": null
},
"last_response_question_pos": 3,
"last_response_question_title": "Natus omnis harum velit?",
"total_questions_responded": 3,
"responses": [
{
"id": "254266fa-7a9b-4534-9c61-35ba756f8de1",
"content": "tempore",
"question_content": "Quisquam corporis voluptatibus aperiam?",
"submission_id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"question_id": "9c1387ed-15e9-4005-822f-ce70eff5a0c8",
"answer_id": null,
"created_at": "2022-11-18T01:37:37.964Z",
"updated_at": "2022-11-18T01:37:37.964Z",
"status": "active"
},
{
"id": "b32fdd9e-6c4a-47e4-8627-b3a266ce8a65",
"content": "odio",
"question_content": "Quo aliquam similique repellendus?",
"submission_id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"question_id": "6e31d27a-5a2e-40aa-9ffb-f67194d2d050",
"answer_id": null,
"created_at": "2022-11-18T01:37:37.984Z",
"updated_at": "2022-11-18T01:37:37.984Z",
"status": "active"
},
{
"id": "3aa9adf0-cf93-486d-a445-dc0390e27889",
"content": "nesciunt",
"question_content": "Natus omnis harum velit?",
"submission_id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"question_id": "a559c10b-2e1e-42fa-9e4e-e701a04df35a",
"answer_id": null,
"created_at": "2022-11-18T01:37:38.003Z",
"updated_at": "2022-11-18T01:37:38.003Z",
"status": "active"
}
],
"topic": "create",
"version": "1.0"
},
"time": 1668735458
}
Submission Update
{
"event_name": "Submission Update",
"event_type": "submission",
"event_topic": "update",
"patient_identity_id": "a60785e6-2a55-42f6-9245-efd39d3a2839",
"payload": {
"id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"questionnaire_id": "dc251940-c73e-449f-a786-a645bc064ca2",
"metadata": {
},
"status": "completed",
"completed_at": "2022-11-18T01:37:38.029Z",
"created_at": "2022-11-18T01:37:37.940Z",
"updated_at": "2022-11-18T01:37:38.030Z",
"patient_id": "da9c7a78-632d-47a9-abac-e8e8e61fbb3a",
"user_id": "da9c7a78-632d-47a9-abac-e8e8e61fbb3a",
"survey_id": "186417fa-b88b-4334-95e9-52e9db94cdde",
"survey_name": "O'Hara Inc",
"completed": true,
"last_response": {
"id": "3aa9adf0-cf93-486d-a445-dc0390e27889",
"content": "nesciunt",
"question_content": "Natus omnis harum velit?",
"submission_id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"question_id": "a559c10b-2e1e-42fa-9e4e-e701a04df35a",
"answer_id": null,
"created_at": "2022-11-18T01:37:38.003Z",
"updated_at": "2022-11-18T01:37:38.003Z",
"status": "active"
},
"last_response_question": {
"id": "a559c10b-2e1e-42fa-9e4e-e701a04df35a",
"title": "Natus omnis harum velit?",
"position": 3,
"status": "active",
"questionnaire_id": "186417fa-b88b-4334-95e9-52e9db94cdde",
"created_at": "2022-11-18T01:37:37.999Z",
"updated_at": "2022-11-18T01:37:37.999Z",
"metadata": {
},
"required": false,
"observation_type_id": null,
"external_source": null,
"external_id": null
},
"last_response_question_pos": 3,
"last_response_question_title": "Natus omnis harum velit?",
"total_questions_responded": 3,
"responses": [
{
"id": "254266fa-7a9b-4534-9c61-35ba756f8de1",
"content": "tempore",
"question_content": "Quisquam corporis voluptatibus aperiam?",
"submission_id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"question_id": "9c1387ed-15e9-4005-822f-ce70eff5a0c8",
"answer_id": null,
"created_at": "2022-11-18T01:37:37.964Z",
"updated_at": "2022-11-18T01:37:37.964Z",
"status": "active"
},
{
"id": "b32fdd9e-6c4a-47e4-8627-b3a266ce8a65",
"content": "odio",
"question_content": "Quo aliquam similique repellendus?",
"submission_id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"question_id": "6e31d27a-5a2e-40aa-9ffb-f67194d2d050",
"answer_id": null,
"created_at": "2022-11-18T01:37:37.984Z",
"updated_at": "2022-11-18T01:37:37.984Z",
"status": "active"
},
{
"id": "3aa9adf0-cf93-486d-a445-dc0390e27889",
"content": "nesciunt",
"question_content": "Natus omnis harum velit?",
"submission_id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"question_id": "a559c10b-2e1e-42fa-9e4e-e701a04df35a",
"answer_id": null,
"created_at": "2022-11-18T01:37:38.003Z",
"updated_at": "2022-11-18T01:37:38.003Z",
"status": "active"
}
],
"before_update": {
"id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"questionnaire_id": "dc251940-c73e-449f-a786-a645bc064ca2",
"metadata": {
},
"status": "draft",
"completed_at": null,
"created_at": null,
"updated_at": "2022-11-18T01:37:37.940Z",
"patient_id": "da9c7a78-632d-47a9-abac-e8e8e61fbb3a",
"user_id": "da9c7a78-632d-47a9-abac-e8e8e61fbb3a",
"survey_id": "186417fa-b88b-4334-95e9-52e9db94cdde",
"survey_name": "O'Hara Inc",
"completed": false,
"last_response": {
"id": "3aa9adf0-cf93-486d-a445-dc0390e27889",
"content": "nesciunt",
"question_content": "Natus omnis harum velit?",
"submission_id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"question_id": "a559c10b-2e1e-42fa-9e4e-e701a04df35a",
"answer_id": null,
"created_at": "2022-11-18T01:37:38.003Z",
"updated_at": "2022-11-18T01:37:38.003Z",
"status": "active"
},
"last_response_question": {
"id": "a559c10b-2e1e-42fa-9e4e-e701a04df35a",
"title": "Natus omnis harum velit?",
"position": 3,
"status": "active",
"questionnaire_id": "186417fa-b88b-4334-95e9-52e9db94cdde",
"created_at": "2022-11-18T01:37:37.999Z",
"updated_at": "2022-11-18T01:37:37.999Z",
"metadata": {
},
"required": false,
"observation_type_id": null,
"external_source": null,
"external_id": null
},
"last_response_question_pos": 3,
"last_response_question_title": "Natus omnis harum velit?",
"total_questions_responded": 3,
"responses": [
{
"id": "254266fa-7a9b-4534-9c61-35ba756f8de1",
"content": "tempore",
"question_content": "Quisquam corporis voluptatibus aperiam?",
"submission_id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"question_id": "9c1387ed-15e9-4005-822f-ce70eff5a0c8",
"answer_id": null,
"created_at": "2022-11-18T01:37:37.964Z",
"updated_at": "2022-11-18T01:37:37.964Z",
"status": "active"
},
{
"id": "b32fdd9e-6c4a-47e4-8627-b3a266ce8a65",
"content": "odio",
"question_content": "Quo aliquam similique repellendus?",
"submission_id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"question_id": "6e31d27a-5a2e-40aa-9ffb-f67194d2d050",
"answer_id": null,
"created_at": "2022-11-18T01:37:37.984Z",
"updated_at": "2022-11-18T01:37:37.984Z",
"status": "active"
},
{
"id": "3aa9adf0-cf93-486d-a445-dc0390e27889",
"content": "nesciunt",
"question_content": "Natus omnis harum velit?",
"submission_id": "19b2991f-7cb9-445e-aa7f-5de3a6086412",
"question_id": "a559c10b-2e1e-42fa-9e4e-e701a04df35a",
"answer_id": null,
"created_at": "2022-11-18T01:37:38.003Z",
"updated_at": "2022-11-18T01:37:38.003Z",
"status": "active"
}
]
},
"topic": "update",
"version": "1.0"
},
"time": 1668735458
}
Tasks
Task Create
{
"event_name": "Task Create",
"event_type": "task",
"event_topic": "create",
"patient_identity_id": "2ab3e9b6-86b8-4e8c-b323-c0d64ff58832",
"payload": {
"id": "16348e6d-b3aa-474d-b070-0a0dd7de0b85",
"name": "Jacked Breaker",
"description": null,
"achievement_status": "in_progress",
"task_template_id": "3734895d-312b-4c59-9cec-33478f6f6396",
"due_on": null,
"care_plan_id": "fd9179f4-35f2-4ff9-b5f9-177bf246d0fc",
"tag_list": [
],
"cms_entry_id": null,
"created_at": "2022-11-18T01:37:38.896Z",
"updated_at": "2022-11-18T01:37:38.896Z",
"care_plan_template_id": "bedb35ee-ecb9-434a-bf18-bc32a4b6056f",
"topic": "create",
"version": "1.0"
},
"time": 1668735458
}
Task Update
{
"event_name": "Task Update",
"event_type": "task",
"event_topic": "update",
"patient_identity_id": "2ab3e9b6-86b8-4e8c-b323-c0d64ff58832",
"payload": {
"id": "16348e6d-b3aa-474d-b070-0a0dd7de0b85",
"name": "Jacked Breaker",
"description": null,
"achievement_status": "cancelled",
"task_template_id": "3734895d-312b-4c59-9cec-33478f6f6396",
"due_on": null,
"care_plan_id": "fd9179f4-35f2-4ff9-b5f9-177bf246d0fc",
"tag_list": [
],
"cms_entry_id": null,
"created_at": "2022-11-18T01:37:38.896Z",
"updated_at": "2022-11-18T01:37:38.911Z",
"care_plan_template_id": "bedb35ee-ecb9-434a-bf18-bc32a4b6056f",
"before_update": {
"id": "16348e6d-b3aa-474d-b070-0a0dd7de0b85",
"name": "Jacked Breaker",
"description": null,
"achievement_status": "in_progress",
"task_template_id": "3734895d-312b-4c59-9cec-33478f6f6396",
"due_on": null,
"care_plan_id": "fd9179f4-35f2-4ff9-b5f9-177bf246d0fc",
"tag_list": [
],
"cms_entry_id": null,
"created_at": null,
"updated_at": "2022-11-18T01:37:38.896Z",
"care_plan_template_id": "bedb35ee-ecb9-434a-bf18-bc32a4b6056f"
},
"topic": "update",
"version": "1.0"
},
"time": 1668735458
}
Users
User Generate Token
{
"event_name": "User Generate Token",
"event_type": "user",
"event_topic": "generate_token",
"patient_identity_id": "8b5d592d-0374-4a1b-a7b8-d084a002d734",
"payload": {
"user": {
"id": "544ad67c-c69c-48e2-8151-cbc32fb94221",
"type": "Patient"
},
"cognito_user_name": "bbbd6a5e-53e6-4974-aff4-334d9bf8be2f",
"trigger": "event_trigger",
"user_pool_id": "57f60071-1c54-4625-b9ab-4140bae5ba04",
"topic": "generate_token",
"version": "1.0"
},
"time": 1668735458
}
Workflows
Workflow Executed
{
"event_name": "Workflow Executed",
"event_type": "workflow",
"event_topic": "executed",
"patient_identity_id": "1c636fc6-0d09-43f7-a1fb-25e8a81d4e0e",
"payload": {
"resource": {
"type": "submission",
"id": "73d46f94-d666-4cd1-a583-4ed96e4471f9"
},
"workflows": [
{
"workflow_id": "b8b19565-d24e-438f-bbfa-49b1b5577c73",
"workflow_name": "A workflow",
"workflow_execution_group_id": "8345ee68-bf72-472a-9cc3-18ee60de2abf"
},
{
"workflow_id": "d3fe0ac0-cb18-4f54-9c02-5eb77edaf9fb",
"workflow_name": "Another workflow",
"workflow_execution_group_id": "14215e39-1659-4f74-b34f-63de2d321376"
}
],
"care_suggestions": [
{
"id": null,
"name": "Do sport",
"description": null,
"achievement_status": "in_progress",
"start_on": "2022-06-09T21:09:36.621Z",
"due_on": null,
"cron_expression": null,
"care_plan_id": null,
"goal_template_id": "b4b50a7d-3163-4b5e-b463-0f3d37f98071",
"created_at": null,
"updated_at": null,
"cms_entry_id": null,
"targets": [
],
"weight": 2,
"type": "goal",
"tag_list": [
"sport"
],
"observations": [
]
},
{
"id": null,
"name": "Call us",
"description": "Do. Or do not. There is no try.",
"achievement_status": "in_progress",
"due_on": null,
"care_plan_id": null,
"task_template_id": "3e52c693-3922-4c21-a602-d5d9113a35fa",
"created_at": null,
"updated_at": null,
"cms_entry_id": null,
"weight": 1,
"type": "task",
"tag_list": [
]
}
],
"resources": [
{
"type": "sms",
"to": "+1 234 567 8910",
"message_body": "Welcome to Capable"
},
{
"id": "19df33b8-8b18-41b3-b936-cd9459815ca7",
"name": "Complete profile.",
"description": "Go to your patient profile and fullfil the max you can!",
"achievement_status": "in_progress",
"due_on": null,
"care_plan_id": "06ecb5d3-4c53-4544-b0de-fff7f82053b5",
"task_template_id": "f97f3b8f-a0df-4446-8f8d-9375cc2c07ba",
"created_at": "2022-11-18 01:37:37 UTC",
"updated_at": "2022-11-18 01:37:37 UTC",
"cms_entry_id": null,
"type": "task",
"tag_list": [
]
}
]
},
"time": 1668735457
}
Workflow Initiated
{
"event_name": "Workflow Initiated",
"event_type": "workflow",
"event_topic": "initiated",
"patient_identity_id": "40fb5c66-5122-4a77-a45c-497b84dfb0fe",
"payload": {
"workflow_id": "9e438f22-27ac-4bfd-939e-c83fb44ad663",
"workflow_name": "A workflow name",
"workflow_execution_group_id": "346f80bb-236f-4aae-86c7-f48845290202"
},
"time": 1668735458
}
Workflow Suggestions Retrieved
{
"event_name": "Workflow Suggestions Retrieved",
"event_type": "workflow",
"event_topic": "suggestions_retrieved",
"patient_identity_id": "9ff3d693-22b9-4216-952a-5ad1d4ecd161",
"payload": {
"workflows": [
{
"workflow_id": "42aa416e-9b0c-4de8-bd3c-ddee82be3df0",
"workflow_name": "A workflow name",
"workflow_execution_group_id": "c8f9b005-4600-46ed-ae47-1198e87f2373"
}
],
"suggestions": [
{
"id": null,
"name": "Do sport",
"description": null,
"achievement_status": "in_progress",
"start_on": "2022-06-09T21:09:36.621Z",
"due_on": null,
"cron_expression": null,
"care_plan_id": null,
"goal_template_id": "b4b50a7d-3163-4b5e-b463-0f3d37f98071",
"created_at": null,
"updated_at": null,
"cms_entry_id": null,
"targets": [
],
"weight": 2,
"type": "goal",
"tag_list": [
"sport"
],
"observations": [
]
},
{
"id": null,
"name": "Call us",
"description": "Do. Or do not. There is no try.",
"achievement_status": "in_progress",
"due_on": null,
"care_plan_id": null,
"task_template_id": "3e52c693-3922-4c21-a602-d5d9113a35fa",
"created_at": null,
"updated_at": null,
"cms_entry_id": null,
"weight": 1,
"type": "task",
"tag_list": [
]
}
]
},
"time": 1668735458
}
Stripe Payments
The following events are related to Stripe Payments. These events relate both to payments created via the Capable system within Stripe and those actions created directly in Stripe for a connected account.
Accounts
Account Updated
{
"event_name": "Account Updated",
"event_type": "account",
"event_topic": "updated",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "acct_1JzMLlAQlaVXLRiN",
"object": "account",
"business_profile": {
"mcc": "5734",
"name": "Capable Health, Inc.",
"product_description": "Capable Health is on a mission to create a world in which every person can achieve their health goals and be their best selves. \n\nTo do this, we’re powering the nextgeneration of healthcare delivery with compliance- and privacy-first infrastructurefocused on behavior change. Our SaaS platform helps care teams close the loop betweencontent and patient engagement, resulting in better clinical outcomes at scale.",
"support_address": {
"city": "New York",
"country": "US",
"line1": "520 Broadway",
"line2": "FL4",
"postal_code": "10012",
"state": "NY"
},
"support_email": "[email protected]",
"support_phone": "+13472514295",
"support_url": null,
"url": "https://capablehealth.com"
},
"capabilities": {
"card_payments": "active",
"transfers": "active"
},
"charges_enabled": true,
"controller": {
"type": "application",
"is_controller": true
},
"country": "US",
"created": 1637763689,
"default_currency": "usd",
"details_submitted": true,
"email": "[email protected]",
"external_accounts": {
"object": "list",
"data": [
{
"id": "ba_1JzMerAQlaVXLRiN6uUTYq9R",
"object": "bank_account",
"account": "acct_1JzMLlAQlaVXLRiN",
"account_holder_name": null,
"account_holder_type": null,
"account_type": null,
"available_payout_methods": [
"standard"
],
"bank_name": "FIRST REPUBLIC BANK",
"country": "US",
"currency": "usd",
"default_for_currency": true,
"fingerprint": "0R2Fu5Q2b9KS37D6",
"last4": "6687",
"metadata": {
},
"routing_number": "321081669",
"status": "new"
}
],
"has_more": false,
"url": "/v1/accounts/acct_1JzMLlAQlaVXLRiN/external_accounts"
},
"future_requirements": {
"alternatives": [
],
"current_deadline": null,
"currently_due": [
],
"disabled_reason": null,
"errors": [
],
"eventually_due": [
],
"past_due": [
],
"pending_verification": [
]
},
"metadata": {
},
"payouts_enabled": true,
"requirements": {
"alternatives": [
],
"current_deadline": null,
"currently_due": [
],
"disabled_reason": null,
"errors": [
],
"eventually_due": [
],
"past_due": [
],
"pending_verification": [
]
},
"settings": {
"bacs_debit_payments": {
},
"branding": {
"icon": "file_1JzRAgAQlaVXLRiNwSKDzAqi",
"logo": "file_1JzRCiAQlaVXLRiNxClAipPI",
"primary_color": "#0000c8",
"secondary_color": "#73eba3"
},
"card_issuing": {
"tos_acceptance": {
"date": null,
"ip": null
}
},
"card_payments": {
"decline_on": {
"avs_failure": false,
"cvc_failure": true
},
"statement_descriptor_prefix": "CPBLHEALTH",
"statement_descriptor_prefix_kanji": null,
"statement_descriptor_prefix_kana": null
},
"dashboard": {
"display_name": "PROD Capable Health",
"timezone": "America/New_York"
},
"payments": {
"statement_descriptor": "CAPABLEHEALTH.COM",
"statement_descriptor_kana": null,
"statement_descriptor_kanji": null
},
"payouts": {
"debit_negative_balances": true,
"schedule": {
"delay_days": 2,
"interval": "daily"
},
"statement_descriptor": null
},
"sepa_debit_payments": {
}
},
"tos_acceptance": {
"date": 1637782194,
"ip": "108.217.126.1",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.45 Safari/537.36"
},
"type": "standard"
},
"time": 1668735458
}
Charges
Charge Captured
{
"event_name": "Charge Captured",
"event_type": "charge",
"event_topic": "captured",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"object": "charge",
"amount": 100,
"amount_captured": 0,
"amount_refunded": 0,
"application": null,
"application_fee": null,
"application_fee_amount": null,
"balance_transaction": "txn_3KP7XFAQlaVXLRiN0bgiZVZq",
"billing_details": {
"address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": null,
"name": "Jenny Rosen",
"phone": null
},
"calculated_statement_descriptor": null,
"captured": false,
"created": 1643903269,
"currency": "usd",
"customer": null,
"description": "My First Test Charge (created for API docs)",
"disputed": false,
"failure_balance_transaction": null,
"failure_code": null,
"failure_message": null,
"fraud_details": {
},
"invoice": null,
"livemode": false,
"metadata": {
},
"on_behalf_of": null,
"outcome": null,
"paid": true,
"payment_intent": null,
"payment_method": "card_1KP7XFAQlaVXLRiNVwqWQ0wW",
"payment_method_details": {
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "pass"
},
"country": "US",
"exp_month": 8,
"exp_year": 2023,
"fingerprint": "wdRZxIx7Pk1AgPBd",
"funding": "credit",
"installments": null,
"last4": "4242",
"mandate": null,
"network": "visa",
"three_d_secure": null,
"wallet": null
},
"type": "card"
},
"receipt_email": null,
"receipt_number": null,
"receipt_url": "https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xSnpNTGxBUWxhVlhMUmlOKL_3gJsGMgbYUjQ4C3Y6LBZtIyRbI-3gLTmS8BwKSkME74hp3svmxaW4_cm5yZBKYAICc3RMbXjAED_M",
"refunded": false,
"refunds": {
"object": "list",
"data": [
],
"has_more": false,
"url": "/v1/charges/ch_3KP7XFAQlaVXLRiN0pQmp4c6/refunds"
},
"review": null,
"shipping": null,
"source_transfer": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
},
"time": 1668735458
}
Charge Expired
{
"event_name": "Charge Expired",
"event_type": "charge",
"event_topic": "expired",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"object": "charge",
"amount": 100,
"amount_captured": 0,
"amount_refunded": 0,
"application": null,
"application_fee": null,
"application_fee_amount": null,
"balance_transaction": "txn_3KP7XFAQlaVXLRiN0bgiZVZq",
"billing_details": {
"address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": null,
"name": "Jenny Rosen",
"phone": null
},
"calculated_statement_descriptor": null,
"captured": false,
"created": 1643903269,
"currency": "usd",
"customer": null,
"description": "My First Test Charge (created for API docs)",
"disputed": false,
"failure_balance_transaction": null,
"failure_code": null,
"failure_message": null,
"fraud_details": {
},
"invoice": null,
"livemode": false,
"metadata": {
},
"on_behalf_of": null,
"outcome": null,
"paid": true,
"payment_intent": null,
"payment_method": "card_1KP7XFAQlaVXLRiNVwqWQ0wW",
"payment_method_details": {
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "pass"
},
"country": "US",
"exp_month": 8,
"exp_year": 2023,
"fingerprint": "wdRZxIx7Pk1AgPBd",
"funding": "credit",
"installments": null,
"last4": "4242",
"mandate": null,
"network": "visa",
"three_d_secure": null,
"wallet": null
},
"type": "card"
},
"receipt_email": null,
"receipt_number": null,
"receipt_url": "https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xSnpNTGxBUWxhVlhMUmlOKL_3gJsGMgbYUjQ4C3Y6LBZtIyRbI-3gLTmS8BwKSkME74hp3svmxaW4_cm5yZBKYAICc3RMbXjAED_M",
"refunded": false,
"refunds": {
"object": "list",
"data": [
],
"has_more": false,
"url": "/v1/charges/ch_3KP7XFAQlaVXLRiN0pQmp4c6/refunds"
},
"review": null,
"shipping": null,
"source_transfer": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
},
"time": 1668735458
}
Charge Failed
{
"event_name": "Charge Failed",
"event_type": "charge",
"event_topic": "failed",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"object": "charge",
"amount": 100,
"amount_captured": 0,
"amount_refunded": 0,
"application": null,
"application_fee": null,
"application_fee_amount": null,
"balance_transaction": "txn_3KP7XFAQlaVXLRiN0bgiZVZq",
"billing_details": {
"address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": null,
"name": "Jenny Rosen",
"phone": null
},
"calculated_statement_descriptor": null,
"captured": false,
"created": 1643903269,
"currency": "usd",
"customer": null,
"description": "My First Test Charge (created for API docs)",
"disputed": false,
"failure_balance_transaction": null,
"failure_code": null,
"failure_message": null,
"fraud_details": {
},
"invoice": null,
"livemode": false,
"metadata": {
},
"on_behalf_of": null,
"outcome": null,
"paid": true,
"payment_intent": null,
"payment_method": "card_1KP7XFAQlaVXLRiNVwqWQ0wW",
"payment_method_details": {
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "pass"
},
"country": "US",
"exp_month": 8,
"exp_year": 2023,
"fingerprint": "wdRZxIx7Pk1AgPBd",
"funding": "credit",
"installments": null,
"last4": "4242",
"mandate": null,
"network": "visa",
"three_d_secure": null,
"wallet": null
},
"type": "card"
},
"receipt_email": null,
"receipt_number": null,
"receipt_url": "https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xSnpNTGxBUWxhVlhMUmlOKL_3gJsGMgbYUjQ4C3Y6LBZtIyRbI-3gLTmS8BwKSkME74hp3svmxaW4_cm5yZBKYAICc3RMbXjAED_M",
"refunded": false,
"refunds": {
"object": "list",
"data": [
],
"has_more": false,
"url": "/v1/charges/ch_3KP7XFAQlaVXLRiN0pQmp4c6/refunds"
},
"review": null,
"shipping": null,
"source_transfer": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
},
"time": 1668735458
}
Charge Pending
{
"event_name": "Charge Pending",
"event_type": "charge",
"event_topic": "pending",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"object": "charge",
"amount": 100,
"amount_captured": 0,
"amount_refunded": 0,
"application": null,
"application_fee": null,
"application_fee_amount": null,
"balance_transaction": "txn_3KP7XFAQlaVXLRiN0bgiZVZq",
"billing_details": {
"address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": null,
"name": "Jenny Rosen",
"phone": null
},
"calculated_statement_descriptor": null,
"captured": false,
"created": 1643903269,
"currency": "usd",
"customer": null,
"description": "My First Test Charge (created for API docs)",
"disputed": false,
"failure_balance_transaction": null,
"failure_code": null,
"failure_message": null,
"fraud_details": {
},
"invoice": null,
"livemode": false,
"metadata": {
},
"on_behalf_of": null,
"outcome": null,
"paid": true,
"payment_intent": null,
"payment_method": "card_1KP7XFAQlaVXLRiNVwqWQ0wW",
"payment_method_details": {
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "pass"
},
"country": "US",
"exp_month": 8,
"exp_year": 2023,
"fingerprint": "wdRZxIx7Pk1AgPBd",
"funding": "credit",
"installments": null,
"last4": "4242",
"mandate": null,
"network": "visa",
"three_d_secure": null,
"wallet": null
},
"type": "card"
},
"receipt_email": null,
"receipt_number": null,
"receipt_url": "https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xSnpNTGxBUWxhVlhMUmlOKL_3gJsGMgbYUjQ4C3Y6LBZtIyRbI-3gLTmS8BwKSkME74hp3svmxaW4_cm5yZBKYAICc3RMbXjAED_M",
"refunded": false,
"refunds": {
"object": "list",
"data": [
],
"has_more": false,
"url": "/v1/charges/ch_3KP7XFAQlaVXLRiN0pQmp4c6/refunds"
},
"review": null,
"shipping": null,
"source_transfer": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
},
"time": 1668735458
}
Charge Refunded
{
"event_name": "Charge Refunded",
"event_type": "charge",
"event_topic": "refunded",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"object": "charge",
"amount": 100,
"amount_captured": 0,
"amount_refunded": 0,
"application": null,
"application_fee": null,
"application_fee_amount": null,
"balance_transaction": "txn_3KP7XFAQlaVXLRiN0bgiZVZq",
"billing_details": {
"address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": null,
"name": "Jenny Rosen",
"phone": null
},
"calculated_statement_descriptor": null,
"captured": false,
"created": 1643903269,
"currency": "usd",
"customer": null,
"description": "My First Test Charge (created for API docs)",
"disputed": false,
"failure_balance_transaction": null,
"failure_code": null,
"failure_message": null,
"fraud_details": {
},
"invoice": null,
"livemode": false,
"metadata": {
},
"on_behalf_of": null,
"outcome": null,
"paid": true,
"payment_intent": null,
"payment_method": "card_1KP7XFAQlaVXLRiNVwqWQ0wW",
"payment_method_details": {
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "pass"
},
"country": "US",
"exp_month": 8,
"exp_year": 2023,
"fingerprint": "wdRZxIx7Pk1AgPBd",
"funding": "credit",
"installments": null,
"last4": "4242",
"mandate": null,
"network": "visa",
"three_d_secure": null,
"wallet": null
},
"type": "card"
},
"receipt_email": null,
"receipt_number": null,
"receipt_url": "https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xSnpNTGxBUWxhVlhMUmlOKL_3gJsGMgbYUjQ4C3Y6LBZtIyRbI-3gLTmS8BwKSkME74hp3svmxaW4_cm5yZBKYAICc3RMbXjAED_M",
"refunded": false,
"refunds": {
"object": "list",
"data": [
],
"has_more": false,
"url": "/v1/charges/ch_3KP7XFAQlaVXLRiN0pQmp4c6/refunds"
},
"review": null,
"shipping": null,
"source_transfer": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
},
"time": 1668735458
}
Charge Succeeded
{
"event_name": "Charge Succeeded",
"event_type": "charge",
"event_topic": "succeeded",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"object": "charge",
"amount": 100,
"amount_captured": 0,
"amount_refunded": 0,
"application": null,
"application_fee": null,
"application_fee_amount": null,
"balance_transaction": "txn_3KP7XFAQlaVXLRiN0bgiZVZq",
"billing_details": {
"address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": null,
"name": "Jenny Rosen",
"phone": null
},
"calculated_statement_descriptor": null,
"captured": false,
"created": 1643903269,
"currency": "usd",
"customer": null,
"description": "My First Test Charge (created for API docs)",
"disputed": false,
"failure_balance_transaction": null,
"failure_code": null,
"failure_message": null,
"fraud_details": {
},
"invoice": null,
"livemode": false,
"metadata": {
},
"on_behalf_of": null,
"outcome": null,
"paid": true,
"payment_intent": null,
"payment_method": "card_1KP7XFAQlaVXLRiNVwqWQ0wW",
"payment_method_details": {
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "pass"
},
"country": "US",
"exp_month": 8,
"exp_year": 2023,
"fingerprint": "wdRZxIx7Pk1AgPBd",
"funding": "credit",
"installments": null,
"last4": "4242",
"mandate": null,
"network": "visa",
"three_d_secure": null,
"wallet": null
},
"type": "card"
},
"receipt_email": null,
"receipt_number": null,
"receipt_url": "https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xSnpNTGxBUWxhVlhMUmlOKL_3gJsGMgbYUjQ4C3Y6LBZtIyRbI-3gLTmS8BwKSkME74hp3svmxaW4_cm5yZBKYAICc3RMbXjAED_M",
"refunded": false,
"refunds": {
"object": "list",
"data": [
],
"has_more": false,
"url": "/v1/charges/ch_3KP7XFAQlaVXLRiN0pQmp4c6/refunds"
},
"review": null,
"shipping": null,
"source_transfer": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
},
"time": 1668735458
}
Charge Updated
{
"event_name": "Charge Updated",
"event_type": "charge",
"event_topic": "updated",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"object": "charge",
"amount": 100,
"amount_captured": 0,
"amount_refunded": 0,
"application": null,
"application_fee": null,
"application_fee_amount": null,
"balance_transaction": "txn_3KP7XFAQlaVXLRiN0bgiZVZq",
"billing_details": {
"address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": null,
"name": "Jenny Rosen",
"phone": null
},
"calculated_statement_descriptor": null,
"captured": false,
"created": 1643903269,
"currency": "usd",
"customer": null,
"description": "My First Test Charge (created for API docs)",
"disputed": false,
"failure_balance_transaction": null,
"failure_code": null,
"failure_message": null,
"fraud_details": {
},
"invoice": null,
"livemode": false,
"metadata": {
},
"on_behalf_of": null,
"outcome": null,
"paid": true,
"payment_intent": null,
"payment_method": "card_1KP7XFAQlaVXLRiNVwqWQ0wW",
"payment_method_details": {
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "pass"
},
"country": "US",
"exp_month": 8,
"exp_year": 2023,
"fingerprint": "wdRZxIx7Pk1AgPBd",
"funding": "credit",
"installments": null,
"last4": "4242",
"mandate": null,
"network": "visa",
"three_d_secure": null,
"wallet": null
},
"type": "card"
},
"receipt_email": null,
"receipt_number": null,
"receipt_url": "https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xSnpNTGxBUWxhVlhMUmlOKL_3gJsGMgbYUjQ4C3Y6LBZtIyRbI-3gLTmS8BwKSkME74hp3svmxaW4_cm5yZBKYAICc3RMbXjAED_M",
"refunded": false,
"refunds": {
"object": "list",
"data": [
],
"has_more": false,
"url": "/v1/charges/ch_3KP7XFAQlaVXLRiN0pQmp4c6/refunds"
},
"review": null,
"shipping": null,
"source_transfer": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
},
"time": 1668735458
}
Charge Disputes
Charge Dispute Closed
{
"event_name": "Charge Dispute Closed",
"event_type": "charge_dispute",
"event_topic": "closed",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "dp_1Lz5QyAQlaVXLRiNU5ijbjot",
"object": "dispute",
"amount": 1000,
"balance_transactions": [
],
"charge": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"created": 1667251336,
"currency": "usd",
"evidence": {
"access_activity_log": null,
"billing_address": null,
"cancellation_policy": null,
"cancellation_policy_disclosure": null,
"cancellation_rebuttal": null,
"customer_communication": null,
"customer_email_address": null,
"customer_name": null,
"customer_purchase_ip": null,
"customer_signature": null,
"duplicate_charge_documentation": null,
"duplicate_charge_explanation": null,
"duplicate_charge_id": null,
"product_description": null,
"receipt": null,
"refund_policy": null,
"refund_policy_disclosure": null,
"refund_refusal_explanation": null,
"service_date": null,
"service_documentation": null,
"shipping_address": null,
"shipping_carrier": null,
"shipping_date": null,
"shipping_documentation": null,
"shipping_tracking_number": null,
"uncategorized_file": null,
"uncategorized_text": null
},
"evidence_details": {
"due_by": 1668902399,
"has_evidence": false,
"past_due": false,
"submission_count": 0
},
"is_charge_refundable": true,
"livemode": false,
"metadata": {
},
"payment_intent": null,
"reason": "general",
"status": "warning_needs_response"
},
"time": 1668735458
}
Charge Dispute Created
{
"event_name": "Charge Dispute Created",
"event_type": "charge_dispute",
"event_topic": "created",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "dp_1Lz5QyAQlaVXLRiNU5ijbjot",
"object": "dispute",
"amount": 1000,
"balance_transactions": [
],
"charge": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"created": 1667251336,
"currency": "usd",
"evidence": {
"access_activity_log": null,
"billing_address": null,
"cancellation_policy": null,
"cancellation_policy_disclosure": null,
"cancellation_rebuttal": null,
"customer_communication": null,
"customer_email_address": null,
"customer_name": null,
"customer_purchase_ip": null,
"customer_signature": null,
"duplicate_charge_documentation": null,
"duplicate_charge_explanation": null,
"duplicate_charge_id": null,
"product_description": null,
"receipt": null,
"refund_policy": null,
"refund_policy_disclosure": null,
"refund_refusal_explanation": null,
"service_date": null,
"service_documentation": null,
"shipping_address": null,
"shipping_carrier": null,
"shipping_date": null,
"shipping_documentation": null,
"shipping_tracking_number": null,
"uncategorized_file": null,
"uncategorized_text": null
},
"evidence_details": {
"due_by": 1668902399,
"has_evidence": false,
"past_due": false,
"submission_count": 0
},
"is_charge_refundable": true,
"livemode": false,
"metadata": {
},
"payment_intent": null,
"reason": "general",
"status": "warning_needs_response"
},
"time": 1668735458
}
Charge Dispute Funds Reinstated
{
"event_name": "Charge Dispute Funds Reinstated",
"event_type": "charge_dispute",
"event_topic": "funds_reinstated",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "dp_1Lz5QyAQlaVXLRiNU5ijbjot",
"object": "dispute",
"amount": 1000,
"balance_transactions": [
],
"charge": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"created": 1667251336,
"currency": "usd",
"evidence": {
"access_activity_log": null,
"billing_address": null,
"cancellation_policy": null,
"cancellation_policy_disclosure": null,
"cancellation_rebuttal": null,
"customer_communication": null,
"customer_email_address": null,
"customer_name": null,
"customer_purchase_ip": null,
"customer_signature": null,
"duplicate_charge_documentation": null,
"duplicate_charge_explanation": null,
"duplicate_charge_id": null,
"product_description": null,
"receipt": null,
"refund_policy": null,
"refund_policy_disclosure": null,
"refund_refusal_explanation": null,
"service_date": null,
"service_documentation": null,
"shipping_address": null,
"shipping_carrier": null,
"shipping_date": null,
"shipping_documentation": null,
"shipping_tracking_number": null,
"uncategorized_file": null,
"uncategorized_text": null
},
"evidence_details": {
"due_by": 1668902399,
"has_evidence": false,
"past_due": false,
"submission_count": 0
},
"is_charge_refundable": true,
"livemode": false,
"metadata": {
},
"payment_intent": null,
"reason": "general",
"status": "warning_needs_response"
},
"time": 1668735458
}
Charge Dispute Funds Withdrawn
{
"event_name": "Charge Dispute Funds Withdrawn",
"event_type": "charge_dispute",
"event_topic": "funds_withdrawn",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "dp_1Lz5QyAQlaVXLRiNU5ijbjot",
"object": "dispute",
"amount": 1000,
"balance_transactions": [
],
"charge": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"created": 1667251336,
"currency": "usd",
"evidence": {
"access_activity_log": null,
"billing_address": null,
"cancellation_policy": null,
"cancellation_policy_disclosure": null,
"cancellation_rebuttal": null,
"customer_communication": null,
"customer_email_address": null,
"customer_name": null,
"customer_purchase_ip": null,
"customer_signature": null,
"duplicate_charge_documentation": null,
"duplicate_charge_explanation": null,
"duplicate_charge_id": null,
"product_description": null,
"receipt": null,
"refund_policy": null,
"refund_policy_disclosure": null,
"refund_refusal_explanation": null,
"service_date": null,
"service_documentation": null,
"shipping_address": null,
"shipping_carrier": null,
"shipping_date": null,
"shipping_documentation": null,
"shipping_tracking_number": null,
"uncategorized_file": null,
"uncategorized_text": null
},
"evidence_details": {
"due_by": 1668902399,
"has_evidence": false,
"past_due": false,
"submission_count": 0
},
"is_charge_refundable": true,
"livemode": false,
"metadata": {
},
"payment_intent": null,
"reason": "general",
"status": "warning_needs_response"
},
"time": 1668735458
}
Charge Dispute Updated
{
"event_name": "Charge Dispute Updated",
"event_type": "charge_dispute",
"event_topic": "updated",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "dp_1Lz5QyAQlaVXLRiNU5ijbjot",
"object": "dispute",
"amount": 1000,
"balance_transactions": [
],
"charge": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"created": 1667251336,
"currency": "usd",
"evidence": {
"access_activity_log": null,
"billing_address": null,
"cancellation_policy": null,
"cancellation_policy_disclosure": null,
"cancellation_rebuttal": null,
"customer_communication": null,
"customer_email_address": null,
"customer_name": null,
"customer_purchase_ip": null,
"customer_signature": null,
"duplicate_charge_documentation": null,
"duplicate_charge_explanation": null,
"duplicate_charge_id": null,
"product_description": null,
"receipt": null,
"refund_policy": null,
"refund_policy_disclosure": null,
"refund_refusal_explanation": null,
"service_date": null,
"service_documentation": null,
"shipping_address": null,
"shipping_carrier": null,
"shipping_date": null,
"shipping_documentation": null,
"shipping_tracking_number": null,
"uncategorized_file": null,
"uncategorized_text": null
},
"evidence_details": {
"due_by": 1668902399,
"has_evidence": false,
"past_due": false,
"submission_count": 0
},
"is_charge_refundable": true,
"livemode": false,
"metadata": {
},
"payment_intent": null,
"reason": "general",
"status": "warning_needs_response"
},
"time": 1668735458
}
Charge Refunds
Charge Refund Updated
{
"event_name": "Charge Refund Updated",
"event_type": "charge_refund",
"event_topic": "updated",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "re_3KP7XFAQlaVXLRiN0uvDsHxv",
"object": "refund",
"amount": 100,
"balance_transaction": null,
"charge": "ch_3KP7XFAQlaVXLRiN0pQmp4c6",
"created": 1667251338,
"currency": "usd",
"metadata": {
},
"payment_intent": null,
"reason": null,
"receipt_number": null,
"source_transfer_reversal": null,
"status": "succeeded",
"transfer_reversal": null
},
"time": 1668735458
}
Customers
Customer Deleted
{
"event_name": "Customer Deleted",
"event_type": "customer",
"event_topic": "deleted",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "cus_MiW6l18dWURd5J",
"object": "customer",
"address": null,
"balance": 0,
"created": 1667249905,
"currency": "usd",
"default_source": null,
"delinquent": false,
"description": null,
"discount": null,
"email": null,
"invoice_prefix": "1F2CEB2",
"invoice_settings": {
"custom_fields": null,
"default_payment_method": null,
"footer": null,
"rendering_options": null
},
"livemode": false,
"metadata": {
},
"name": null,
"next_invoice_sequence": 1,
"phone": null,
"preferred_locales": [
],
"shipping": null,
"tax_exempt": "none",
"test_clock": null
},
"time": 1668735458
}
Customer Updated
{
"event_name": "Customer Updated",
"event_type": "customer",
"event_topic": "updated",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "cus_MiW6l18dWURd5J",
"object": "customer",
"address": null,
"balance": 0,
"created": 1667249905,
"currency": "usd",
"default_source": null,
"delinquent": false,
"description": null,
"discount": null,
"email": null,
"invoice_prefix": "1F2CEB2",
"invoice_settings": {
"custom_fields": null,
"default_payment_method": null,
"footer": null,
"rendering_options": null
},
"livemode": false,
"metadata": {
},
"name": null,
"next_invoice_sequence": 1,
"phone": null,
"preferred_locales": [
],
"shipping": null,
"tax_exempt": "none",
"test_clock": null
},
"time": 1668735458
}
Customer Discounts
Customer Discount Created
{
"event_name": "Customer Discount Created",
"event_type": "customer_discount",
"event_topic": "created",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "di_1Lz5GXAQlaVXLRiNo1uQfds2",
"object": "discount",
"checkout_session": null,
"coupon": {
"id": "Z4OV52SU",
"object": "coupon",
"amount_off": null,
"created": 1667250689,
"currency": "usd",
"duration": "repeating",
"duration_in_months": 3,
"livemode": false,
"max_redemptions": null,
"metadata": {
},
"name": "25.5% off",
"percent_off": 25.5,
"redeem_by": null,
"times_redeemed": 0,
"valid": true
},
"customer": "cus_MiWJKjOb1V3vwN",
"end": 1675199489,
"invoice": null,
"invoice_item": null,
"promotion_code": null,
"start": 1667250689,
"subscription": null
},
"time": 1668735458
}
Customer Discount Deleted
{
"event_name": "Customer Discount Deleted",
"event_type": "customer_discount",
"event_topic": "deleted",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "di_1Lz5GXAQlaVXLRiNo1uQfds2",
"object": "discount",
"checkout_session": null,
"coupon": {
"id": "Z4OV52SU",
"object": "coupon",
"amount_off": null,
"created": 1667250689,
"currency": "usd",
"duration": "repeating",
"duration_in_months": 3,
"livemode": false,
"max_redemptions": null,
"metadata": {
},
"name": "25.5% off",
"percent_off": 25.5,
"redeem_by": null,
"times_redeemed": 0,
"valid": true
},
"customer": "cus_MiWJKjOb1V3vwN",
"end": 1675199489,
"invoice": null,
"invoice_item": null,
"promotion_code": null,
"start": 1667250689,
"subscription": null
},
"time": 1668735458
}
Customer Discount Updated
{
"event_name": "Customer Discount Updated",
"event_type": "customer_discount",
"event_topic": "updated",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "di_1Lz5GXAQlaVXLRiNo1uQfds2",
"object": "discount",
"checkout_session": null,
"coupon": {
"id": "Z4OV52SU",
"object": "coupon",
"amount_off": null,
"created": 1667250689,
"currency": "usd",
"duration": "repeating",
"duration_in_months": 3,
"livemode": false,
"max_redemptions": null,
"metadata": {
},
"name": "25.5% off",
"percent_off": 25.5,
"redeem_by": null,
"times_redeemed": 0,
"valid": true
},
"customer": "cus_MiWJKjOb1V3vwN",
"end": 1675199489,
"invoice": null,
"invoice_item": null,
"promotion_code": null,
"start": 1667250689,
"subscription": null
},
"time": 1668735458
}
Customer Sources
Customer Source Created
{
"event_name": "Customer Source Created",
"event_type": "customer_source",
"event_topic": "created",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "card_1Lz5HoAQlaVXLRiNN4xPKLyf",
"object": "card",
"address_city": null,
"address_country": null,
"address_line1": null,
"address_line1_check": null,
"address_line2": null,
"address_state": null,
"address_zip": null,
"address_zip_check": null,
"brand": "Visa",
"country": "US",
"customer": null,
"cvc_check": "pass",
"dynamic_last4": null,
"exp_month": 8,
"exp_year": 2023,
"fingerprint": "wdRZxIx7Pk1AgPBd",
"funding": "credit",
"last4": "4242",
"metadata": {
},
"name": null,
"tokenization_method": null
},
"time": 1668735458
}
Customer Source Deleted
{
"event_name": "Customer Source Deleted",
"event_type": "customer_source",
"event_topic": "deleted",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "card_1Lz5HoAQlaVXLRiNN4xPKLyf",
"object": "card",
"address_city": null,
"address_country": null,
"address_line1": null,
"address_line1_check": null,
"address_line2": null,
"address_state": null,
"address_zip": null,
"address_zip_check": null,
"brand": "Visa",
"country": "US",
"customer": null,
"cvc_check": "pass",
"dynamic_last4": null,
"exp_month": 8,
"exp_year": 2023,
"fingerprint": "wdRZxIx7Pk1AgPBd",
"funding": "credit",
"last4": "4242",
"metadata": {
},
"name": null,
"tokenization_method": null
},
"time": 1668735458
}
Customer Source Expiring
{
"event_name": "Customer Source Expiring",
"event_type": "customer_source",
"event_topic": "expiring",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "card_1Lz5HoAQlaVXLRiNN4xPKLyf",
"object": "card",
"address_city": null,
"address_country": null,
"address_line1": null,
"address_line1_check": null,
"address_line2": null,
"address_state": null,
"address_zip": null,
"address_zip_check": null,
"brand": "Visa",
"country": "US",
"customer": null,
"cvc_check": "pass",
"dynamic_last4": null,
"exp_month": 8,
"exp_year": 2023,
"fingerprint": "wdRZxIx7Pk1AgPBd",
"funding": "credit",
"last4": "4242",
"metadata": {
},
"name": null,
"tokenization_method": null
},
"time": 1668735458
}
Customer Source Updated
{
"event_name": "Customer Source Updated",
"event_type": "customer_source",
"event_topic": "updated",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "card_1Lz5HoAQlaVXLRiNN4xPKLyf",
"object": "card",
"address_city": null,
"address_country": null,
"address_line1": null,
"address_line1_check": null,
"address_line2": null,
"address_state": null,
"address_zip": null,
"address_zip_check": null,
"brand": "Visa",
"country": "US",
"customer": null,
"cvc_check": "pass",
"dynamic_last4": null,
"exp_month": 8,
"exp_year": 2023,
"fingerprint": "wdRZxIx7Pk1AgPBd",
"funding": "credit",
"last4": "4242",
"metadata": {
},
"name": null,
"tokenization_method": null
},
"time": 1668735458
}
Customer Subscriptions
Customer Subscription Created
{
"event_name": "Customer Subscription Created",
"event_type": "customer_subscription",
"event_topic": "created",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "sub_1Lz5JG2eZvKYlo2COPbStlf3",
"object": "subscription",
"application": null,
"application_fee_percent": null,
"automatic_tax": {
"enabled": false
},
"billing_cycle_anchor": 1667250858,
"billing_thresholds": null,
"cancel_at": null,
"cancel_at_period_end": false,
"canceled_at": null,
"collection_method": "charge_automatically",
"created": 1667250858,
"currency": "usd",
"current_period_end": 1669842858,
"current_period_start": 1667250858,
"customer": "cus_9BoKyB2Km2T7TE",
"days_until_due": null,
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"ended_at": null,
"items": {
"object": "list",
"data": [
{
"id": "si_MiWLDVwT8aKQR9",
"object": "subscription_item",
"billing_thresholds": null,
"created": 1667250858,
"metadata": {
},
"price": {
"id": "price_1Lyxv02eZvKYlo2CEgIjipBH",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667222446,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiOiYa8gr8Hcbd",
"recurring": {
"aggregate_usage": null,
"interval": "month",
"interval_count": 1,
"usage_type": "licensed"
},
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "recurring",
"unit_amount": 1000,
"unit_amount_decimal": "1000"
},
"quantity": 1,
"subscription": "sub_1Lz5JG2eZvKYlo2COPbStlf3",
"tax_rates": [
]
}
],
"has_more": false,
"url": "/v1/subscription_items?subscription=sub_1Lz5JG2eZvKYlo2COPbStlf3"
},
"latest_invoice": null,
"livemode": false,
"metadata": {
},
"next_pending_invoice_item_invoice": null,
"on_behalf_of": null,
"pause_collection": null,
"payment_settings": {
"payment_method_options": null,
"payment_method_types": null,
"save_default_payment_method": null
},
"pending_invoice_item_interval": null,
"pending_setup_intent": null,
"pending_update": null,
"schedule": null,
"start_date": 1667250858,
"status": "active",
"test_clock": null,
"transfer_data": null,
"trial_end": null,
"trial_start": null
},
"time": 1668735458
}
Customer Subscription Deleted
{
"event_name": "Customer Subscription Deleted",
"event_type": "customer_subscription",
"event_topic": "deleted",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "sub_1Lz5JG2eZvKYlo2COPbStlf3",
"object": "subscription",
"application": null,
"application_fee_percent": null,
"automatic_tax": {
"enabled": false
},
"billing_cycle_anchor": 1667250858,
"billing_thresholds": null,
"cancel_at": null,
"cancel_at_period_end": false,
"canceled_at": null,
"collection_method": "charge_automatically",
"created": 1667250858,
"currency": "usd",
"current_period_end": 1669842858,
"current_period_start": 1667250858,
"customer": "cus_9BoKyB2Km2T7TE",
"days_until_due": null,
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"ended_at": null,
"items": {
"object": "list",
"data": [
{
"id": "si_MiWLDVwT8aKQR9",
"object": "subscription_item",
"billing_thresholds": null,
"created": 1667250858,
"metadata": {
},
"price": {
"id": "price_1Lyxv02eZvKYlo2CEgIjipBH",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667222446,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiOiYa8gr8Hcbd",
"recurring": {
"aggregate_usage": null,
"interval": "month",
"interval_count": 1,
"usage_type": "licensed"
},
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "recurring",
"unit_amount": 1000,
"unit_amount_decimal": "1000"
},
"quantity": 1,
"subscription": "sub_1Lz5JG2eZvKYlo2COPbStlf3",
"tax_rates": [
]
}
],
"has_more": false,
"url": "/v1/subscription_items?subscription=sub_1Lz5JG2eZvKYlo2COPbStlf3"
},
"latest_invoice": null,
"livemode": false,
"metadata": {
},
"next_pending_invoice_item_invoice": null,
"on_behalf_of": null,
"pause_collection": null,
"payment_settings": {
"payment_method_options": null,
"payment_method_types": null,
"save_default_payment_method": null
},
"pending_invoice_item_interval": null,
"pending_setup_intent": null,
"pending_update": null,
"schedule": null,
"start_date": 1667250858,
"status": "active",
"test_clock": null,
"transfer_data": null,
"trial_end": null,
"trial_start": null
},
"time": 1668735458
}
Customer Subscription Pending Update Applied
{
"event_name": "Customer Subscription Pending Update Applied",
"event_type": "customer_subscription",
"event_topic": "pending_update_applied",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "sub_1Lz5JG2eZvKYlo2COPbStlf3",
"object": "subscription",
"application": null,
"application_fee_percent": null,
"automatic_tax": {
"enabled": false
},
"billing_cycle_anchor": 1667250858,
"billing_thresholds": null,
"cancel_at": null,
"cancel_at_period_end": false,
"canceled_at": null,
"collection_method": "charge_automatically",
"created": 1667250858,
"currency": "usd",
"current_period_end": 1669842858,
"current_period_start": 1667250858,
"customer": "cus_9BoKyB2Km2T7TE",
"days_until_due": null,
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"ended_at": null,
"items": {
"object": "list",
"data": [
{
"id": "si_MiWLDVwT8aKQR9",
"object": "subscription_item",
"billing_thresholds": null,
"created": 1667250858,
"metadata": {
},
"price": {
"id": "price_1Lyxv02eZvKYlo2CEgIjipBH",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667222446,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiOiYa8gr8Hcbd",
"recurring": {
"aggregate_usage": null,
"interval": "month",
"interval_count": 1,
"usage_type": "licensed"
},
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "recurring",
"unit_amount": 1000,
"unit_amount_decimal": "1000"
},
"quantity": 1,
"subscription": "sub_1Lz5JG2eZvKYlo2COPbStlf3",
"tax_rates": [
]
}
],
"has_more": false,
"url": "/v1/subscription_items?subscription=sub_1Lz5JG2eZvKYlo2COPbStlf3"
},
"latest_invoice": null,
"livemode": false,
"metadata": {
},
"next_pending_invoice_item_invoice": null,
"on_behalf_of": null,
"pause_collection": null,
"payment_settings": {
"payment_method_options": null,
"payment_method_types": null,
"save_default_payment_method": null
},
"pending_invoice_item_interval": null,
"pending_setup_intent": null,
"pending_update": null,
"schedule": null,
"start_date": 1667250858,
"status": "active",
"test_clock": null,
"transfer_data": null,
"trial_end": null,
"trial_start": null
},
"time": 1668735458
}
Customer Subscription Pending Update Expired
{
"event_name": "Customer Subscription Pending Update Expired",
"event_type": "customer_subscription",
"event_topic": "pending_update_expired",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "sub_1Lz5JG2eZvKYlo2COPbStlf3",
"object": "subscription",
"application": null,
"application_fee_percent": null,
"automatic_tax": {
"enabled": false
},
"billing_cycle_anchor": 1667250858,
"billing_thresholds": null,
"cancel_at": null,
"cancel_at_period_end": false,
"canceled_at": null,
"collection_method": "charge_automatically",
"created": 1667250858,
"currency": "usd",
"current_period_end": 1669842858,
"current_period_start": 1667250858,
"customer": "cus_9BoKyB2Km2T7TE",
"days_until_due": null,
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"ended_at": null,
"items": {
"object": "list",
"data": [
{
"id": "si_MiWLDVwT8aKQR9",
"object": "subscription_item",
"billing_thresholds": null,
"created": 1667250858,
"metadata": {
},
"price": {
"id": "price_1Lyxv02eZvKYlo2CEgIjipBH",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667222446,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiOiYa8gr8Hcbd",
"recurring": {
"aggregate_usage": null,
"interval": "month",
"interval_count": 1,
"usage_type": "licensed"
},
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "recurring",
"unit_amount": 1000,
"unit_amount_decimal": "1000"
},
"quantity": 1,
"subscription": "sub_1Lz5JG2eZvKYlo2COPbStlf3",
"tax_rates": [
]
}
],
"has_more": false,
"url": "/v1/subscription_items?subscription=sub_1Lz5JG2eZvKYlo2COPbStlf3"
},
"latest_invoice": null,
"livemode": false,
"metadata": {
},
"next_pending_invoice_item_invoice": null,
"on_behalf_of": null,
"pause_collection": null,
"payment_settings": {
"payment_method_options": null,
"payment_method_types": null,
"save_default_payment_method": null
},
"pending_invoice_item_interval": null,
"pending_setup_intent": null,
"pending_update": null,
"schedule": null,
"start_date": 1667250858,
"status": "active",
"test_clock": null,
"transfer_data": null,
"trial_end": null,
"trial_start": null
},
"time": 1668735458
}
Customer Subscription Trial Will End
{
"event_name": "Customer Subscription Trial Will End",
"event_type": "customer_subscription",
"event_topic": "trial_will_end",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "sub_1Lz5JG2eZvKYlo2COPbStlf3",
"object": "subscription",
"application": null,
"application_fee_percent": null,
"automatic_tax": {
"enabled": false
},
"billing_cycle_anchor": 1667250858,
"billing_thresholds": null,
"cancel_at": null,
"cancel_at_period_end": false,
"canceled_at": null,
"collection_method": "charge_automatically",
"created": 1667250858,
"currency": "usd",
"current_period_end": 1669842858,
"current_period_start": 1667250858,
"customer": "cus_9BoKyB2Km2T7TE",
"days_until_due": null,
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"ended_at": null,
"items": {
"object": "list",
"data": [
{
"id": "si_MiWLDVwT8aKQR9",
"object": "subscription_item",
"billing_thresholds": null,
"created": 1667250858,
"metadata": {
},
"price": {
"id": "price_1Lyxv02eZvKYlo2CEgIjipBH",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667222446,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiOiYa8gr8Hcbd",
"recurring": {
"aggregate_usage": null,
"interval": "month",
"interval_count": 1,
"usage_type": "licensed"
},
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "recurring",
"unit_amount": 1000,
"unit_amount_decimal": "1000"
},
"quantity": 1,
"subscription": "sub_1Lz5JG2eZvKYlo2COPbStlf3",
"tax_rates": [
]
}
],
"has_more": false,
"url": "/v1/subscription_items?subscription=sub_1Lz5JG2eZvKYlo2COPbStlf3"
},
"latest_invoice": null,
"livemode": false,
"metadata": {
},
"next_pending_invoice_item_invoice": null,
"on_behalf_of": null,
"pause_collection": null,
"payment_settings": {
"payment_method_options": null,
"payment_method_types": null,
"save_default_payment_method": null
},
"pending_invoice_item_interval": null,
"pending_setup_intent": null,
"pending_update": null,
"schedule": null,
"start_date": 1667250858,
"status": "trialing",
"test_clock": null,
"transfer_data": null,
"trial_end": null,
"trial_start": null
},
"time": 1668735458
}
Customer Subscription Updated
{
"event_name": "Customer Subscription Updated",
"event_type": "customer_subscription",
"event_topic": "updated",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "sub_1Lz5JG2eZvKYlo2COPbStlf3",
"object": "subscription",
"application": null,
"application_fee_percent": null,
"automatic_tax": {
"enabled": false
},
"billing_cycle_anchor": 1667250858,
"billing_thresholds": null,
"cancel_at": null,
"cancel_at_period_end": false,
"canceled_at": null,
"collection_method": "charge_automatically",
"created": 1667250858,
"currency": "usd",
"current_period_end": 1669842858,
"current_period_start": 1667250858,
"customer": "cus_9BoKyB2Km2T7TE",
"days_until_due": null,
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"ended_at": null,
"items": {
"object": "list",
"data": [
{
"id": "si_MiWLDVwT8aKQR9",
"object": "subscription_item",
"billing_thresholds": null,
"created": 1667250858,
"metadata": {
},
"price": {
"id": "price_1Lyxv02eZvKYlo2CEgIjipBH",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667222446,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiOiYa8gr8Hcbd",
"recurring": {
"aggregate_usage": null,
"interval": "month",
"interval_count": 1,
"usage_type": "licensed"
},
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "recurring",
"unit_amount": 1000,
"unit_amount_decimal": "1000"
},
"quantity": 1,
"subscription": "sub_1Lz5JG2eZvKYlo2COPbStlf3",
"tax_rates": [
]
}
],
"has_more": false,
"url": "/v1/subscription_items?subscription=sub_1Lz5JG2eZvKYlo2COPbStlf3"
},
"latest_invoice": null,
"livemode": false,
"metadata": {
},
"next_pending_invoice_item_invoice": null,
"on_behalf_of": null,
"pause_collection": null,
"payment_settings": {
"payment_method_options": null,
"payment_method_types": null,
"save_default_payment_method": null
},
"pending_invoice_item_interval": null,
"pending_setup_intent": null,
"pending_update": null,
"schedule": null,
"start_date": 1667250858,
"status": "active",
"test_clock": null,
"transfer_data": null,
"trial_end": null,
"trial_start": null
},
"time": 1668735458
}
Customer Tax Ids
Customer Tax Id Created
{
"event_name": "Customer Tax Id Created",
"event_type": "customer_tax_id",
"event_topic": "created",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "txi_1Lz5NiAQlaVXLRiNf42TNqD9",
"object": "tax_id",
"country": "DE",
"created": 123456789,
"customer": "cus_9BoKyB2Km2T7TE",
"livemode": false,
"type": "eu_vat",
"value": "DE123456789",
"verification": {
"status": "pending",
"verified_address": null,
"verified_name": null
}
},
"time": 1668735458
}
Customer Tax Id Deleted
{
"event_name": "Customer Tax Id Deleted",
"event_type": "customer_tax_id",
"event_topic": "deleted",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "txi_1Lz5NiAQlaVXLRiNf42TNqD9",
"object": "tax_id",
"country": "DE",
"created": 123456789,
"customer": "cus_9BoKyB2Km2T7TE",
"livemode": false,
"type": "eu_vat",
"value": "DE123456789",
"verification": {
"status": "pending",
"verified_address": null,
"verified_name": null
}
},
"time": 1668735458
}
Customer Tax Id Updated
{
"event_name": "Customer Tax Id Updated",
"event_type": "customer_tax_id",
"event_topic": "updated",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "txi_1Lz5NiAQlaVXLRiNf42TNqD9",
"object": "tax_id",
"country": "DE",
"created": 123456789,
"customer": "cus_9BoKyB2Km2T7TE",
"livemode": false,
"type": "eu_vat",
"value": "DE123456789",
"verification": {
"status": "pending",
"verified_address": null,
"verified_name": null
}
},
"time": 1668735458
}
Invoices
Invoice Created
{
"event_name": "Invoice Created",
"event_type": "invoice",
"event_topic": "created",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Invoice Deleted
{
"event_name": "Invoice Deleted",
"event_type": "invoice",
"event_topic": "deleted",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Invoice Finalization Failed
{
"event_name": "Invoice Finalization Failed",
"event_type": "invoice",
"event_topic": "finalization_failed",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Invoice Finalized
{
"event_name": "Invoice Finalized",
"event_type": "invoice",
"event_topic": "finalized",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Invoice Marked Uncollectible
{
"event_name": "Invoice Marked Uncollectible",
"event_type": "invoice",
"event_topic": "marked_uncollectible",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Invoice Paid
{
"event_name": "Invoice Paid",
"event_type": "invoice",
"event_topic": "paid",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Invoice Payment Action Required
{
"event_name": "Invoice Payment Action Required",
"event_type": "invoice",
"event_topic": "payment_action_required",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Invoice Payment Failed
{
"event_name": "Invoice Payment Failed",
"event_type": "invoice",
"event_topic": "payment_failed",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Invoice Payment Succeeded
{
"event_name": "Invoice Payment Succeeded",
"event_type": "invoice",
"event_topic": "payment_succeeded",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Invoice Sent
{
"event_name": "Invoice Sent",
"event_type": "invoice",
"event_topic": "sent",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Invoice Upcoming
{
"event_name": "Invoice Upcoming",
"event_type": "invoice",
"event_topic": "upcoming",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Invoice Updated
{
"event_name": "Invoice Updated",
"event_type": "invoice",
"event_topic": "updated",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Invoice Voided
{
"event_name": "Invoice Voided",
"event_type": "invoice",
"event_topic": "voided",
"patient_identity_id": "12075e64-dc05-4684-919b-5840b486f073",
"payload": {
"id": "in_1Lz4ct2eZvKYlo2CWAgRHHk0",
"object": "invoice",
"account_country": "US",
"account_name": "Stripe.com",
"account_tax_ids": null,
"amount_due": 2000,
"amount_paid": 0,
"amount_remaining": 2000,
"application": null,
"application_fee_amount": null,
"attempt_count": 0,
"attempted": false,
"auto_advance": true,
"automatic_tax": {
"enabled": false,
"status": null
},
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": 1667248231,
"currency": "usd",
"custom_fields": null,
"customer": "cus_MiVe3h6Dh3amJ8",
"customer_address": {
"city": "Tbilisi",
"country": "GE",
"line1": "212134",
"line2": "124234",
"postal_code": "12343",
"state": null
},
"customer_email": "[email protected]",
"customer_name": "sdafsdf sdf",
"customer_phone": "+995315324234",
"customer_shipping": null,
"customer_tax_exempt": "none",
"customer_tax_ids": [
{
"type": "eu_vat",
"value": "DE123456789"
}
],
"default_payment_method": null,
"default_source": null,
"default_tax_rates": [
],
"description": null,
"discount": null,
"discounts": [
],
"due_date": null,
"ending_balance": null,
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
"lines": {
"object": "list",
"data": [
{
"id": "il_1Lz4ctAQlaVXLRiNjS3rLOiO",
"object": "line_item",
"amount": 2000,
"amount_excluding_tax": 2000,
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discount_amounts": [
],
"discountable": true,
"discounts": [
],
"invoice_item": "ii_1Lz4ctAQlaVXLRiNHjREJIyg",
"livemode": false,
"metadata": {
},
"period": {
"end": 1667248231,
"start": 1667248231
},
"price": {
"id": "price_1Lz4cK2eZvKYlo2Cr2HtW9CB",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1667248196,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {
},
"nickname": null,
"product": "prod_MiVd9JPDIRcuep",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 2000,
"unit_amount_decimal": "2000"
},
"proration": false,
"proration_details": {
"credited_items": null
},
"quantity": 1,
"subscription": null,
"tax_amounts": [
],
"tax_rates": [
],
"type": "invoiceitem",
"unit_amount_excluding_tax": "2000"
}
],
"has_more": false,
"url": "/v1/invoices/in_1Lz4ct2eZvKYlo2CWAgRHHk0/lines"
},
"livemode": false,
"metadata": {
},
"next_payment_attempt": 1667251831,
"number": null,
"on_behalf_of": null,
"paid": false,
"paid_out_of_band": false,
"payment_intent": null,
"payment_settings": {
"default_mandate": null,
"payment_method_options": null,
"payment_method_types": null
},
"period_end": 1668729600,
"period_start": 1666051200,
"post_payment_credit_notes_amount": 0,
"pre_payment_credit_notes_amount": 0,
"quote": null,
"receipt_number": null,
"rendering_options": null,
"starting_balance": 0,
"statement_descriptor": null,
"status": "draft",
"status_transitions": {
"finalized_at": null,
"marked_uncollectible_at": null,
"paid_at": null,
"voided_at": null
},
"subscription": null,
"subtotal": 2000,
"subtotal_excluding_tax": 2000,
"tax": null,
"test_clock": null,
"total": 2000,
"total_discount_amounts": [
],
"total_excluding_tax": 2000,
"total_tax_amounts": [
],
"transfer_data": null,
"webhooks_delivered_at": null
},
"time": 1668735458
}
Updated 4 months ago