PATCH
/
commissions
/
{id}
Go
package main

import(
	"context"
	dubgo "github.com/dubinc/dub-go"
	"github.com/dubinc/dub-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := dubgo.New(
        dubgo.WithSecurity("DUB_API_KEY"),
    )

    res, err := s.Commissions.Update(ctx, operations.UpdateCommissionRequest{
        ID: "cm_1JVR7XRCSR0EDBAF39FZ4PMYE",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}
{
  "id": "cm_1JVR7XRCSR0EDBAF39FZ4PMYE",
  "type": "click",
  "amount": 123,
  "earnings": 123,
  "currency": "<string>",
  "status": "pending",
  "invoiceId": "<string>",
  "description": "<string>",
  "quantity": 123,
  "userId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "partner": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "image": "<string>",
    "payoutsEnabledAt": "<string>",
    "country": "<string>"
  },
  "customer": {
    "id": "<string>",
    "externalId": "<string>",
    "name": "<string>",
    "email": "<string>",
    "avatar": "<string>",
    "country": "<string>",
    "sales": 123,
    "saleAmount": 123,
    "createdAt": "<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
amount
number

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

Required range: x >= 0
modifyAmount
number

Modify the current sale amount: use positive values to increase the amount, negative values to decrease it. Takes precedence over amount. 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 refunded, duplicate, canceled, or fraudulent. Takes precedence over amount and modifyAmount. When a commission is marked as 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:
refunded,
duplicate,
canceled,
fraud

Response

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
type
enum<string>
Available options:
click,
lead,
sale,
custom
userId
string | null

The user who created the manual commission.

customer
object | null