Generate advertiser invoice
curl --request POST \
--url https://{domain}/api/v2/network/adv-billing/invoices \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"advertiser_id": 123,
"currency": "<string>",
"amount": 1,
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"status": "<string>",
"invoice_memo": "<string>",
"internal_notes": "<string>",
"offers": "<string>"
}
'import requests
url = "https://{domain}/api/v2/network/adv-billing/invoices"
payload = {
"advertiser_id": 123,
"currency": "<string>",
"amount": 1,
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"status": "<string>",
"invoice_memo": "<string>",
"internal_notes": "<string>",
"offers": "<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({
advertiser_id: 123,
currency: '<string>',
amount: 1,
start_date: '2023-12-25',
end_date: '2023-12-25',
status: '<string>',
invoice_memo: '<string>',
internal_notes: '<string>',
offers: '<string>'
})
};
fetch('https://{domain}/api/v2/network/adv-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/adv-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([
'advertiser_id' => 123,
'currency' => '<string>',
'amount' => 1,
'start_date' => '2023-12-25',
'end_date' => '2023-12-25',
'status' => '<string>',
'invoice_memo' => '<string>',
'internal_notes' => '<string>',
'offers' => '<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/adv-billing/invoices"
payload := strings.NewReader("{\n \"advertiser_id\": 123,\n \"currency\": \"<string>\",\n \"amount\": 1,\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"status\": \"<string>\",\n \"invoice_memo\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"offers\": \"<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/adv-billing/invoices")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"advertiser_id\": 123,\n \"currency\": \"<string>\",\n \"amount\": 1,\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"status\": \"<string>\",\n \"invoice_memo\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"offers\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v2/network/adv-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 \"advertiser_id\": 123,\n \"currency\": \"<string>\",\n \"amount\": 1,\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"status\": \"<string>\",\n \"invoice_memo\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"offers\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": 200,
"name": "OK",
"message": "<string>",
"info": {
"invoice_id": 123,
"invoice_number": "<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": "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": {}
}
}Advertiser billing
Generate advertiser invoice
Generates a new invoice for an advertiser.
POST
/
api
/
v2
/
network
/
adv-billing
/
invoices
Generate advertiser invoice
curl --request POST \
--url https://{domain}/api/v2/network/adv-billing/invoices \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"advertiser_id": 123,
"currency": "<string>",
"amount": 1,
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"status": "<string>",
"invoice_memo": "<string>",
"internal_notes": "<string>",
"offers": "<string>"
}
'import requests
url = "https://{domain}/api/v2/network/adv-billing/invoices"
payload = {
"advertiser_id": 123,
"currency": "<string>",
"amount": 1,
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"status": "<string>",
"invoice_memo": "<string>",
"internal_notes": "<string>",
"offers": "<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({
advertiser_id: 123,
currency: '<string>',
amount: 1,
start_date: '2023-12-25',
end_date: '2023-12-25',
status: '<string>',
invoice_memo: '<string>',
internal_notes: '<string>',
offers: '<string>'
})
};
fetch('https://{domain}/api/v2/network/adv-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/adv-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([
'advertiser_id' => 123,
'currency' => '<string>',
'amount' => 1,
'start_date' => '2023-12-25',
'end_date' => '2023-12-25',
'status' => '<string>',
'invoice_memo' => '<string>',
'internal_notes' => '<string>',
'offers' => '<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/adv-billing/invoices"
payload := strings.NewReader("{\n \"advertiser_id\": 123,\n \"currency\": \"<string>\",\n \"amount\": 1,\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"status\": \"<string>\",\n \"invoice_memo\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"offers\": \"<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/adv-billing/invoices")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"advertiser_id\": 123,\n \"currency\": \"<string>\",\n \"amount\": 1,\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"status\": \"<string>\",\n \"invoice_memo\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"offers\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v2/network/adv-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 \"advertiser_id\": 123,\n \"currency\": \"<string>\",\n \"amount\": 1,\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"status\": \"<string>\",\n \"invoice_memo\": \"<string>\",\n \"internal_notes\": \"<string>\",\n \"offers\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": 200,
"name": "OK",
"message": "<string>",
"info": {
"invoice_id": 123,
"invoice_number": "<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": "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.
Body
application/jsonmultipart/form-data
Advertiser to generate invoice for.
3-letter currency code (e.g. USD). Converted to uppercase.
Maximum string length:
3Invoice amount. If omitted, calculated automatically from balance.
Required range:
x >= 0Period start date (YYYY-MM-DD).
Period end date (YYYY-MM-DD). Must be >= start_date.
Invoice status: unpaid, paid, draft, etc.
Memo text visible to advertiser.
Internal notes (not visible to advertiser).
Comma-separated offer IDs to include.
Was this page helpful?
⌘I