Create a retainer pack
curl --request POST \
--url https://api.stardex.ai/v1/retainer-packs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"organization_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"currency_code": "<string>",
"fee_status_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retainer_count": 50,
"amount_each": 123,
"invoice_number": "<string>",
"expected_date": "2023-12-25",
"link_extra_hires": true,
"firm_commission_percent": 123,
"default_split": [
{
"team_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"split_percentage": 99,
"role": "<string>"
}
]
}
'import requests
url = "https://api.stardex.ai/v1/retainer-packs"
payload = {
"organization_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"currency_code": "<string>",
"fee_status_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retainer_count": 50,
"amount_each": 123,
"invoice_number": "<string>",
"expected_date": "2023-12-25",
"link_extra_hires": True,
"firm_commission_percent": 123,
"default_split": [
{
"team_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"split_percentage": 99,
"role": "<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({
organization_company_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
currency_code: '<string>',
fee_status_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
retainer_count: 50,
amount_each: 123,
invoice_number: '<string>',
expected_date: '2023-12-25',
link_extra_hires: true,
firm_commission_percent: 123,
default_split: [
{
team_member_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
split_percentage: 99,
role: '<string>'
}
]
})
};
fetch('https://api.stardex.ai/v1/retainer-packs', 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.stardex.ai/v1/retainer-packs",
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([
'organization_company_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'currency_code' => '<string>',
'fee_status_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'retainer_count' => 50,
'amount_each' => 123,
'invoice_number' => '<string>',
'expected_date' => '2023-12-25',
'link_extra_hires' => true,
'firm_commission_percent' => 123,
'default_split' => [
[
'team_member_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'split_percentage' => 99,
'role' => '<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.stardex.ai/v1/retainer-packs"
payload := strings.NewReader("{\n \"organization_company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"currency_code\": \"<string>\",\n \"fee_status_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"retainer_count\": 50,\n \"amount_each\": 123,\n \"invoice_number\": \"<string>\",\n \"expected_date\": \"2023-12-25\",\n \"link_extra_hires\": true,\n \"firm_commission_percent\": 123,\n \"default_split\": [\n {\n \"team_member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"split_percentage\": 99,\n \"role\": \"<string>\"\n }\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.stardex.ai/v1/retainer-packs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"organization_company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"currency_code\": \"<string>\",\n \"fee_status_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"retainer_count\": 50,\n \"amount_each\": 123,\n \"invoice_number\": \"<string>\",\n \"expected_date\": \"2023-12-25\",\n \"link_extra_hires\": true,\n \"firm_commission_percent\": 123,\n \"default_split\": [\n {\n \"team_member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"split_percentage\": 99,\n \"role\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/retainer-packs")
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 \"organization_company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"currency_code\": \"<string>\",\n \"fee_status_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"retainer_count\": 50,\n \"amount_each\": 123,\n \"invoice_number\": \"<string>\",\n \"expected_date\": \"2023-12-25\",\n \"link_extra_hires\": true,\n \"firm_commission_percent\": 123,\n \"default_split\": [\n {\n \"team_member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"split_percentage\": 99,\n \"role\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"organization_company_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"organization_company_name": "Acme Corp",
"name": "Q4 2026 GTM pack",
"currency_code": "USD",
"invoice_number": "INV-1042",
"link_extra_hires": true,
"firm_commission_percent": 10,
"is_closed": false,
"closed_at": null,
"fee_status": {
"id": "5e6f7a8b-9c0d-4e1f-8a3b-4c5d6e7f8a9b",
"name": "Paid",
"status_type": "paid",
"color": "#22c55e"
},
"expected_date": "2026-10-01",
"actual_payment_date": "2026-10-15",
"amount_each": 12000,
"default_split": [
{
"team_member_id": "6f7a8b9c-0d1e-4f2a-9b4c-5d6e7f8a9b0c",
"team_member_name": "Theo Grant",
"role": "Sales",
"split_percentage": 70
},
{
"team_member_id": "7a8b9c0d-1e2f-4a3b-8c5d-6e7f8a9b0c1d",
"team_member_name": "Ana Ruiz",
"role": null,
"split_percentage": 30
}
],
"retainers": [
{
"id": "1b2c3d4e-5f6a-4b7c-9d8e-0f1a2b3c4d5e",
"position": 1,
"amount": 12000,
"firm_commission_percent": 10,
"claim": {
"is_restricted": false,
"placement_fee_event_id": "9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
"job_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"job_title": "VP of Engineering",
"candidate_id": "3c4d5e6f-7a8b-4c9d-8e1f-2a3b4c5d6e7f",
"person_id": "4d5e6f7a-8b9c-4d0e-9f2a-3b4c5d6e7f8a",
"person_name": "Jordan Lee",
"start_date": "2026-11-03"
},
"splits": [
{
"team_member_id": "7a8b9c0d-1e2f-4a3b-8c5d-6e7f8a9b0c1d",
"team_member_name": "Ana Ruiz",
"role": "Recruiter",
"split_percentage": 60,
"split_amount": 6480
},
{
"team_member_id": "6f7a8b9c-0d1e-4f2a-9b4c-5d6e7f8a9b0c",
"team_member_name": "Theo Grant",
"role": "Sales",
"split_percentage": 40,
"split_amount": 4320
}
]
},
{
"id": "2c3d4e5f-6a7b-4c8d-8e9f-1a2b3c4d5e6f",
"position": 2,
"amount": 12000,
"firm_commission_percent": 10,
"claim": {
"is_restricted": true,
"placement_fee_event_id": "0d1e2f3a-4b5c-4d6e-9f7a-8b9c0d1e2f3a"
},
"splits": [
{
"team_member_id": "6f7a8b9c-0d1e-4f2a-9b4c-5d6e7f8a9b0c",
"team_member_name": "Theo Grant",
"role": "Sales",
"split_percentage": 70,
"split_amount": 7560
},
{
"team_member_id": "7a8b9c0d-1e2f-4a3b-8c5d-6e7f8a9b0c1d",
"team_member_name": "Ana Ruiz",
"role": null,
"split_percentage": 30,
"split_amount": 3240
}
]
},
{
"id": "3d4e5f6a-7b8c-4d9e-8f0a-2b3c4d5e6f7a",
"position": 3,
"amount": 12000,
"firm_commission_percent": 10,
"claim": null,
"splits": [
{
"team_member_id": "6f7a8b9c-0d1e-4f2a-9b4c-5d6e7f8a9b0c",
"team_member_name": "Theo Grant",
"role": "Sales",
"split_percentage": 70,
"split_amount": 7560
},
{
"team_member_id": "7a8b9c0d-1e2f-4a3b-8c5d-6e7f8a9b0c1d",
"team_member_name": "Ana Ruiz",
"role": null,
"split_percentage": 30,
"split_amount": 3240
}
]
}
],
"extra_hires": [],
"adjustments": [],
"summary": {
"retainer_count": 3,
"claimed_count": 2,
"open_count": 1,
"extra_hire_count": 0,
"total_amount": 36000,
"remaining_amount": 12000,
"adjustments_total": 0,
"net_retained": 36000
},
"created_at": "2026-09-28T09:12:44.000Z",
"updated_at": "2026-10-15T16:03:10.000Z"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Retainer Packs
Create a retainer pack
Creates a pack of retainer_count open retainers of amount_each for a client company, all on one invoice. Amounts are per retainer. Every retainer shares the pack status, invoice date and currency.
Returns the full pack with its retainers, claims, splits, extra hires, adjustments and summary.
Access: Session and OAuth callers need permission to edit CRM records (org:crm:edit; org:admin always can). API keys need the fees:write scope.
POST
/
v1
/
retainer-packs
Create a retainer pack
curl --request POST \
--url https://api.stardex.ai/v1/retainer-packs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"organization_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"currency_code": "<string>",
"fee_status_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retainer_count": 50,
"amount_each": 123,
"invoice_number": "<string>",
"expected_date": "2023-12-25",
"link_extra_hires": true,
"firm_commission_percent": 123,
"default_split": [
{
"team_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"split_percentage": 99,
"role": "<string>"
}
]
}
'import requests
url = "https://api.stardex.ai/v1/retainer-packs"
payload = {
"organization_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"currency_code": "<string>",
"fee_status_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"retainer_count": 50,
"amount_each": 123,
"invoice_number": "<string>",
"expected_date": "2023-12-25",
"link_extra_hires": True,
"firm_commission_percent": 123,
"default_split": [
{
"team_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"split_percentage": 99,
"role": "<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({
organization_company_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
currency_code: '<string>',
fee_status_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
retainer_count: 50,
amount_each: 123,
invoice_number: '<string>',
expected_date: '2023-12-25',
link_extra_hires: true,
firm_commission_percent: 123,
default_split: [
{
team_member_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
split_percentage: 99,
role: '<string>'
}
]
})
};
fetch('https://api.stardex.ai/v1/retainer-packs', 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.stardex.ai/v1/retainer-packs",
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([
'organization_company_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'currency_code' => '<string>',
'fee_status_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'retainer_count' => 50,
'amount_each' => 123,
'invoice_number' => '<string>',
'expected_date' => '2023-12-25',
'link_extra_hires' => true,
'firm_commission_percent' => 123,
'default_split' => [
[
'team_member_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'split_percentage' => 99,
'role' => '<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.stardex.ai/v1/retainer-packs"
payload := strings.NewReader("{\n \"organization_company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"currency_code\": \"<string>\",\n \"fee_status_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"retainer_count\": 50,\n \"amount_each\": 123,\n \"invoice_number\": \"<string>\",\n \"expected_date\": \"2023-12-25\",\n \"link_extra_hires\": true,\n \"firm_commission_percent\": 123,\n \"default_split\": [\n {\n \"team_member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"split_percentage\": 99,\n \"role\": \"<string>\"\n }\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.stardex.ai/v1/retainer-packs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"organization_company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"currency_code\": \"<string>\",\n \"fee_status_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"retainer_count\": 50,\n \"amount_each\": 123,\n \"invoice_number\": \"<string>\",\n \"expected_date\": \"2023-12-25\",\n \"link_extra_hires\": true,\n \"firm_commission_percent\": 123,\n \"default_split\": [\n {\n \"team_member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"split_percentage\": 99,\n \"role\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/retainer-packs")
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 \"organization_company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"currency_code\": \"<string>\",\n \"fee_status_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"retainer_count\": 50,\n \"amount_each\": 123,\n \"invoice_number\": \"<string>\",\n \"expected_date\": \"2023-12-25\",\n \"link_extra_hires\": true,\n \"firm_commission_percent\": 123,\n \"default_split\": [\n {\n \"team_member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"split_percentage\": 99,\n \"role\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"organization_company_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"organization_company_name": "Acme Corp",
"name": "Q4 2026 GTM pack",
"currency_code": "USD",
"invoice_number": "INV-1042",
"link_extra_hires": true,
"firm_commission_percent": 10,
"is_closed": false,
"closed_at": null,
"fee_status": {
"id": "5e6f7a8b-9c0d-4e1f-8a3b-4c5d6e7f8a9b",
"name": "Paid",
"status_type": "paid",
"color": "#22c55e"
},
"expected_date": "2026-10-01",
"actual_payment_date": "2026-10-15",
"amount_each": 12000,
"default_split": [
{
"team_member_id": "6f7a8b9c-0d1e-4f2a-9b4c-5d6e7f8a9b0c",
"team_member_name": "Theo Grant",
"role": "Sales",
"split_percentage": 70
},
{
"team_member_id": "7a8b9c0d-1e2f-4a3b-8c5d-6e7f8a9b0c1d",
"team_member_name": "Ana Ruiz",
"role": null,
"split_percentage": 30
}
],
"retainers": [
{
"id": "1b2c3d4e-5f6a-4b7c-9d8e-0f1a2b3c4d5e",
"position": 1,
"amount": 12000,
"firm_commission_percent": 10,
"claim": {
"is_restricted": false,
"placement_fee_event_id": "9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
"job_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"job_title": "VP of Engineering",
"candidate_id": "3c4d5e6f-7a8b-4c9d-8e1f-2a3b4c5d6e7f",
"person_id": "4d5e6f7a-8b9c-4d0e-9f2a-3b4c5d6e7f8a",
"person_name": "Jordan Lee",
"start_date": "2026-11-03"
},
"splits": [
{
"team_member_id": "7a8b9c0d-1e2f-4a3b-8c5d-6e7f8a9b0c1d",
"team_member_name": "Ana Ruiz",
"role": "Recruiter",
"split_percentage": 60,
"split_amount": 6480
},
{
"team_member_id": "6f7a8b9c-0d1e-4f2a-9b4c-5d6e7f8a9b0c",
"team_member_name": "Theo Grant",
"role": "Sales",
"split_percentage": 40,
"split_amount": 4320
}
]
},
{
"id": "2c3d4e5f-6a7b-4c8d-8e9f-1a2b3c4d5e6f",
"position": 2,
"amount": 12000,
"firm_commission_percent": 10,
"claim": {
"is_restricted": true,
"placement_fee_event_id": "0d1e2f3a-4b5c-4d6e-9f7a-8b9c0d1e2f3a"
},
"splits": [
{
"team_member_id": "6f7a8b9c-0d1e-4f2a-9b4c-5d6e7f8a9b0c",
"team_member_name": "Theo Grant",
"role": "Sales",
"split_percentage": 70,
"split_amount": 7560
},
{
"team_member_id": "7a8b9c0d-1e2f-4a3b-8c5d-6e7f8a9b0c1d",
"team_member_name": "Ana Ruiz",
"role": null,
"split_percentage": 30,
"split_amount": 3240
}
]
},
{
"id": "3d4e5f6a-7b8c-4d9e-8f0a-2b3c4d5e6f7a",
"position": 3,
"amount": 12000,
"firm_commission_percent": 10,
"claim": null,
"splits": [
{
"team_member_id": "6f7a8b9c-0d1e-4f2a-9b4c-5d6e7f8a9b0c",
"team_member_name": "Theo Grant",
"role": "Sales",
"split_percentage": 70,
"split_amount": 7560
},
{
"team_member_id": "7a8b9c0d-1e2f-4a3b-8c5d-6e7f8a9b0c1d",
"team_member_name": "Ana Ruiz",
"role": null,
"split_percentage": 30,
"split_amount": 3240
}
]
}
],
"extra_hires": [],
"adjustments": [],
"summary": {
"retainer_count": 3,
"claimed_count": 2,
"open_count": 1,
"extra_hire_count": 0,
"total_amount": 36000,
"remaining_amount": 12000,
"adjustments_total": 0,
"net_retained": 36000
},
"created_at": "2026-09-28T09:12:44.000Z",
"updated_at": "2026-10-15T16:03:10.000Z"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
Authenticate with a Bearer token: API key, OAuth token, or session token.
Body
application/json
Client company the pack is sold to. The company must be marked as a client.
Pack name shown on the company page, 1 to 200 characters (e.g. "Q4 2026 GTM pack").
Required string length:
1 - 200ISO 4217 currency code of every retainer in the pack (e.g. USD). Can't change once a retainer is claimed.
Required string length:
3Status of the pack invoice, shared by every retainer in the pack. Get IDs from GET /v1/fee-statuses. Only admins can move a paid pack back to an unpaid status.
Number of retainers in the pack, 1 to 100. To top up an existing pack, send add_retainers instead. Lowering it removes open retainers from the end and can't go below the claimed retainers.
Required range:
1 <= x <= 100Amount of each retainer, 0 or more. A change applies to open retainers; claimed retainers keep their amount.
Invoice number for the whole pack (one invoice per pack), at most 100 characters. Send null on update to clear it.
Invoice date (YYYY-MM-DD), shared by every retainer in the pack. Send null on update to clear it.
When every paid retainer is claimed, new hires at this client still link to the pack with a 0 retainer and are billed the full fee. Defaults to true.
Percent of each open retainer the firm keeps before team credit is split, 0 to 100. Defaults to 0.
Who gets credit for each retainer. Send an empty list for no split, otherwise the percentages must total 100. Credit per retainer is the retainer amount minus the firm commission, times each person's percentage. Applies to open retainers; a claimed retainer keeps the split it was claimed with. Only admins can change the split of a paid pack. Defaults to an empty list.
Show child attributes
Show child attributes
Was this page helpful?