Create a commission rule

curl --request POST \
  --url https://api.journeybee.io/v1/commissions/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "tier_uuids": [
    "<string>"
  ],
  "category_uuids": [
    "<string>"
  ],
  "partnership_uuids": [
    "<string>"
  ]
}
'

import requests

url = "https://api.journeybee.io/v1/commissions/"

payload = {
    "label": "<string>",
    "tier_uuids": ["<string>"],
    "category_uuids": ["<string>"],
    "partnership_uuids": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    tier_uuids: ['<string>'],
    category_uuids: ['<string>'],
    partnership_uuids: ['<string>']
  })
};

fetch('https://api.journeybee.io/v1/commissions/', 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://api.journeybee.io/v1/commissions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'tier_uuids' => [
        '<string>'
    ],
    'category_uuids' => [
        '<string>'
    ],
    'partnership_uuids' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.journeybee.io/v1/commissions/"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"tier_uuids\": [\n    \"<string>\"\n  ],\n  \"category_uuids\": [\n    \"<string>\"\n  ],\n  \"partnership_uuids\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("https://api.journeybee.io/v1/commissions/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"tier_uuids\": [\n    \"<string>\"\n  ],\n  \"category_uuids\": [\n    \"<string>\"\n  ],\n  \"partnership_uuids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.journeybee.io/v1/commissions/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"tier_uuids\": [\n    \"<string>\"\n  ],\n  \"category_uuids\": [\n    \"<string>\"\n  ],\n  \"partnership_uuids\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "uuid": "<string>",
  "label": "<string>",
  "partner_type": "referral",
  "payment_target": "partnership",
  "auto_assign_recipient": "lead_creator",
  "calculation": {
    "entries": [
      {
        "payment_stage_id": 123,
        "calculation": {
          "type": "oneOff",
          "option": "fixed",
          "value": "<string>",
          "scalingConfig": {
            "customFieldId": 123,
            "tiers": [
              {
                "optionId": 123,
                "option": "fixed",
                "value": 123
              }
            ]
          },
          "recurring_period": "weekly",
          "number_of_occurrences": 123,
          "periodRates": {
            "enabled": true,
            "periods": [
              {
                "periodNumber": 123,
                "startOccurrence": 123,
                "endOccurrence": 123,
                "option": "fixed",
                "value": 123,
                "scalingConfig": {
                  "customFieldId": 123,
                  "tiers": [
                    {
                      "optionId": 123,
                      "option": "fixed",
                      "value": 123
                    }
                  ]
                }
              }
            ]
          },
          "split": {
            "oneOff": {
              "type": "oneOff",
              "option": "fixed",
              "value": "<string>",
              "scalingConfig": {
                "customFieldId": 123,
                "tiers": [
                  {
                    "optionId": 123,
                    "option": "fixed",
                    "value": 123
                  }
                ]
              },
              "recurring_period": "weekly",
              "number_of_occurrences": 123,
              "periodRates": {
                "enabled": true,
                "periods": [
                  {
                    "periodNumber": 123,
                    "startOccurrence": 123,
                    "endOccurrence": 123,
                    "option": "fixed",
                    "value": 123,
                    "scalingConfig": {
                      "customFieldId": 123,
                      "tiers": [
                        {
                          "optionId": 123,
                          "option": "fixed",
                          "value": 123
                        }
                      ]
                    }
                  }
                ]
              }
            },
            "recurring": {
              "type": "oneOff",
              "option": "fixed",
              "value": "<string>",
              "scalingConfig": {
                "customFieldId": 123,
                "tiers": [
                  {
                    "optionId": 123,
                    "option": "fixed",
                    "value": 123
                  }
                ]
              },
              "recurring_period": "weekly",
              "number_of_occurrences": 123,
              "periodRates": {
                "enabled": true,
                "periods": [
                  {
                    "periodNumber": 123,
                    "startOccurrence": 123,
                    "endOccurrence": 123,
                    "option": "fixed",
                    "value": 123,
                    "scalingConfig": {
                      "customFieldId": 123,
                      "tiers": [
                        {
                          "optionId": 123,
                          "option": "fixed",
                          "value": 123
                        }
                      ]
                    }
                  }
                ]
              }
            }
          }
        }
      }
    ]
  },
  "tiers": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "categories": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "partnerships": [
    {
      "uuid": "<string>",
      "name": "<string>"
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

Commissions

Create a commission rule

Create a commission rule with calculation entries. Optionally scope to specific tiers, categories, or partnerships via their UUIDs.

Calculation structure

The calculation object contains entries — an array of payment triggers:

{
  "entries": [
    {
      "payment_stage_id": 123,
      "calculation": {
        "type": "oneOff",
        "option": "percentage",
        "value": 10
      }
    }
  ]
}

Calculation types

oneOff: Single payment when stage is reached. option: fixed (flat amount), percentage (of deal value), or scaling (varies by custom field).
recurring: Multiple payments over time. Additional fields: recurring_period (weekly/monthly/quarterly/yearly), number_of_occurrences. Supports periodRates for variable rates per period.
split: Different calculations for one-off and recurring components. Contains split.oneOff and split.recurring sub-calculations.

Scaling

When option is scaling, provide scalingConfig with customFieldId and tiers array mapping custom field option IDs to fixed/percentage values.

Scoping

Commissions can be scoped to apply only to specific partners:

tier_uuids — apply to partners in these tiers
category_uuids — apply to partners in these categories
partnership_uuids — apply to these specific partnerships (highest priority)

POST

commissions

Create a commission rule

curl --request POST \
  --url https://api.journeybee.io/v1/commissions/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "tier_uuids": [
    "<string>"
  ],
  "category_uuids": [
    "<string>"
  ],
  "partnership_uuids": [
    "<string>"
  ]
}
'

