Skip to main content

Get Settlements

GET 

/v1/profitability/settlements

Page through channel statements in the inclusive statementDate window. The response also includes payout cadence for accounts with statements outside that window. Requires profitability.read.

Request and response fields at a glance
  • Query parameters: sortBy (string), sortOrder (string), page (integer), limit (integer), brandIds (array), saleChannelIds (array), startDate (string, required), endDate (string, required).
  • 200 response (application/json): settlements (array, required), cadences (array, required), pagination (object, required), noSignalReason (mixed, required).

Request​