本文へスキップ
Sursa Developers

イベント · 料金と請求

credits.low

クレジット残高が少ない

期間のクレジット残高が利用量のしきい値を超えました(data.threshold、割り当て量に対する使用済みの割合)。しきい値と期間ごとに一度だけ送信されます。

オブジェクトの種類
org
配信先
adminロールのWebhook

ペイロード

オブジェクト:EventCreditsLow

  • idstring必須

    イベントのID(evt_…)。webhook-idヘッダーとしても送信されます。重複した配信を破棄するために使ってください。

  • typestring必須

    指定できる値: credits.low

  • created_atstring (date-time)必須

    変更が発生した日時(UTC)。

  • org_idinteger必須
  • api_versionstring必須

    dataスキーマの契約のバージョン。

  • sequenceinteger

    Webhook内での配信の連番(テストイベントにはありません)。

  • objectWebhookEventObject必須
  • payloadstring必須

    thinはdataがないことを意味します:APIでオブジェクトを読み取ってください。

    指定できる値: fullthin

  • dataobject
    フィールド
    • thresholdinteger必須

      割り当て量の使用率のしきい値(パーセント):80または100。

    • period_startstring (date)必須
    • balancenumber
    • allowancenumber
  • testboolean必須

    POST /v1/webhooks/{webhook_id}/testで送信されたテストイベント。

配信の例

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "credits.low",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "org",
    "id": "1"
  },
  "payload": "full",
  "data": {
    "threshold": 80,
    "period_start": "2026-10-01",
    "balance": 1000,
    "allowance": 5000
  },
  "test": false
}

イベントの受信

各配信は、このJSONボディを持つPOSTリクエストとしてWebhookの受信先URLに送られます。ボディを信頼する前にwebhook-signatureヘッダー(Standard Webhooks)を検証し、数秒以内に2xxステータスで応答してから、処理を行ってください。1つのWebhookへの配信はイベントの順序を保ちます。失敗した配信は間隔を広げながら再試行されます。

新しいイベントタイプや新しいフィールドはいつでも追加されることがあります。知らないタイプとフィールドは無視してください。

同じイベントは30日間イベントフィードで確認できます →