Update a commission

Update an existing commission amount. This is useful for handling refunds (partial or full) or fraudulent sales.

PATCH /commissions/{id}

Python

Python

from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.commissions.update(request={
        "id": "cm_1JVR7XRCSR0EDBAF39FZ4PMYE",
    })

    # Handle response
    print(res)

200

{
  "id": "cm_1JVR7XRCSR0EDBAF39FZ4PMYE",
  "amount": 123,
  "earnings": 123,
  "currency": "<string>",
  "status": "pending",
  "invoiceId": "<string>",
  "description": "<string>",
  "quantity": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "partner": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "image": "<string>",
    "payoutsEnabledAt": "<string>",
    "country": "<string>",
    "groupId": "<string>"
  },
  "type": "click",
  "userId": "<string>",
  "customer": {
    "id": "<string>",
    "name": "<string>",
    "externalId": "<string>",
    "createdAt": "<string>",
    "email": "<string>",
    "avatar": "<string>",
    "stripeCustomerId": "<string>",
    "country": "<string>",
    "sales": 123,
    "saleAmount": 123,
    "firstSaleAt": "<string>",
    "subscriptionCanceledAt": "<string>"
  }
}

Commissions endpoints require an Business plan subscription or higher.

Authorizations

Authorization · string · header · required

Default authentication mechanism

Path Parameters

id · string · required

The commission's unique ID on Dub.

Example:

"cm_1JVR7XRCSR0EDBAF39FZ4PMYE"

Body

application/json

earnings · number

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.

Required range: x >= 0

saleAmount · number

The new absolute amount for the sale. Paid commissions cannot be updated.

Required range: x >= 0

modifySaleAmount · number

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.

currency · string · default: usd

The currency of the sale amount to update. Accepts ISO 4217 currency codes.

status · enum<string>

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.

Available options: pending, refunded, duplicate, canceled, fraud

amount · number · deprecated

Deprecated. Use saleAmount instead.

Required range: x >= 0

modifyAmount · number · deprecated

Deprecated. Use modifySaleAmount instead.

Response

200

application/json

The updated commission.

id · string · required

The commission's unique ID on Dub.

Example:

"cm_1JVR7XRCSR0EDBAF39FZ4PMYE"

amount · number · required

earnings · number · required

currency · string · required

status · enum<string> · required

Available options: pending, processed, paid, refunded, duplicate, fraud, canceled

invoiceId · string | null · required

description · string | null · required

quantity · number · required

createdAt · string · required

updatedAt · string · required

partner · object · required

Show child attributes

type · enum<string>

Available options: click, lead, sale, custom

userId · string | null

The user who created the manual commission.

customer · object

Show child attributes