---
title: "Cancel a payout window"
method: POST
path: "/payouts/cancel"
tags: ["Payouts"]
---

# Cancel a payout window

`POST /payouts/cancel`

## Request

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

Marks a completed billing window as canceled so it is excluded from payout calculations.

## Request body

- object
  - `campaignId` string, required: Campaign ID with orgcamp_ prefix
  - `creatorId` string, required: Organization creator ID with orgcre_ prefix
  - `billingPeriodStart` string, date-time, required
  - `billingPeriodEnd` string, date-time, required
  - `reasonNote` string

## Response `200`

OK

- object
  - `success` unknown, required

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `404`: 404
- `408`: 408
- `409`: 409
- `429`: 429
- `500`: 500

---

[API](https://skmtc.dev/viral/apis/viral-app-api.md) · [All operations](https://skmtc.dev/viral/apis/viral-app-api/llms.txt) · [OpenAPI document](https://skmtc.dev/viral/apis/viral-app-api/revisions/31e97fa79ef1?raw)