Platform API

List lifecycle events

Read an ordered cursor-based stream of organization billing changes.

GEThttps://app.mindbill.org/partner/v2/events

Persist bill IDs immediately from component callbacks, then use events or signed webhooks as the authoritative server-side synchronization channel.

AuthenticationBearer server API key

Permissions by credentialServer API key

IdempotencyNot required

This endpoint requires a server API key and is unavailable to browser sessions. See the component API inventory for exact paths and SDK methods.

Query parameters

FieldTypeDescription

cursor

string

Opaque cursor from the previous page.

limit

number

Maximum events to return.

Examples

curl "https://app.mindbill.org/partner/v2/events?cursor=$CURSOR&limit=100" \
  --header "Authorization: Bearer $MINDBILL_API_KEY"

Response

200 OK

{
  "events": [{
    "id": "evt_01J6Z2",
    "sequence": "1842",
    "type": "bill.status.updated",
    "apiVersion": "2026-08-29",
    "createdAt": "2026-08-29T18:42:11.000Z",
    "data": { "billId": "bill_01J6Y7F4Q4XK6P3J9G2C8A1B5D", "state": "processed" }
  }],
  "nextCursor": "cursor_1842"
}

FieldTypeDescription

events[].idRequired

string

Stable event identifier for deduplication.

events[].sequenceRequired

string

Organization-ordering sequence.

events[].typeRequired

string

Lifecycle event type.

events[].apiVersionRequired

string

Event schema version.

events[].createdAtRequired

string

ISO event timestamp.

events[].dataRequired

object

Event-specific payload containing bill and transition identifiers.

nextCursorRequired

string | null

Cursor to persist after processing the page.