Payouts

List canceled payout windows

Returns billing periods that were explicitly canceled and removed from the payout queue.

get/payouts/canceled

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/payouts/canceled
  • Auth: API key in header x-api-key

Query parameters

pagenumber

Page number (1-based index)

Example:1
perPagenumber

Number of items per page (1-100)

Example:10
sortColstring

Sort column

Example:publishedAt
sortDir'asc' | 'desc'

Sort direction

Example:asc
campaignIdsstring[] 
[
  "orgcamp_RwmraAffhMt9"
]
creatorIdsstring[]
includeEmptyboolean

Include zero-amount payouts in the results. They are excluded by default.

mode'data' | 'count'

Response

OK

pageinteger required
perPageinteger required
totalinteger required

Example response

{
  "data": [
    {
      "campaignId": "orgcamp_RwmraAffhMt9",
      "campaignStatus": "active",
      "timeZone": "UTC",
      "startsAt": "2026-10-05T00:00:00.000-04:00",
      "endsAt": "2026-10-12T00:00:00.000-04:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.