Update affiliate billing preferences
curl --request PUT \
--url https://{domain}/api/v2/network/aff-billing/preferences/{affiliate_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"invoice_type": 1,
"invoice_frequency": 1,
"generate_invoice_automatically": 0,
"payment_terms": 1,
"vat": 1
}
'import requests
url = "https://{domain}/api/v2/network/aff-billing/preferences/{affiliate_id}"
payload = {
"invoice_type": 1,
"invoice_frequency": 1,
"generate_invoice_automatically": 0,
"payment_terms": 1,
"vat": 1
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
invoice_type: 1,
invoice_frequency: 1,
generate_invoice_automatically: 0,
payment_terms: 1,
vat: 1
})
};
fetch('https://{domain}/api/v2/network/aff-billing/preferences/{affiliate_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://{domain}/api/v2/network/aff-billing/preferences/{affiliate_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'invoice_type' => 1,
'invoice_frequency' => 1,
'generate_invoice_automatically' => 0,
'payment_terms' => 1,
'vat' => 1
]),
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/preferences/{affiliate_id}"
payload := strings.NewReader("{\n \"invoice_type\": 1,\n \"invoice_frequency\": 1,\n \"generate_invoice_automatically\": 0,\n \"payment_terms\": 1,\n \"vat\": 1\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{domain}/api/v2/network/aff-billing/preferences/{affiliate_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"invoice_type\": 1,\n \"invoice_frequency\": 1,\n \"generate_invoice_automatically\": 0,\n \"payment_terms\": 1,\n \"vat\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v2/network/aff-billing/preferences/{affiliate_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invoice_type\": 1,\n \"invoice_frequency\": 1,\n \"generate_invoice_automatically\": 0,\n \"payment_terms\": 1,\n \"vat\": 1\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": 200,
"name": "OK",
"message": "<string>"
}{
"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": "Resource not found.",
"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": {}
}
}Affiliate billing
Update affiliate billing preferences
Updates billing preferences for an affiliate.
PUT
/
api
/
v2
/
network
/
aff-billing
/
preferences
/
{affiliate_id}
Update affiliate billing preferences
curl --request PUT \
--url https://{domain}/api/v2/network/aff-billing/preferences/{affiliate_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"invoice_type": 1,
"invoice_frequency": 1,
"generate_invoice_automatically": 0,
"payment_terms": 1,
"vat": 1
}
'import requests
url = "https://{domain}/api/v2/network/aff-billing/preferences/{affiliate_id}"
payload = {
"invoice_type": 1,
"invoice_frequency": 1,
"generate_invoice_automatically": 0,
"payment_terms": 1,
"vat": 1
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
invoice_type: 1,
invoice_frequency: 1,
generate_invoice_automatically: 0,
payment_terms: 1,
vat: 1
})
};
fetch('https://{domain}/api/v2/network/aff-billing/preferences/{affiliate_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://{domain}/api/v2/network/aff-billing/preferences/{affiliate_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'invoice_type' => 1,
'invoice_frequency' => 1,
'generate_invoice_automatically' => 0,
'payment_terms' => 1,
'vat' => 1
]),
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/preferences/{affiliate_id}"
payload := strings.NewReader("{\n \"invoice_type\": 1,\n \"invoice_frequency\": 1,\n \"generate_invoice_automatically\": 0,\n \"payment_terms\": 1,\n \"vat\": 1\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{domain}/api/v2/network/aff-billing/preferences/{affiliate_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"invoice_type\": 1,\n \"invoice_frequency\": 1,\n \"generate_invoice_automatically\": 0,\n \"payment_terms\": 1,\n \"vat\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v2/network/aff-billing/preferences/{affiliate_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invoice_type\": 1,\n \"invoice_frequency\": 1,\n \"generate_invoice_automatically\": 0,\n \"payment_terms\": 1,\n \"vat\": 1\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": 200,
"name": "OK",
"message": "<string>"
}{
"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": "Resource not found.",
"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
ApiKeyHeaderAuthApiKeyAuth
Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.
Path Parameters
Affiliate ID.
Body
application/json
Invoice type ID (references invoice type configuration).
Invoice frequency ID (e.g. monthly, weekly).
Whether to auto-generate invoices (1=yes, 0=no).
Available options:
0, 1 Payment terms in days.
VAT percentage (e.g. 20 for 20%).
Legal name of the payment beneficiary.
Email address for billing notifications.
Beneficiary mailing address.
Tax identification number.
Comma-separated day numbers for monthly invoice generation.
Day of the week for weekly invoice generation.
Was this page helpful?
⌘I