Skip to main content

Payment Completed

The PAYMENT_COMPLETED event is triggered when a payment is completed for a case.

Attributes​

eventstring
The name of the event that was triggered. For this webhook, the value will always be PAYMENT_COMPLETED.
payloadobject
Contains all the data associated with the payment completion event.
Show child attributes
caseobject
An object containing the full details of the case at the time of the event.
Show child attributes
idstring<UUID>
The unique identifier for the case.
typestring
The type or category of the case (e.g., "GLP").
titlestring
The title of the case.
statusstring
Allowed values:OPEN,ASSIGNED,IN_PROGRESS,APPROVED,REJECTED,NO_DECISION
The current status of the case.
shortIdstring
A short, human-readable identifier for the case.
createdAtstring<date-time>
The timestamp when the case was created.
updatedAtstring<date-time>
The timestamp when the case was last updated.
assignedAtstring<date-time>
The timestamp when an assignee was first added to the case.
inProgressAtstring<date-time>
The timestamp when the case status changed to "IN_PROGRESS".
closedAtstring<date-time>
The timestamp when the case was closed. null if still open.
isArchivedboolean
Indicates if the case is closed/archived.
isEscalatedboolean
Indicates if the case is escalated.
isImportedboolean
Indicates if the case is imported from outside.
referralCodestring
Indicates if user have any referralCode.
closedBystring
The unique identifier for the user that case mark close.
inProgressBystring
The unique identifier for the user which make case in InProgress.
organizationIdstring<UUID>
The unique identifier for the case belongs which organization.
archiveReasonstring
Allowed values:COMPLETE,INELIGIBLE
Indicates if the case is archived any reason status.
archiveNotestring
Indicates if the case is archived any reason for it, null if still open.
productBundleIdstring<UUID>
The unique identifier for the case belongs which product bundle.
productBundleobject
Details about the product bundle associated with the case.
Show child attributes
namestring
Indicates case product bundle name.
submitterobject
An object containing the details of the user who submitted the case.
Show child attributes
idstring
The unique identifier of the submitter.
firstNamestring
The first name of the submitter.
lastNamestring
The last name of the submitter.
emailstring
The email address of the submitter.
dobstring<date-time>
The date of birth of the submitter in ISO 8601 format.
genderstring
The gender of the submitter (e.g., MALE, FEMALE, OTHER).
phoneNumberstring
The phone number of the submitter, including country code.
addressstring
The primary address line of the submitter.
address2string
The secondary address line of the submitter, if applicable.
citystring
The city of the submitter's address.
statestring
The state or province of the submitter's address.
postalCodestring
The postal code of the submitter's address.
callerobject
Details of cancellation if the meeting was cancelled (empty if the meeting is still active).
Show child attributes
idstring<UUID>
The unique identifier of the user who deleted the attachment.
firstNamestring
The first name of the user who deleted the attachment.
lastNamestring
The last name of the user who deleted the attachment.
emailstring
The email address of the user who deleted the attachment.
activityobject
An object that describes the specific action that triggered this webhook.
Show child attributes
idstring<UUID>
The unique identifier for this activity log entry.
typestring
Allowed values:CREATE_CASE,CHANGE_CASE_STATUS,ADD_CASE_COMMENT,DELETE_CASE_COMMENT,ADD_CASE_DECISION,ARCHIVE_CASE,ESCALATE_CASE,DEESCALATE_CASE,ADD_CASE_ESCALATION,REMOVE_CASE_ESCALATION,UPDATE_CASE_ESCALATION,DECISION_DELETED,ADD_CASE_ATTACHMENT,ADD_CASE_ASSIGNEE,REMOVE_CASE_ASSIGNEE,IMPORT_CASE,ADD_FORM_RESPONSE,UPDATE_FORM_RESPONSE,ADD_HR_REP,REMOVE_HR_REP,DELETE_ATTACHMENT,FOLLOWUP_EMAIL,PAYMENT_ADDED,PAYMENT_COMPLETED,PAYMENT_DELETED,PAYMENT_UPDATED,ORDER_CREATED,TEXT_INFO,REOPEN_CASE,SMS_SENT,SMS_RECEIVED,INBOUND_EMAIL,OUTBOUND_EMAIL,FOLLOWUP_FORM,ORDER_STATUS_CHANGED,ORDER_TRACKING_ADDED,PAYMENT_INFO_LINK_SENT,ADD_PAYMENT_INFO_USING_LINK,CALENDAR_EVENT_CREATED,CALENDAR_EVENT_RESCHEDULED,CALENDAR_EVENT_CANCELED,CALENDAR_EVENT_NO_SHOW,CALENDAR_EVENT_NO_SHOW_REMOVED,SUPPORT_NOTE_ADDED,SUPPORT_NOTE_UPDATED,SUPPORT_NOTE_COMPLETED,COMMENT_ACKNOWLEDGED,NOTE_ACKNOWLEDGED,VISIT_TYPE_CHANGED,PAYMENT_PREAUTHORIZED,SUBSCRIPTION_ADDED,SUBSCRIPTION_ACTIVATED,SUBSCRIPTION_COMPLETED,SUBSCRIPTION_PAUSED,SUBSCRIPTION_RESUMED,SUBSCRIPTION_CANCELLED,SUBSCRIPTION_UPDATED
The type of activity.
isPHIboolean
Indicates if the activity contains Protected Health Information (PHI).
isRestrictedboolean
Indicates if the activity details are restricted to internal users due to sensitivity (for example, payment data).
valueBeforestring | null
The previous value before this activity, if any. For this event, usually `null`.
valueAfterstring | null
A short description of the result of the activity, such as `payment info has been added`.
timestampstring<date-time>
The exact timestamp when the activity occurred.
actorobject
The user who performed the action (i.e., who added the new assignee).
Show child attributes
idstring<UUID>
The ID of the actor.
firstNamestring
The first name of the actor.
lastNamestring
The last name of the actor.
emailstring
The email of the actor.
targetUserobject
The user who was the target of the action (i.e., the user who was assigned).
Show child attributes
idstring<UUID>
The ID of the assigned user.
firstNamestring
The first name of the assigned user.
lastNamestring
The last name of the assigned user.
emailstring
The email of the assigned user.
paymentobject
Details about the payment that was completed.
Show child attributes
idstring<UUID>
The unique identifier of the payment.
isDeletedboolean
Indicates if the payment is deleted.
descriptionstring
Description of the payment.
amountstring
The total amount of the payment.
statusstring
The status of the payment (e.g., PAID).
dueDatestring<date-time>
The due date for the payment in ISO 8601 format.
paymentDatestring<date-time> | null
The date the payment was completed.
cancellationDatestring<date-time> | null
The date the payment was cancelled, or null if not cancelled.
isScheduledboolean
Indicates if the payment is scheduled for a future date.
schedulePositionstring | null
The position of the scheduled payment, or null.
isAutoCreatedboolean
Indicates if the payment was automatically created by the system.
createdAtstring<date-time>
The timestamp when the payment record was created.
updatedAtstring<date-time>
The timestamp when the payment record was last updated.
feesobject
A breakdown of the fees included in this payment.
Show child attributes
consultFeestring
The consultation fee amount.
convenienceFeestring
The convenience fee amount.
paymentProcessingFeestring
The payment processing fee amount.
pharmacyFeestring
The pharmacy fee amount.
shippingFeestring
The shipping fee amount.
syringeKitFeestring
The syringe kit fee amount.
techPlatformFeestring
The technology platform fee amount.
subFeesarray<object>
A list of additional sub-fees.
Show child attributes
labelstring
The label or name of the sub-fee.
amountstring
The amount of the sub-fee.
createdByobject
Details about the user who created the payment.
Show child attributes
idstring<UUID>
The unique identifier of the user.
firstNamestring
The first name of the user.
lastNamestring
The last name of the user.
emailstring
The email address of the user.

