platform
billing-usage-api

Receive billing usage result

Receives data response requested by the Query billing usage data endpoint. This webhook is called once via POST when the query completes.

postWebhookreceive-billing-usage-result

Payload

requestIdstring required

Identifier of the original request, returned by Query billing usage data endpoint.

status'SUCCESS' | 'FAILED' required

Status of the request. If successful, the response will contain aggregated data. If failed, it will contain failure message.

failureMessagestring

Message describing the failure. Returned only if the request failed.

Example payload

{
  "response": {
    "requestedPeriod": {
      "sentSince": "2023-04-01T00:00:00Z",
      "sentUntil": "2023-04-01T00:00:00Z"
    }
  },
  "metadata": {
    "clientRequestedPeriod": {
      "sentSince": "2023-04-01T00:00:00Z",
      "sentUntil": "2023-04-01T00:00:00Z"
    },
    "billingPeriods": [
      {
        "month": "2026-03"
      }
    ]
  }
}

Response

Your server returns this code if it accepts the callback.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.