PATCH
/
commissions
/
{id}
PHP
declare(strict_types=1);

require 'vendor/autoload.php';

use Dub;

$sdk = Dub\Dub::builder()
    ->setSecurity(
        'DUB_API_KEY'
    )
    ->build();



$response = $sdk->commissions->update(
    id: 'cm_1JVR7XRCSR0EDBAF39FZ4PMYE',
    requestBody: $requestBody

);

if ($response->object !== null) {
    // 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

Response

200
application/json

The updated commission.

The response is of type object.