Skip to main content
POST
/
api
/
v2
/
network
/
aff-billing
/
invoices
Generate invoice
curl --request POST \
  --url https://{domain}/api/v2/network/aff-billing/invoices \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "affiliate_id": 1,
  "currency": "USD",
  "amount": 1,
  "start_date": "2025-01-20",
  "end_date": "2025-01-20",
  "status": "string",
  "invoice_memo": "string"
}
'
import requests

url = "https://{domain}/api/v2/network/aff-billing/invoices"

payload = {
"affiliate_id": 1,
"currency": "USD",
"amount": 1,
"start_date": "2025-01-20",
"end_date": "2025-01-20",
"status": "string",
"invoice_memo": "string"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
affiliate_id: 1,
currency: 'USD',
amount: 1,
start_date: '2025-01-20',
end_date: '2025-01-20',
status: 'string',
invoice_memo: 'string'
})
};

fetch('https://{domain}/api/v2/network/aff-billing/invoices', 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/aff-billing/invoices",
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([
'affiliate_id' => 1,
'currency' => 'USD',
'amount' => 1,
'start_date' => '2025-01-20',
'end_date' => '2025-01-20',
'status' => 'string',
'invoice_memo' => 'string'
]),
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/aff-billing/invoices"

payload := strings.NewReader("{\n \"affiliate_id\": 1,\n \"currency\": \"USD\",\n \"amount\": 1,\n \"start_date\": \"2025-01-20\",\n \"end_date\": \"2025-01-20\",\n \"status\": \"string\",\n \"invoice_memo\": \"string\"\n}")

req, _ := http.NewRequest("POST", 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.post("https://{domain}/api/v2/network/aff-billing/invoices")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"affiliate_id\": 1,\n \"currency\": \"USD\",\n \"amount\": 1,\n \"start_date\": \"2025-01-20\",\n \"end_date\": \"2025-01-20\",\n \"status\": \"string\",\n \"invoice_memo\": \"string\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/network/aff-billing/invoices")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"affiliate_id\": 1,\n \"currency\": \"USD\",\n \"amount\": 1,\n \"start_date\": \"2025-01-20\",\n \"end_date\": \"2025-01-20\",\n \"status\": \"string\",\n \"invoice_memo\": \"string\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "<string>",
  "info": {}
}
{
"message": "Request could not be parsed.",
"success": false,
"info": {
"errors": {}
}
}
{
"message": "API key is invalid or missing.",
"success": false
}
{
"message": "This endpoint is not available for your role.",
"success": false
}
{
"message": "Validation error",
"success": false,
"info": {
"errors": {
"email": [
"Email cannot be blank."
],
"currency": [
"Currency must be a valid ISO code."
]
}
}
}
{
"message": "An unexpected error occurred.",
"success": false,
"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.

Body

application/json
affiliate_id
integer
required

Affiliate to generate invoice for.

currency
string
required

3-letter currency code (e.g. USD). Converted to uppercase.

Maximum string length: 3
amount
number

Invoice amount. If omitted, calculated automatically from balance.

Required range: x >= 0
start_date
string<date>

Period start date (YYYY-MM-DD).

end_date
string<date>

Period end date (YYYY-MM-DD). Must be >= start_date.

status
string

Invoice status: unpaid, paid, draft, etc.

invoice_memo
string

Memo text visible to affiliate.

internal_notes
string

Internal notes (not visible to affiliate).

offers
string

Comma-separated offer IDs to include.

commission_plan_ids
string

Comma-separated commission plan IDs.

commission_types
string

Comma-separated commission types: cpc, cpa, rev_share, cpl, lot_fee, lot_based_fee, flat_fee.

include_referral_balance
enum<integer>

Whether to include referral balance (0 or 1).

Available options:
0,
1

Response

Invoice generated.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object

Generated invoice details.