BillKit/DocsConsole
Audit logs

Get audit log

Retrieve one audit entry, including the details recorded with it.

GET/v1/audit_logs/{audit_log_id}
Operation get_audit_log·Scope audit_logs:read·OpenAPI v1.1.0

Parameters

ParameterDescription
audit_log_idstring · pathrequiredId of the audit log entry, which starts al_.

Returns

Returns an AuditLogResponse 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 audit_logs: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/audit_logs/al_4b2a1e907c3d4f189a551c0b6de3a742 \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "action": "tenant.created",
  "actor_id": "actor_9XKp2vQ1",
  "actor_type": "api_key",
  "created": 1789392000,
  "id": "al_4b2a1e907c3d4f189a551c0b6de3a742",
  "ip_address": "string",
  "livemode": false,
  "metadata": {
    "key": "value"
  },
  "object": "audit_log",
  "resource_id": "resource_9XKp2vQ1",
  "resource_type": "string",
  "user_agent": "string"
}