Update order auto-renewal

PATCH

/orders/{id}

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.proxyrequest.com/api/v1/orders/example");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Accept-Language: de");
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{ \"auto_renewal_percentage\": 1, \"auto_renewal_data\": 1 }");

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Patch,
    RequestUri = new Uri("https://api.proxyrequest.com/api/v1/orders/example"),
    Headers =
    {
        { "Accept-Language", "de" },
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"auto_renewal_percentage\": 1, \"auto_renewal_data\": 1 }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://api.proxyrequest.com/api/v1/orders/example"

  payload := strings.NewReader("{ \"auto_renewal_percentage\": 1, \"auto_renewal_data\": 1 }")

  req, _ := http.NewRequest("PATCH", url, payload)

  req.Header.Add("Accept-Language", "de")
  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(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.proxyrequest.com/api/v1/orders/example"))
    .header("Accept-Language", "de")
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{ \"auto_renewal_percentage\": 1, \"auto_renewal_data\": 1 }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"auto_renewal_percentage\": 1, \"auto_renewal_data\": 1 }");
Request request = new Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/orders/example")
  .patch(body)
  .addHeader("Accept-Language", "de")
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'PATCH',
  url: 'https://api.proxyrequest.com/api/v1/orders/example',
  headers: {
    'Accept-Language': 'de',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  data: {auto_renewal_percentage: 1, auto_renewal_data: 1}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.proxyrequest.com/api/v1/orders/example';
const options = {
  method: 'PATCH',
  headers: {
    'Accept-Language': 'de',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"auto_renewal_percentage":1,"auto_renewal_data":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{ \"auto_renewal_percentage\": 1, \"auto_renewal_data\": 1 }")
val request = Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/orders/example")
  .patch(body)
  .addHeader("Accept-Language", "de")
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

use std::str::FromStr;
use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.proxyrequest.com/api/v1/orders/example";

    let payload = json!({
        "auto_renewal_percentage": 1,
        "auto_renewal_data": 1
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Accept-Language", "de".parse().unwrap());
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request PATCH \
  --url https://api.proxyrequest.com/api/v1/orders/example \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "auto_renewal_percentage": 1, "auto_renewal_data": 1 }'

wget --quiet \
  --method PATCH \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --body-data '{ "auto_renewal_percentage": 1, "auto_renewal_data": 1 }' \
  --output-document \
  - https://api.proxyrequest.com/api/v1/orders/example

Updates only the auto-renewal threshold and top-up amount for an active order owned by the authenticated account. Set both values to zero to disable it.

Authorizations

BearerAuth
StaticAuth

Parameters

Path Parameters

required

string

A unique value identifying this Order.

Header Parameters

If-Match

string

Strong ETag from the latest representation of this resource.

Accept-Language

string

default: en

Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Examples

de

fr-CA, fr;q=0.9, en;q=0.5

Request Body

object

auto_renewal_percentage

integer

<= 70

auto_renewal_data

integer

<= 10000

Examples

example

Example request

{
  "auto_renewal_percentage": 1,
  "auto_renewal_data": 1
}

object

auto_renewal_percentage

integer

<= 70

auto_renewal_data

integer

<= 10000

Examples

example

Example request

auto_renewal_percentage=1&auto_renewal_data=1

object

auto_renewal_percentage

integer

<= 70

auto_renewal_data

integer

<= 10000

Examples

example

Example request

{
  "auto_renewal_percentage": 1,
  "auto_renewal_data": 1
}

Responses

200

The operation completed successfully.

application/json

object

string

<= 36 characters

is_auto_renewal

required

boolean

auto_renewal_percentage

Auto Renewal Threshold (%)

When this percentage of the data allowance has been consumed, the order is automatically renewed if the user has sufficient balance. Set to 0 to disable auto-renewal. 80 → renew when 80% of data is used

integer

<= 70

auto_renewal_data

Auto Renewal Data (GB)

Amount of data in GB to add when auto-renewal is triggered. Set to 0 to use the package default.

integer

<= 10000

package

required

object

key

additional properties

proxy_password

Password used by the customer to authenticate proxy connections. Auto-generated by default — change only if a custom value is needed. Must be between 4 and 64 characters.

string

<= 64 characters

proxy_password_reset

Password Last Changed

Timestamp of the last proxy password change. Read-only — updated automatically whenever the password is rotated.

string format: date-time

nullable

pools

Private proxy pools assigned to this order. Pools restrict which proxy IPs are available to this customer. Leave blank to use the full provider pool.

Array<string>

data

Data Allowance (bytes)

Total data allowance for this order in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB

integer format: int64

<= 1000000000000000

data_remaining

required

Integer bytes. Root order: sum of usable ledger balances, not data minus data_spent. Virtual child order: max(data - data_spent, 0), a personal quota that does not guarantee the parent still has usable data.

integer

data_spent

Data Spent (bytes)

Total bytes consumed from this order’s data allowance so far. Updated in real time as the customer uses the proxy.

integer format: int64

>= -9223372036854776000 <= 9223372036854776000

ledgers

required

Usable, non-expired ledger balances for a purchased root order; empty for a virtual child order using its parent’s pool. Not a complete history. Array position does not identify the active ledger or spending order.

Array<object>

object

key

additional properties

latest_data_top_up

Latest Top-up (bytes)

Amount of data added to this order in bytes during the most recent top-up.

integer format: int64

>= -9223372036854776000 <= 9223372036854776000

latest_data_top_up_date

Latest Top-up Date

Timestamp of the most recent data top-up, set when an invoice is fulfilled.

string format: date-time

nullable

data_updated

required

Last Used

string format: date-time

updated

required

string format: date-time

created

required

string format: date-time

Examples

example

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "is_auto_renewal": true,
  "auto_renewal_percentage": 1,
  "auto_renewal_data": 1,
  "package": {},
  "proxy_password": "p9W4rT2xK7mQ",
  "proxy_password_reset": "2026-07-01T12:30:00Z",
  "pools": [
    "residential"
  ],
  "data": 1073741824,
  "data_remaining": 1,
  "data_spent": 1073741824,
  "ledgers": [
    {}
  ],
  "latest_data_top_up": 1,
  "latest_data_top_up_date": "2026-07-01T12:30:00Z",
  "data_updated": "2026-07-01T12:30:00Z",
  "updated": "2026-07-01T12:30:00Z",
  "created": "2026-07-01T12:30:00Z"
}

Headers

ETag

string

Strong entity tag for optimistic concurrency control.

400

The request is malformed or violates a business rule.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Examples

ValidationError

Validation error

{
  "non_field_errors": [
    "The request could not be processed."
  ]
}

Headers

Content-Language

string

Language used for human-readable errors.

401

Authentication credentials are missing, expired, or invalid.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Examples

AuthenticationRequired

Authentication required

{
  "detail": "Authentication credentials were not provided."
}

Headers

Content-Language

string

Language used for human-readable errors.

403

The authenticated account cannot perform this operation.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Examples

PermissionDenied

Permission denied

{
  "detail": "You do not have permission to perform this action."
}

Headers

Content-Language

string

Language used for human-readable errors.

404

The requested resource does not exist in the current account scope.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Examples

ResourceNotFound

Resource not found

{
  "detail": "Not found."
}

Headers

Content-Language

string

Language used for human-readable errors.

412

The resource no longer matches the supplied ETag.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Example^generated

{
  "detail": "example",
  "non_field_errors": [
    "example"
  ]
}

Headers

ETag

string

Strong entity tag for optimistic concurrency control.

Content-Language

string

Language used for human-readable errors.

Update order auto-renewal

Authorizations

Parameters

Path Parameters

Header Parameters

Examples

Request Body

Examples

Examples

Examples

Responses

200

Examples

Headers

400

Examples

Headers

401

Examples

Headers

403

Examples

Headers

404

Examples

Headers

412

Examplegenerated

Headers

Example^generated