Invoice item events

An invoice item event is an event related to an invoice item that BillingCenter tracks and shows. There are item events for when the item is charged, the item is billed, the item is made due, and so on. View the types of invoice item events in the BillingCenter Application Guide.

You can GET item events through Cloud API. Use the following endpoints to query for item events:

  • GET /charges/{chargeId}/invoice-items/{invoiceItemId}/item-events
  • GET /charges/{chargeId}/invoice-items/{invoiceItemId}/item-events/{itemEventId}

The fields included on the invoice item event vary based on the event itself. For example, for charged item events, there is no transaction field, because no associated transaction has been created. However, a transaction is included for billed item events.

The following example demonstrates retrieving the invoice item events for an invoice item. There are three item events: the item has been charged, billed, and partially paid.

Command
GET /charges/{chargeId}/invoice-items/{invoiceItemId}/item-events
Response 
{
    "count": 3,
    "data": [
        {
            "attributes": {
                "eventDate": "2026-03-22T22:37:10.625Z",
                "eventType": {
                    "code": "charged",
                    "name": "Item Charged"
                },
                "grossAmountChanged": {
                    "amount": "120.00",
                    "currency": "usd"
                },
                "id": "bc:SE04x7r7eK6onaDBo-lmt",
                "invoiceItem": {
                    "displayName": "03/22/2026 ($120.00)",
                    "id": "bc:SD_hqtYcO6JLqwrS7jVC9",
                    "type": "InvoiceItem",
                    "uri": "/billing/v1/charges/bc:S_VGJ4gfefJdQjSR8vFNF/invoice-items/bc:SD_hqtYcO6JLqwrS7jVC9"
                }
            },
            "checksum": "0",
            "links": {
                "self": {
                    "href": "/billing/v1/charges/bc:S_VGJ4gfefJdQjSR8vFNF/invoice-items/bc:SD_hqtYcO6JLqwrS7jVC9/item-events/bc:SE04x7r7eK6onaDBo-lmt",
                    "methods": [
                        "get"
                    ]
                }
            }
        },
        {
            "attributes": {
                "eventDate": "2026-04-22T23:07:55.906Z",
                "eventType": {
                    "code": "billed",
                    "name": "Item Billed"
                },
                "id": "bc:Sep6xzhkuTS9VAjZc67Yh",
                "invoiceItem": {
                    "displayName": "03/22/2026 ($120.00)",
                    "id": "bc:SD_hqtYcO6JLqwrS7jVC9",
                    "type": "InvoiceItem",
                    "uri": "/billing/v1/charges/bc:S_VGJ4gfefJdQjSR8vFNF/invoice-items/bc:SD_hqtYcO6JLqwrS7jVC9"
                },
                "transaction": {
                    "displayName": "Premium Billed",
                    "id": "bc:SgJV9zdTHOIUaHGcg0wHL",
                    "type": "Transaction",
                    "uri": "/billing/v1/transactions/bc:SgJV9zdTHOIUaHGcg0wHL"
                }
            },
            "checksum": "0",
            "links": {
                "self": {
                    "href": "/billing/v1/charges/bc:S_VGJ4gfefJdQjSR8vFNF/invoice-items/bc:SD_hqtYcO6JLqwrS7jVC9/item-events/bc:Sep6xzhkuTS9VAjZc67Yh",
                    "methods": [
                        "get"
                    ]
                }
            }
        },
        {
            "attributes": {
                "eventDate": "2026-04-22T23:07:55.940Z",
                "eventType": {
                    "code": "payment",
                    "name": "Payment Received"
                },
                "grossAmountChanged": {
                    "amount": "-50.00",
                    "currency": "usd"
                },
                "id": "bc:SaSQmnumCgmRPSWtWtr6h",
                "invoiceItem": {
                    "displayName": "03/22/2026 ($120.00)",
                    "id": "bc:SD_hqtYcO6JLqwrS7jVC9",
                    "type": "InvoiceItem",
                    "uri": "/billing/v1/charges/bc:S_VGJ4gfefJdQjSR8vFNF/invoice-items/bc:SD_hqtYcO6JLqwrS7jVC9"
                },
                "transaction": {
                    "displayName": "Premium Paid From Account",
                    "id": "bc:SJ11L_BopIT_kw01X64ii",
                    "type": "Transaction",
                    "uri": "/billing/v1/transactions/bc:SJ11L_BopIT_kw01X64ii"
                }
            },
            "checksum": "0",
            "links": {
                "self": {
                    "href": "/billing/v1/charges/bc:S_VGJ4gfefJdQjSR8vFNF/invoice-items/bc:SD_hqtYcO6JLqwrS7jVC9/item-events/bc:SaSQmnumCgmRPSWtWtr6h",
                    "methods": [
                        "get"
                    ]
                }
            }
        }
    ],
    ...
}