BillKit/Docs Console
Events

Stream events

Hold a connection open and receive this account's events as they happen.

GET/v1/events/stream
Operation stream_events · Scope events:read · Spec snapshot 2026-09-13

Parameters

ParameterDescription
typesstring | null · queryoptionalAt most 512 characters.
starting_afterstring | null · queryoptionalResume after this event id instead of starting from now. The stream replays every event recorded after it, in order, then continues live. Unknown ids are rejected with a 400. At most 128 characters.
Last-Event-IDstring | nulloptionalStandard SSE resume header, sent automatically by a browser EventSource on reconnect. Used only when starting_after is absent.

Errors

Status Cause
401 Missing or invalid API key.
403 Key is missing the events:read scope.
422 Validation Error
429 Rate limited. Back off and retry.
Request · curl
curl -X GET https://api.billkit.eu/v1/events/stream \
  -H "Authorization: Bearer $BILLKIT_SECRET_KEY"