Order Settings

Update CPL order settings.

curl --request POST \
  --url https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "auto_renewal": true,
  "hide_income_stats": true,
  "auto_renewal_fans": 2,
  "auto_renewal_max_price": 5000
}
'

import requests

url = "https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings"

payload = {
    "auto_renewal": True,
    "hide_income_stats": True,
    "auto_renewal_fans": 2,
    "auto_renewal_max_price": 5000
}
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({
    auto_renewal: true,
    hide_income_stats: true,
    auto_renewal_fans: 2,
    auto_renewal_max_price: 5000
  })
};

fetch('https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings', 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://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings",
  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([
    'auto_renewal' => true,
    'hide_income_stats' => true,
    'auto_renewal_fans' => 2,
    'auto_renewal_max_price' => 5000
  ]),
  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://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings"

	payload := strings.NewReader("{\n  \"auto_renewal\": true,\n  \"hide_income_stats\": true,\n  \"auto_renewal_fans\": 2,\n  \"auto_renewal_max_price\": 5000\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://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auto_renewal\": true,\n  \"hide_income_stats\": true,\n  \"auto_renewal_fans\": 2,\n  \"auto_renewal_max_price\": 5000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings")

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  \"auto_renewal\": true,\n  \"hide_income_stats\": true,\n  \"auto_renewal_fans\": 2,\n  \"auto_renewal_max_price\": 5000\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "order_id": "<string>"
  }
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

POST

cpl

orders

{public_id}

settings

Update CPL order settings.

curl --request POST \
  --url https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "auto_renewal": true,
  "hide_income_stats": true,
  "auto_renewal_fans": 2,
  "auto_renewal_max_price": 5000
}
'

import requests

url = "https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings"

payload = {
    "auto_renewal": True,
    "hide_income_stats": True,
    "auto_renewal_fans": 2,
    "auto_renewal_max_price": 5000
}
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({
    auto_renewal: true,
    hide_income_stats: true,
    auto_renewal_fans: 2,
    auto_renewal_max_price: 5000
  })
};

fetch('https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings', 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://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings",
  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([
    'auto_renewal' => true,
    'hide_income_stats' => true,
    'auto_renewal_fans' => 2,
    'auto_renewal_max_price' => 5000
  ]),
  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://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings"

	payload := strings.NewReader("{\n  \"auto_renewal\": true,\n  \"hide_income_stats\": true,\n  \"auto_renewal_fans\": 2,\n  \"auto_renewal_max_price\": 5000\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://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auto_renewal\": true,\n  \"hide_income_stats\": true,\n  \"auto_renewal_fans\": 2,\n  \"auto_renewal_max_price\": 5000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings")

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  \"auto_renewal\": true,\n  \"hide_income_stats\": true,\n  \"auto_renewal_fans\": 2,\n  \"auto_renewal_max_price\": 5000\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "order_id": "<string>"
  }
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

Mutates auto_renewal_* and hide_income_stats on a waiting or accepted order. Auto-renewal is re-priced against the offer at submit time: auto_renewal_max_price must cover the per-fan cost for the requested quantity, otherwise the request is rejected.

Authorizations

X-API-Key

string

header

required

Your API key from the Studio Dashboard

Path Parameters

public_id

string

required

Resource public id. Format varies by endpoint: cplo_xxxxxxx for CPL orders, cpco_xxxxxxx for CPC orders, swpo_xxxxxxx for swap orders, cpcr_xxxxxxx for CPC creatives, revi_xxxxxxx for RevShare invoices.

Pattern: ^[a-z0-9_]+$

Body

application/json

auto_renewal

boolean

required

When true, on completion the order auto-creates a follow-up of the same shape.

hide_income_stats

boolean

required

When true, this order's income/ROMI is hidden from the partner offer page.

auto_renewal_fans

integer

Required when auto_renewal=true. Must fall inside the offer's [min_quantity, max_quantity] window.

Required range: x >= 1

auto_renewal_max_price

number<float>

Required when auto_renewal=true. Per-fan price cap; must be ≥ the server-computed per-fan cost for the requested quantity.

Required range: 0 <= x <= 10000

Response

Updated.

success

boolean

data

object

Show child attributes

Cancel Order

Payments

Overview

Platforms

Work Formats

Tools

Payments & Safety

API & MCP

Authorizations

Path Parameters

Body

Response