BillKit/DocsConsole
Events

Get event

Retrieve one event, including its full data payload.

GET/v1/events/{event_id}
Operation get_event·Scope events:read·OpenAPI v1.1.0

Parameters

ParameterDescription
event_idstring · pathrequiredId of the event, which starts evt_.

Returns

Returns an EventResponse object.

Errors

StatusCause
400The 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.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the events:read scope.
404No such object in this account and mode.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X GET https://api.billkit.eu/v1/events/evt_9XKp2vQ1 \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "created": 1789392000,
  "customer": {
    "country_code": "NL",
    "email": "ada@example.com",
    "id": "obj_9XKp2vQ1",
    "name": "Ada Lovelace",
    "object": "customer.summary"
  },
  "data": {
    "key": "value"
  },
  "id": "evt_9XKp2vQ1",
  "livemode": false,
  "object": "event",
  "previous_attributes": {
    "key": "value"
  },
  "type": "checkout.session.completed"
}