Skip to main content
images/hint_health.svg

Events

Triggering Webhook Types

The following event types are associated with the Customer Invoice event payload from Hint Health.
  • Hint Health Customer Invoice Created
  • Hint Health Customer Invoice Updated
{
  "amount_in_cents": 5000,
  "charges": [
    {
      "amount_in_cents": 5000,
      "description": "Monthly membership fee",
      "id": "chg-ab12C345DeF6",
      "service_date": null
    }
  ],
  "charges_count": 1,
  "created_at": null,
  "date": null,
  "due_in_cents": 5000,
  "human_status": "paid",
  "id": "inv-ab12C345DeF6",
  "integration_record_id": "ext-12345",
  "invoice_number": 1042,
  "last_sent_at": null,
  "last_viewed_at": null,
  "owner": {
    "id": "pat-ab12C345DeF6",
    "name": "Gordon Thomas Sumner"
  },
  "paid_at": null,
  "paid_in_cents": 5000,
  "payment_status": "paid",
  "payments_count": 1,
  "provider_web_link": "https://app.hint.com/invoices/inv-ab12C345DeF6",
  "received_in_cents": 5000,
  "status": "paid",
  "subtotal_in_cents": 5000,
  "tax_in_cents": 0,
  "total_in_cents": 5000,
  "updated_at": null
}
{
  "amount_in_cents": "Total amount of the invoice in cents",
  "charges": {
    "amount_in_cents": "Charge amount in cents",
    "description": "Description of the charge",
    "id": "Unique identifier for the charge",
    "service_date": "Date the service was provided"
  },
  "charges_count": "Number of charges on the invoice",
  "created_at": "Timestamp when the invoice was created",
  "date": "Invoice date",
  "due_in_cents": "Amount due in cents",
  "human_status": "Human-readable status of the invoice",
  "id": "Unique identifier for the customer invoice",
  "integration_record_id": "External system identifier",
  "invoice_number": "Sequential invoice number",
  "last_sent_at": "Timestamp when the invoice was last sent",
  "last_viewed_at": "Timestamp when the invoice was last viewed",
  "owner": {
    "id": "Unique identifier for the invoice owner",
    "name": "Name of the invoice owner"
  },
  "paid_at": "Timestamp when the invoice was paid",
  "paid_in_cents": "Amount paid in cents",
  "payment_status": "Payment status of the invoice",
  "payments_count": "Number of payments received",
  "provider_web_link": "URL to the invoice in the provider portal",
  "received_in_cents": "Amount received in cents",
  "status": "Status of the invoice",
  "subtotal_in_cents": "Subtotal amount in cents before tax",
  "tax_in_cents": "Tax amount in cents",
  "total_in_cents": "Total invoice amount in cents including tax",
  "updated_at": "Timestamp when the invoice was last updated"
}

Payload Field Details

Customer Invoice
Event Payload