Update Commission

This endpoint updates a commission.

PUT https://api.tolt.com/v1/commissions/:id

cURL

curl -X PUT 'https://api.tolt.com/v1/commissions/comm_eK9bzRGn46BhVgNFHD6fDgXW' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
    "amount": 2999,
    "status": "approved",
    "revenue": 14999
}'

Response

{
  "success": true,
  "data": [
    {
      "id": "comm_eK9bzRGn46BhVgNFHD6fDgXW",
      "revenue": "14999",
      "charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
      "charge_status": "paid",
      "source": "manual",
      "status": "approved",
      "type": "reward",
      "currency": null,
      "partner_id": "part_JE3mfL9dfdffci7sFaJazAv2",
      "organization_id": "org_JEsdfL9dfci7sFaJazAv2",
      "program_id": "prg_YRdddbPDAKhWfdqhJbeh",
      "transaction_id": "txn_7m46BhVkjkgNFHD6fDgXW",
      "customer_id": "cust_d6BhVgNFHD6fDgkjkjXW",
      "payout_id": null,
      "created_at": "2025-04-25T09:36:10.858Z",
      "updated_at": "2025-04-25T09:36:10.858Z",
      "amount": "2999",
      "scheduled_approval_date": null,
      "approval_type": "immediate",
      "flow_id": "flw_FX567GZjkn7RtaKbEuFatWw"
    }
  ]
}

Base URL https://api.tolt.com

Body Parameters

amount · number - optional

The commission amount in cents

transaction_id · string - optional

Associated transaction identifier

charge_id · string - optional

Associated charge identifier

source · string - optional

Source of the commission

status · string - optional

Commission status. Valid values are: ‘pending’, ‘approved’, ‘paid’, ‘rejected’, ‘refunded’

revenue · number - optional

The revenue amount in cents

created_at · string - optional

ISO 8601 timestamp of when the commission was created

Response

success · boolean

Whether the request was successful

data · array[object]

Hide properties

id · string

Unique identifier for the commission

amount · number

Commission amount in cents

customer_id · string

ID of the associated customer

transaction_id · string

Associated transaction identifier

charge_id · string

Associated charge identifier

charge_status · string

Status of the related charge (e.g. “paid”, “failed”)

source · string

Source of the commission

status · string

Commission status

type · string

Type of commission (e.g. “reward”, “referral”)

currency · string | null

Currency of the commission (ISO currency code) or null if not set

revenue · number

Revenue amount in cents

created_at · string

ISO 8601 timestamp of creation

updated_at · string

ISO 8601 timestamp of update

partner_id · string

ID of the partner who earned the commission

program_id · string

Program ID the commission belongs to

organization_id · string

Organization ID

payout_id · string | null

ID of the payout if the commission has been paid, otherwise null

scheduled_approval_date · string | null

Scheduled approval date if applicable, otherwise null

approval_type · string

Approval type for the commission (e.g. “immediate”, “manual”)

flow_id · string

ID of the flow that generated the commission

cURL

curl -X PUT 'https://api.tolt.com/v1/commissions/comm_eK9bzRGn46BhVgNFHD6fDgXW' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
    "amount": 2999,
    "status": "approved",
    "revenue": 14999
}'

Response

{
  "success": true,
  "data": [
    {
      "id": "comm_eK9bzRGn46BhVgNFHD6fDgXW",
      "revenue": "14999",
      "charge_id": "ch_9bzRGn46BhVgNFHD6fDgXW",
      "charge_status": "paid",
      "source": "manual",
      "status": "approved",
      "type": "reward",
      "currency": null,
      "partner_id": "part_JE3mfL9dfdffci7sFaJazAv2",
      "organization_id": "org_JEsdfL9dfci7sFaJazAv2",
      "program_id": "prg_YRdddbPDAKhWfdqhJbeh",
      "transaction_id": "txn_7m46BhVkjkgNFHD6fDgXW",
      "customer_id": "cust_d6BhVgNFHD6fDgkjkjXW",
      "payout_id": null,
      "created_at": "2025-04-25T09:36:10.858Z",
      "updated_at": "2025-04-25T09:36:10.858Z",
      "amount": "2999",
      "scheduled_approval_date": null,
      "approval_type": "immediate",
      "flow_id": "flw_FX567GZjkn7RtaKbEuFatWw"
    }
  ]
}