Waterfall Download Output

The response containing the pricing waterfall data for the requested line items.

JSON example

{
  "success": true,
  "message": null,
  "code": "200",
  "lineItemResults": [
    {
      "currencyCode": "USD",
      "error": null,
      "executionEndTimestamp": "2023-07-31T20:11:29.625Z",
      "executionId": "gdLVwn2x1uats2xWMAjV",
      "executionStartTimestamp": null,
      "lineItemId": "item1",
      "success": true,
      "usageType": "Pricing",
      "output": {
        "quantity": "10",
        "netUnitPrice": "10",
        "subtotal": "100"
      },
      "waterfall": []
    },
    {
      "currencyCode": "USD",
      "error": null,
      "executionEndTimestamp": "2023-07-31T20:12:15.000Z",
      "executionId": "hdMWxo3y2vbut3xXNBlW",
      "executionStartTimestamp": null,
      "lineItemId": "item2",
      "success": true,
      "usageType": "Pricing",
      "output": {
        "quantity": "5",
        "netUnitPrice": "8",
        "subtotal": "40"
      },
      "waterfall": []
    }
  ]
}

Properties

Property Name	Type	Description
`success`	Boolean	Indicates whether the request finished normally and returned waterfall data for at least one line item (`true`), or whether the request was invalid, every line item failed, or an unhandled exception occurred (`false`).
`message`	String	A failure message, if applicable.
`code`	String	The API response code. Returns `200` when the request is processed successfully, including partial success. Returns `500` when the request is invalid, when all line items fail, or when an unhandled exception occurs.
`lineItemResults`	List<Line Item Waterfall Response>	An array of waterfall results for each requested line item.