Invoice Paid | Webhook Events - HoopAI Help Center

The InvoicePaid event fires when the total amount due on an invoice reaches zero, indicating full payment has been received. Use this event to trigger service provisioning, send thank-you emails, update revenue records, or unlock gated content for the paying contact.

Payload

Field	Type	Description
`_id`	`string`	Unique identifier for the invoice
`status`	`string`	Invoice status at time of event — will be `"paid"`
`liveMode`	`boolean`	`true` when the event originates from a live account; `false` in test mode
`amountPaid`	`number`	Total amount paid — equals the invoice `total` on full payment
`altId`	`string`	Account (location) ID associated with the invoice
`altType`	`string`	Resource type for `altId` — always `"location"`
`name`	`string`	Internal name assigned to the invoice
`businessDetails`	`object`	Sender business information (name, address, phone, website, logo URL)
`invoiceNumber`	`string`	Human-readable invoice number
`currency`	`string`	ISO 4217 currency code (e.g., `USD`)
`contactDetails`	`object`	Recipient contact information (id, email, name, company name)
`issueDate`	`string`	Date the invoice was issued (`YYYY-MM-DD`)
`dueDate`	`string`	Payment due date (`YYYY-MM-DD`)
`discount`	`object`	Discount applied to the invoice (`type` and `value`)
`invoiceItems`	`array`	Line items on the invoice, each containing name, quantity, amount, currency, and taxes
`total`	`number`	Total invoice value
`title`	`string`	Display title shown on the invoice document (e.g., `"INVOICE"`)
`amountDue`	`number`	Remaining balance owed — will be `0` on full payment
`createdAt`	`string`	ISO 8601 timestamp when the invoice was created
`updatedAt`	`string`	ISO 8601 timestamp of the most recent update
`totalSummary`	`object`	Summary object containing `subTotal` and `discount` amounts

Example payload

{
  "_id": "6578278e879ad2646715ba9c",
  "status": "paid",
  "liveMode": false,
  "amountPaid": 999,
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "New Invoice",
  "businessDetails": {
    "name": "ABC Corp.",
    "address": "9931 Beechwood, TX",
    "phoneNo": "+1-214-559-6993",
    "website": "wwww.example.com",
    "logoUrl": "https://example.com/logo.png"
  },
  "invoiceNumber": "19",
  "currency": "USD",
  "contactDetails": {
    "id": "6578278e879ad2646715ba9c",
    "email": "alex@example.com",
    "name": "Alex",
    "companyName": "ABC Corp."
  },
  "issueDate": "2023-01-01",
  "dueDate": "2023-01-01",
  "discount": { "type": "percentage", "value": 10 },
  "invoiceItems": [
    {
      "taxes": [],
      "_id": "c6tZZU0rJBf30ZXx9Gli",
      "currency": "USD",
      "name": "Macbook Pro",
      "qty": 1,
      "amount": 999
    }
  ],
  "total": 999,
  "title": "INVOICE",
  "amountDue": 0,
  "createdAt": "2023-12-12T09:27:42.355Z",
  "updatedAt": "2023-12-12T09:27:42.355Z",
  "totalSummary": { "subTotal": 999, "discount": 0 }
}

Invoice Partially Paid — fires when a partial payment is recorded
Invoice Sent — fires when the invoice is delivered to the contact
Invoices API — create, retrieve, and manage invoices programmatically

​Payload

​Example payload

​Related

Payload

Example payload

Related