BillKitEvents
Stream events
Receive this account's events as they happen, over Server-Sent Events.
GET/v1/events/stream
Parameters
| Parameter | Description |
|---|---|
| typearray of enum · queryoptional | Only events of these exact types, comma-separated, such as invoice.paid,invoice.voided. No wildcards. An unknown type is a 400. |
| starting_afterstring | null · queryoptional | Resume after this event id instead of starting from now. The stream replays every event recorded after it, in order, then continues live. Any of your event ids works, from this stream, GET /v1/events or a webhook. Unknown ids are rejected with a 400. At most 128 characters. |
| Last-Event-IDstring | nulloptional | Standard SSE resume header, sent automatically by a browser EventSource on reconnect. Used only when starting_after is absent. |
Errors
| Status | Cause |
|---|---|
| 400 | The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it. |
| 401 | No credential, or one that does not authenticate. |
| 402 | The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused). |
| 403 | Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the events:read scope. |
| 404 | No such object in this account and mode. |
| 429 | Rate limited. Retry-After says when to try again. |
| 500 | Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key. |
| 503 | Temporarily unable to serve. reason says whether the request was attempted. |
Other events operations
- List events GET /v1/events
- Get event GET /v1/events/{event_id}