Skip to main content

Get Settlements

GET 

/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. pagination.total is counted on every page, cursor pages included.

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 (string or null, required).

Request​