Skip to main content

LedgerPageDto

data object[]required
  • Array [
  • actorUserIdobjectnullable
    balanceAfternumberrequired
    clientReqIdobjectnullable
    createdAtdate-timerequired
    deltanumberrequired
    effectiveQuotaAtEventobjectnullablerequired
    eventTypestringrequired

    Possible values: [consume, release, addon_granted, addon_revoked, period_reset, tier_changed, subscription_canceled]

    idstringrequired
    metadata objectrequired
    property name*any
    metricIdstringrequired
    metricSlugstringrequired
    periodStartobjectnullable
    sourcestringrequired

    Possible values: [agent_api, admin, system, stripe_webhook]

    subscriptionIdstringrequired
  • ]
  • nextCursorobjectnullablerequired

    Pass back as ?cursor= to fetch the next page.

    LedgerPageDto
    {
    "data": [
    {
    "actorUserId": {},
    "balanceAfter": 0,
    "clientReqId": {},
    "createdAt": "2024-07-29T15:51:28.071Z",
    "delta": 0,
    "effectiveQuotaAtEvent": {},
    "eventType": "consume",
    "id": "string",
    "metadata": {},
    "metricId": "string",
    "metricSlug": "string",
    "periodStart": {},
    "source": "agent_api",
    "subscriptionId": "string"
    }
    ],
    "nextCursor": {}
    }