Update a commission
Update an existing commission amount. This is useful for handling refunds (partial or full) or fraudulent sales.
Authorizations
Default authentication mechanism
Path Parameters
The commission's unique ID on Dub.
"cm_1JVR7XRCSR0EDBAF39FZ4PMYE"
Body
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.
x >= 0The new absolute amount for the sale. Paid commissions cannot be updated.
x >= 0Modify 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.
The currency of the sale amount to update. Accepts ISO 4217 currency codes.
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.
pending, refunded, duplicate, canceled, fraud Deprecated. Use saleAmount instead.
x >= 0Deprecated. Use modifySaleAmount instead.
Response
The updated commission.
The commission's unique ID on Dub.
"cm_1JVR7XRCSR0EDBAF39FZ4PMYE"
The type of commission. Can be click, lead, sale, referral, or custom.
click, lead, sale, referral, custom The associated event amount in cents. For sale commissions, this is the sale amount.
The amount earned by the partner, in cents.
The currency of the commission, as an ISO 4217 currency code.
The current status of the commission.
pending, processed, paid, refunded, duplicate, fraud, canceled, hold The associated invoice ID. Only set for sale commissions.
An optional description of the commission.
The event quantity. Used for click and lead commissions; typically 1 for sale and custom commissions.
User-provided metadata from the associated lead or sale event (lead.metadata / sale.metadata).
The date and time when the commission was created.
The date and time when the commission was last updated.
The date the commission was paid out to the partner. Null if not paid yet.
The user who created the manual commission.