Sign in

v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Audit logs

List audit logs

Retrieve existing audit logs. Sorted by happened_at descending.

get/v1/audit-logs

Query parameters

limitnumber

Maximum number of items to return (1-100).

Example:50

Maximum number of items to return (1-100).

cursorstring

Opaque cursor returned in the previous response's next_cursor. Omit to fetch the first page.

Opaque cursor returned in the previous response's next_cursor. Omit to fetch the first page.

boolean
OR
'true' | 'false'

Set to true to include total in the response.

customer_idstring

Return only entries attached to this customer ID.

Example:cus_Typ0px2W0aiEtl

Return only entries attached to this customer ID.

subscription_idstring

Return only entries attached to this subscription ID.

Example:sub_amiaWZ3lzDIWaoT

Return only entries attached to this subscription ID.

invoice_idstring

Return only entries attached to this invoice ID.

Example:inv_1eTaiytfA0i2Va

Return only entries attached to this invoice ID.

quote_idstring

Return only entries attached to this quote ID.

Example:quo_1eTaiytfA0i2Va

Return only entries attached to this quote ID.

Response

next_cursorstring nullable required

Cursor to fetch the next page. null when there are no more items.

has_moreboolean required

Whether more items are available after this page.

totalnumber

Total number of items matching the filters. Only present when include_total=true was passed.

Example response

{
  "data": [
    {
      "type": "invoice.electronic_invoice.sent",
      "happened_at": "2024-10-20T14:32:11.000Z",
      "customer_id": "cus_Typ0px2W0aiEtl",
      "invoice_id": "inv_1eTaiytfA0i2Va"
    }
  ],
  "total": 1
}