Response​

{
  "event": "PAYMENT_COMPLETED",
  "payload": {
    "case": {
      "id": "b5fb3880-6b04-4e58-bc41-c31b5af34aa4",
      "type": "GLP",
      "title": "Case for John Doe",
      "status": "APPROVED",
      "shortId": "ADA-B27JJ2",
      "createdAt": "2025-07-24T11:01:35.751Z",
      "updatedAt": "2025-09-23T05:41:00.411Z",
      "assignedAt": null,
      "inProgressAt": "2025-07-24T11:03:18.193Z",
      "closedAt": "2025-07-24T11:23:45.094Z",
      "isArchived": false,
      "isEscalated": false,
      "isImported": false,
      "referralCode": null,
      "closedBy": "AKhRITtBmPQSLslHonl3RN9yKCt1",
      "inProgressBy": "2C131c9AO3bllQvp41ew7AgFWB12",
      "organizationId": "67756751-7d58-4c8b-abd0-91f3d973c527",
      "archiveReason": null,
      "archiveNote": null,
      "productBundleId": "2b015ac0-c7bc-4ba7-bc8a-cdef017ea691",
      "productBundle": {
        "id": "2b015ac0-c7bc-4ba7-bc8a-cdef017ea691",
        "name": "ORG-PRODUCT-BUNDLE-1"
      },
      "submitter": {
        "id": "5fcvJx1m2adICwDZUbI7MQRhTjD2",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john@example.com",
        "dob": "1970-07-15T00:00:00.000Z",
        "gender": "MALE",
        "phoneNumber": "+12131231231",
        "address": "4575 Webb Bridge Rd",
        "address2": null,
        "city": "Alpharetta",
        "state": "MD",
        "postalCode": "30005"
      }
    },
    "activity": {
      "id": "52c8e54f-6fdf-48a8-a079-c9b2381ad0b3",
      "type": "PAYMENT_COMPLETED",
      "isPHI": false,
      "isRestricted": false,
      "timestamp": "2026-01-05T12:56:21.000Z",
      "valueBefore": null,
      "valueAfter": "A $500.00 USD payment was processed using a visa ending in 4242",
      "actor": {
        "id": "EC3DGOBxNqanQ7gQPrtODNk0Sz13",
        "firstName": "Sarah",
        "lastName": "Williams",
        "email": "sarah@example.com"
      },
      "targetUser": null
    },
    "payment": {
      "id": "1aa431b6-bc67-48df-95db-2146357f7eaa",
      "isDeleted": false,
      "description": "Compounded Semaglutide",
      "amount": "500",
      "status": "PAID",
      "dueDate": "2026-01-05T00:00:00.000Z",
      "paymentDate": "2026-01-05T12:56:21.000Z",
      "cancellationDate": null,
      "isScheduled": false,
      "schedulePosition": null,
      "isAutoCreated": false,
      "createdAt": "2026-01-05T12:52:05.859Z",
      "updatedAt": "2026-01-05T12:56:22.492Z",
      "fees": {
        "consultFee": "30",
        "convenienceFee": "375.5",
        "paymentProcessingFee": "19.5",
        "pharmacyFee": "0",
        "shippingFee": "45",
        "syringeKitFee": "5",
        "techPlatformFee": "25",
        "subFees": [
          {
            "label": "Affiliate 1",
            "amount": "0.5"
          },
          {
            "label": "Affiliate 2",
            "amount": "1"
          }
        ]
      },
      "createdBy": {
        "id": "EC3DGOBxNqanQ7gQPrtODNk0Sz13",
        "firstName": "Sarah",
        "lastName": "Williams",
        "email": "sarah@example.com"
      }
    }
  }
}