v1

latestOpenAPI 3.1.02026-07-222392081.7 MB

Invoices > Events

List invoice events

Retrieve billable events for an invoice, with per-event pricing computed against the invoice's billing rules. Works for any invoice status: draft and open invoices compute pricing live, finalized invoices serve the snapshot taken at issuance. Per-event amounts are gross — discounts (coupons, percentage, fixed amount) are applied at the line-item or invoice level, not redistributed across events. Use the invoice endpoint to read discount_amount if you need the net.

get/v1/invoices/{id}/events

Path parameters

idstring required

Query parameters

takenumber nullable

skipnumber nullable

order'asc' | 'desc'

Sort direction.

Example:desc

Sort direction.

sort'timestamp'

Field used to sort the results.

product_idstring

product_id__notstring

product_id__isNullstring

product_id__isNotNullstring

product_id__equalsstring

product_id__containsstring

product_id__startsWithstring

product_id__endWithstring

event_typestring

event_type__notstring

event_type__isNullstring

event_type__isNotNullstring

event_type__equalsstring

event_type__containsstring

event_type__startsWithstring

event_type__endWithstring

timestampstring date-time

timestamp__notstring date-time

timestamp__isNullstring date-time

timestamp__isNotNullstring date-time

timestamp__equalsstring date-time

timestamp__ltstring date-time

timestamp__ltestring date-time

timestamp__gtstring date-time

timestamp__gtestring date-time

Response

Example response

{
  "meta": {
    "total": 1,
    "taken": 1
  },
  "data": [
    {
      "id": "evt_01HW8R3K2N9YV5Z7TQXJ4M2GHD",
      "name": "API call from europe-west1",
      "event_type": "api_call",
      "timestamp": "2024-10-20T14:32:11.000Z",
      "properties": {
        "region": "europe-west1",
        "endpoint": "/v1/customers"
      },
      "billing": {
        "invoice_id": "inv_1eTaiytfA0i2Va",
        "invoice_line_item_id": "ili_0FACNpeoEFkGu3",
        "product_id": "itm_KbLcWt2qm5p1S2",
        "amount": 12,
        "amount_excluding_tax": 10,
        "currency": "EUR"
      }
    }
  ]
}