BillKit/DocsConsole
Audit logs

List audit logs

List the record of who changed what in your account, newest first.

GET/v1/audit_logs
Operation list_audit_logs·Scope audit_logs:read·OpenAPI v1.1.0

Parameters

ParameterDescription
actionstring | null · queryoptionalOnly entries with exactly this action, such as subscription.canceled. At most 64 characters.
resource_typestring | null · queryoptionalOnly entries about this type of object, such as subscription. Exact match. At most 32 characters.
resource_idstring | null · queryoptionalOnly entries about the object with this id. Exact match. At most 64 characters.
actor_idstring | null · queryoptionalOnly entries made by this actor: an API key's id (ak_...) or a console operator's id. Exact match. At most 64 characters.
limitinteger · queryoptionalMaximum number of objects to return. Defaults to 10. Between 1 and 100.
starting_afterstring | null · queryoptionalCursor for pagination: the id of the last object on the previous page. Returns the objects listed after it. An id that names no such object is a 400. At most 128 characters.

Cursor-paginated. limit caps a page and starting_after takes the last id you saw.

Returns

Returns a page of AuditLogResponse objects. data holds the page and has_more says whether another one exists. Page forward by passing the last id of the page as starting_after; a short page is not the end of the list.

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 \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "data": [
    {
      "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"
    }
  ],
  "has_more": false,
  "object": "list"
}