Get commission plans
curl --request GET \
--url https://www.referly.so/api/v1/commission-plans/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.referly.so/api/v1/commission-plans/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.referly.so/api/v1/commission-plans/{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://www.referly.so/api/v1/commission-plans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.referly.so/api/v1/commission-plans/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.referly.so/api/v1/commission-plans/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.referly.so/api/v1/commission-plans/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "plan_standard",
"name": "Standard Partner Plan",
"affiliateProgramId": "prog_acme_partners",
"affiliateGroupId": null,
"commissionRate": 20,
"commissionType": "PERCENTAGE",
"numberOfPayments": 0,
"numberOfMonths": 0,
"baseCondition": "ALL",
"isActive": true,
"paymentTrigger": "PURCHASE",
"rewardType": "CASH",
"nonCashRewardType": null,
"nonCashTrigger": null,
"nonCashCouponId": null,
"nonCashSignupsRequired": null,
"nonCashMaxCoupons": null,
"nonCashPurchaseTrigger": null,
"nonCashPurchaseCount": null,
"nonCashPurchaseMonthLimit": null,
"creditType": null,
"creditMaxTimes": null,
"creditPerCurrencyUnit": null,
"creditCalculationMode": null,
"creditFlatPerPurchase": null,
"creditPurchaseLimit": null,
"creditPurchaseMonthLimit": null,
"creditAmount": null,
"creditUnit": null,
"autoApproveAffiliates": true,
"autoApproveRewards": true,
"createdAt": "2026-09-01T12:00:00.000Z",
"updatedAt": "2026-09-01T12:00:00.000Z",
"commissionRuleGroups": [
{
"id": "rule_group_1",
"commissionPlanId": "plan_standard",
"commissionAmountId": null,
"order": 0,
"groupCondition": "ALL",
"createdAt": "2026-09-01T12:00:00.000Z",
"updatedAt": "2026-09-01T12:00:00.000Z",
"commissionRules": [
{
"id": "rule_1",
"commissionRuleGroupId": "rule_group_1",
"ruleType": "ORDER_AMOUNT",
"condition": "GREATER_THAN",
"value": "100",
"createdAt": "2026-09-01T12:00:00.000Z",
"updatedAt": "2026-09-01T12:00:00.000Z"
}
]
}
],
"commissionAmounts": [
{
"id": "amount_1",
"commissionPlanId": "plan_standard",
"productRequirement": "[\\\"api:0\\\"]",
"commissionRate": 25,
"commissionType": "PERCENTAGE",
"numberOfPayments": 3,
"numberOfMonths": 0,
"creditAmount": null,
"creditFlatPerPurchase": null,
"creditPerCurrencyUnit": null,
"nonCashCouponId": null,
"nonCashPurchaseTrigger": null,
"nonCashPurchaseCount": null,
"nonCashPurchaseMonthLimit": null,
"ruleGroups": [],
"commissionAfterPeriods": [
{
"id": "period_1",
"order": 1,
"commissionType": "PERCENTAGE",
"commissionRate": 10,
"numberOfMonths": 0,
"numberOfPayments": 0,
"affiliateProgramId": null,
"commissionPlanId": null,
"commissionAmountId": "amount_1",
"createdAt": "2026-09-01T12:00:00.000Z",
"updatedAt": "2026-09-01T12:00:00.000Z"
}
]
}
],
"commissionAfterPeriods": [],
"CommissionTier": [
{
"id": "tier_1",
"name": "Tier 1",
"tier": 1,
"minReferrals": 0,
"minRevenue": 0,
"conditionType": "ALL"
}
]
}{
"error": {
"code": "invalid_json",
"message": "Invalid JSON body",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid, expired or revoked API key",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires commission-plans:read",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "concurrent_request",
"message": "Concurrent operation; retry the same request",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "body_too_large",
"message": "Request body must be at most 64 KiB",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "validation_error",
"message": "Invalid request parameters",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": "Too many requests. Please slow down.",
"retryAfter": 42
}{
"error": {
"code": "internal_error",
"message": "Request failed",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "webhook_provider_error",
"message": "The webhook provider request failed",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}Commission Plan Endpoints
Get commission plans
Requires commission-plans:read. See Commission plans behavior and common API rules.
GET
/
commission-plans
/
{id}
Get commission plans
curl --request GET \
--url https://www.referly.so/api/v1/commission-plans/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.referly.so/api/v1/commission-plans/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.referly.so/api/v1/commission-plans/{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://www.referly.so/api/v1/commission-plans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.referly.so/api/v1/commission-plans/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.referly.so/api/v1/commission-plans/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.referly.so/api/v1/commission-plans/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "plan_standard",
"name": "Standard Partner Plan",
"affiliateProgramId": "prog_acme_partners",
"affiliateGroupId": null,
"commissionRate": 20,
"commissionType": "PERCENTAGE",
"numberOfPayments": 0,
"numberOfMonths": 0,
"baseCondition": "ALL",
"isActive": true,
"paymentTrigger": "PURCHASE",
"rewardType": "CASH",
"nonCashRewardType": null,
"nonCashTrigger": null,
"nonCashCouponId": null,
"nonCashSignupsRequired": null,
"nonCashMaxCoupons": null,
"nonCashPurchaseTrigger": null,
"nonCashPurchaseCount": null,
"nonCashPurchaseMonthLimit": null,
"creditType": null,
"creditMaxTimes": null,
"creditPerCurrencyUnit": null,
"creditCalculationMode": null,
"creditFlatPerPurchase": null,
"creditPurchaseLimit": null,
"creditPurchaseMonthLimit": null,
"creditAmount": null,
"creditUnit": null,
"autoApproveAffiliates": true,
"autoApproveRewards": true,
"createdAt": "2026-09-01T12:00:00.000Z",
"updatedAt": "2026-09-01T12:00:00.000Z",
"commissionRuleGroups": [
{
"id": "rule_group_1",
"commissionPlanId": "plan_standard",
"commissionAmountId": null,
"order": 0,
"groupCondition": "ALL",
"createdAt": "2026-09-01T12:00:00.000Z",
"updatedAt": "2026-09-01T12:00:00.000Z",
"commissionRules": [
{
"id": "rule_1",
"commissionRuleGroupId": "rule_group_1",
"ruleType": "ORDER_AMOUNT",
"condition": "GREATER_THAN",
"value": "100",
"createdAt": "2026-09-01T12:00:00.000Z",
"updatedAt": "2026-09-01T12:00:00.000Z"
}
]
}
],
"commissionAmounts": [
{
"id": "amount_1",
"commissionPlanId": "plan_standard",
"productRequirement": "[\\\"api:0\\\"]",
"commissionRate": 25,
"commissionType": "PERCENTAGE",
"numberOfPayments": 3,
"numberOfMonths": 0,
"creditAmount": null,
"creditFlatPerPurchase": null,
"creditPerCurrencyUnit": null,
"nonCashCouponId": null,
"nonCashPurchaseTrigger": null,
"nonCashPurchaseCount": null,
"nonCashPurchaseMonthLimit": null,
"ruleGroups": [],
"commissionAfterPeriods": [
{
"id": "period_1",
"order": 1,
"commissionType": "PERCENTAGE",
"commissionRate": 10,
"numberOfMonths": 0,
"numberOfPayments": 0,
"affiliateProgramId": null,
"commissionPlanId": null,
"commissionAmountId": "amount_1",
"createdAt": "2026-09-01T12:00:00.000Z",
"updatedAt": "2026-09-01T12:00:00.000Z"
}
]
}
],
"commissionAfterPeriods": [],
"CommissionTier": [
{
"id": "tier_1",
"name": "Tier 1",
"tier": 1,
"minReferrals": 0,
"minRevenue": 0,
"conditionType": "ALL"
}
]
}{
"error": {
"code": "invalid_json",
"message": "Invalid JSON body",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid, expired or revoked API key",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires commission-plans:read",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "concurrent_request",
"message": "Concurrent operation; retry the same request",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "body_too_large",
"message": "Request body must be at most 64 KiB",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "validation_error",
"message": "Invalid request parameters",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": "Too many requests. Please slow down.",
"retryAfter": 42
}{
"error": {
"code": "internal_error",
"message": "Request failed",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}{
"error": {
"code": "webhook_provider_error",
"message": "The webhook provider request failed",
"requestId": "5c1f7a2e-2b39-4c2d-9c31-7a6e0f6a9b21"
}
}Requires
commission-plans:read. See the commission plans guide for behavior and examples.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Select the key's original program or a program provisioned by this exact key. Other owned programs remain inaccessible.
Path Parameters
Response
Success. Monetary amounts use program currency; see companion documentation for resource fields.
Last modified on October 23, 2026
⌘I