import requests

url = "https://api.journeybee.io/v1/commissions/"

payload = {
    "label": "<string>",
    "tier_uuids": ["<string>"],
    "category_uuids": ["<string>"],
    "partnership_uuids": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    tier_uuids: ['<string>'],
    category_uuids: ['<string>'],
    partnership_uuids: ['<string>']
  })
};

fetch('https://api.journeybee.io/v1/commissions/', 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://api.journeybee.io/v1/commissions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'tier_uuids' => [
        '<string>'
    ],
    'category_uuids' => [
        '<string>'
    ],
    'partnership_uuids' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.journeybee.io/v1/commissions/"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"tier_uuids\": [\n    \"<string>\"\n  ],\n  \"category_uuids\": [\n    \"<string>\"\n  ],\n  \"partnership_uuids\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("https://api.journeybee.io/v1/commissions/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"tier_uuids\": [\n    \"<string>\"\n  ],\n  \"category_uuids\": [\n    \"<string>\"\n  ],\n  \"partnership_uuids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.journeybee.io/v1/commissions/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"tier_uuids\": [\n    \"<string>\"\n  ],\n  \"category_uuids\": [\n    \"<string>\"\n  ],\n  \"partnership_uuids\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "uuid": "<string>",
  "label": "<string>",
  "partner_type": "referral",
  "payment_target": "partnership",
  "auto_assign_recipient": "lead_creator",
  "calculation": {
    "entries": [
      {
        "payment_stage_id": 123,
        "calculation": {
          "type": "oneOff",
          "option": "fixed",
          "value": "<string>",
          "scalingConfig": {
            "customFieldId": 123,
            "tiers": [
              {
                "optionId": 123,
                "option": "fixed",
                "value": 123
              }
            ]
          },
          "recurring_period": "weekly",
          "number_of_occurrences": 123,
          "periodRates": {
            "enabled": true,
            "periods": [
              {
                "periodNumber": 123,
                "startOccurrence": 123,
                "endOccurrence": 123,
                "option": "fixed",
                "value": 123,
                "scalingConfig": {
                  "customFieldId": 123,
                  "tiers": [
                    {
                      "optionId": 123,
                      "option": "fixed",
                      "value": 123
                    }
                  ]
                }
              }
            ]
          },
          "split": {
            "oneOff": {
              "type": "oneOff",
              "option": "fixed",
              "value": "<string>",
              "scalingConfig": {
                "customFieldId": 123,
                "tiers": [
                  {
                    "optionId": 123,
                    "option": "fixed",
                    "value": 123
                  }
                ]
              },
              "recurring_period": "weekly",
              "number_of_occurrences": 123,
              "periodRates": {
                "enabled": true,
                "periods": [
                  {
                    "periodNumber": 123,
                    "startOccurrence": 123,
                    "endOccurrence": 123,
                    "option": "fixed",
                    "value": 123,
                    "scalingConfig": {
                      "customFieldId": 123,
                      "tiers": [
                        {
                          "optionId": 123,
                          "option": "fixed",
                          "value": 123
                        }
                      ]
                    }
                  }
                ]
              }
            },
            "recurring": {
              "type": "oneOff",
              "option": "fixed",
              "value": "<string>",
              "scalingConfig": {
                "customFieldId": 123,
                "tiers": [
                  {
                    "optionId": 123,
                    "option": "fixed",
                    "value": 123
                  }
                ]
              },
              "recurring_period": "weekly",
              "number_of_occurrences": 123,
              "periodRates": {
                "enabled": true,
                "periods": [
                  {
                    "periodNumber": 123,
                    "startOccurrence": 123,
                    "endOccurrence": 123,
                    "option": "fixed",
                    "value": 123,
                    "scalingConfig": {
                      "customFieldId": 123,
                      "tiers": [
                        {
                          "optionId": 123,
                          "option": "fixed",
                          "value": 123
                        }
                      ]
                    }
                  }
                ]
              }
            }
          }
        }
      }
    ]
  },
  "tiers": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "categories": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "partnerships": [
    {
      "uuid": "<string>",
      "name": "<string>"
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

Authorization

string

header

required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json

label

string

required

Commission rule name

partner_type

enum<string>

required

Which partner type this rule applies to

Available options:

referral,

reseller

payment_target

enum<string> | null

partnership (partner org receives payment) or individual (specific user/contact)

Available options:

partnership,

individual

auto_assign_recipient

enum<string> | null

Available options:

lead_creator,

deal_owner,

manual

calculation

object

Commission calculation with one or more payment entries triggered by deal stage changes.

Show child attributes

tier_uuids

string[]

Restrict to partners in these tiers. Replaces current.

category_uuids

string[]

Restrict to partners in these categories. Replaces current.

partnership_uuids

string[]

Restrict to specific partnerships. Replaces current.

Response

201 - application/json

Default Response

uuid

string

required

label

string

required

partner_type

enum<string>

required

Available options:

referral,

reseller,

distributor

payment_target

enum<string> | null

required

Available options:

partnership,

individual

auto_assign_recipient

enum<string> | null

required

Available options:

lead_creator,

deal_owner,

manual

calculation

object

required

Commission calculation with one or more payment entries triggered by deal stage changes.

Show child attributes

tiers

object[]

required

Show child attributes