Notice

idstringrequired

seqinteger<int64>required

Per-account, strictly increasing.

kindNoticeKindrequired

Possible values: [credits.low, cap.threshold, cap.reached, payg.escrow_low, payg.escrow_empty, service.halted, service.resumed, renewal.upcoming, renewal.succeeded, renewal.skipped, plan.lapsed, plan.queued_started, deposit.credited, grant.received, grant.expiring, senders.changed, tariff.scheduled, tariff.activated, tariff.cancelled, ru_schedule.scheduled, ru_schedule.activated, tier.status_changed, relayer.draining, incident.opened, incident.updated, incident.resolved, intent.expired_locally, intent.final, api_key.created, api_key.revoked, webhook.disabled, webhook.test, account.suspended]

severitystringrequired

Possible values: [info, warning, critical]

scopestringrequired

Possible values: [account, global]

createdAtMsinteger<int64>required

Unix time in milliseconds.

Possible values: >= 0

effectiveAtMs(integer | null)<int64>nullable

When the change this notice announces takes effect, in Unix milliseconds, for example the start of a scheduled tariff. Null when the notice announces no change.

expiresAtMs(integer | null)<int64>nullable

acknowledgedAtMs(integer | null)<int64>nullable

titlestringrequired

messagestringrequired

data object

property name*any

links object[]

Array [

relstringrequired

hrefstring<uri>required

]

Notice

{
  "id": "string",
  "seq": 0,
  "kind": "credits.low",
  "severity": "info",
  "scope": "account",
  "createdAtMs": 0,
  "effectiveAtMs": 0,
  "expiresAtMs": 0,
  "acknowledgedAtMs": 0,
  "title": "string",
  "message": "string",
  "data": {},
  "links": [
    {
      "rel": "string",
      "href": "string"
    }
  ]
}