Update a commission
update_commissionAdjust an existing commission amount or status to process partial/full refunds, duplicates, cancellations, or fraudulent sales; paid commissions cannot be changed.
Instructions
Update an existing commission amount. This is useful for handling refunds (partial or full) or fraudulent sales.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The commission's unique ID on Dub. | |
| amount | No | Deprecated. Use `saleAmount` instead. | |
| status | No | Useful for marking a commission as pending, refunded, duplicate, canceled, or fraudulent. Takes precedence over `saleAmount` and `modifySaleAmount`. When a commission is marked as pending, refunded, duplicate, canceled, or fraudulent, it will be omitted from the payout, and the payout amount will be recalculated accordingly. Paid commissions cannot be updated. | |
| account | No | Exact configured private workspace profile label; not a tenant or provider account ID. | |
| confirm | No | Must be true for the requested mutation or exclusive private output file. | |
| payload | No | Complete native JSON body; do not mix with body flags or payload_file. Arrays use repeated JSON object flags or a whole native array in a private file. | |
| currency | No | The currency of the sale amount to update. Accepts ISO 4217 currency codes. | usd |
| earnings | No | The new earnings amount for the commission. Paid commissions cannot be updated. If provided, will override the earnings calculated based on the sale amount and currency. | |
| saleAmount | No | The new absolute amount for the sale. Paid commissions cannot be updated. | |
| modifyAmount | No | Deprecated. Use `modifySaleAmount` instead. | |
| payload_file | No | Absolute regular non-symlink JSON body file, at most 1 MiB. Cannot mix with payload/body flags. | |
| modifySaleAmount | No | Modify the current sale amount: use positive values to increase the amount, negative values to decrease it. Takes precedence over `saleAmount`. Paid commissions cannot be updated. |