Skip to main content
POST
/
v1
/
payout_groups
Create
curl --request POST \
  --url https://{defaultHost}/v1/payout_groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payout_group": {
    "end_date": "2026-06-23 14:57:42 UTC"
  }
}
'
import requests

url = "https://{defaultHost}/v1/payout_groups"

payload = { "payout_group": { "end_date": "2026-06-23 14:57:42 UTC" } }
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({payout_group: {end_date: '2026-06-23 14:57:42 UTC'}})
};

fetch('https://{defaultHost}/v1/payout_groups', 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://{defaultHost}/v1/payout_groups",
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([
'payout_group' => [
'end_date' => '2026-06-23 14:57:42 UTC'
]
]),
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://{defaultHost}/v1/payout_groups"

payload := strings.NewReader("{\n \"payout_group\": {\n \"end_date\": \"2026-06-23 14:57:42 UTC\"\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://{defaultHost}/v1/payout_groups")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payout_group\": {\n \"end_date\": \"2026-06-23 14:57:42 UTC\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{defaultHost}/v1/payout_groups")

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 \"payout_group\": {\n \"end_date\": \"2026-06-23 14:57:42 UTC\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "dafa68ff-f6ed-4e78-ba87-fb428a001c83",
  "object": "payout_group",
  "currency": "usd",
  "end_date": 1782172800,
  "live_mode": true,
  "min_commission_amount": null,
  "created_at": 1782485862,
  "updated_at": 1782485862
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
payout_group
object

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

end_date
integer

All approved referrals through this day will be included in the payout.

live_mode
boolean

Set to true if this payout group is in live mode, and set to false if it is in test mode.

min_commission_amount
integer | null

The minimum amount of commission that must be earned before a payout is generated for an affiliate.

currency
string

The currency of the payout group.

payouts

Expandable – Property not returned unless expanded.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.