Skip to main content
PATCH
/
api
/
v2
/
network
/
commission-plan
/
{id}
Update commission plan (PATCH)
curl --request PATCH \
  --url https://{domain}/api/v2/network/commission-plan/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "string",
  "status": 1,
  "product": 1,
  "currency": "USD",
  "assigned_to": [
    1
  ]
}
'
import requests

url = "https://{domain}/api/v2/network/commission-plan/{id}"

payload = {
"title": "string",
"status": 1,
"product": 1,
"currency": "USD",
"assigned_to": [1]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({title: 'string', status: 1, product: 1, currency: 'USD', assigned_to: [1]})
};

fetch('https://{domain}/api/v2/network/commission-plan/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v2/network/commission-plan/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'string',
'status' => 1,
'product' => 1,
'currency' => 'USD',
'assigned_to' => [
1
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://{domain}/api/v2/network/commission-plan/{id}"

payload := strings.NewReader("{\n \"title\": \"string\",\n \"status\": 1,\n \"product\": 1,\n \"currency\": \"USD\",\n \"assigned_to\": [\n 1\n ]\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://{domain}/api/v2/network/commission-plan/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"string\",\n \"status\": 1,\n \"product\": 1,\n \"currency\": \"USD\",\n \"assigned_to\": [\n 1\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/network/commission-plan/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"string\",\n \"status\": 1,\n \"product\": 1,\n \"currency\": \"USD\",\n \"assigned_to\": [\n 1\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "<string>"
}
{
"status": "error",
"code": 422,
"name": "Unprocessable Entity",
"message": "<string>",
"info": {
"errors": {}
}
}

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Path Parameters

id
integer
required

Commission plan ID.

Body

application/json
title
string
status
integer
product
integer
currency
string | null

Currency code. Only accepted when native_currency_commissions is ON. Null or omitted = Brand Currency.

assigned_to
integer[]

Affiliate IDs. Deleted affiliates are ignored during validation and are removed from existing assignments on update.

flat_fee
object

Fixed recurring or one-time fee. Past dates are accepted for commission.start_date.

cpa
object
rev_share
object

Response

Commission plan updated.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string