Reset a user's remaining data

POST

/users/{id}/data/reset

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.proxyrequest.com/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/data/reset");

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, "{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\" }");

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://api.proxyrequest.com/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/data/reset"),
    Headers =
    {
        { "Accept-Language", "de" },
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\" }")
    {
        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/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/data/reset"

  payload := strings.NewReader("{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\" }")

  req, _ := http.NewRequest("POST", 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/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/data/reset"))
    .header("Accept-Language", "de")
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\" }"))
    .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, "{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\" }");
Request request = new Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/data/reset")
  .post(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: 'POST',
  url: 'https://api.proxyrequest.com/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/data/reset',
  headers: {
    'Accept-Language': 'de',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  data: {package_id: '550e8400-e29b-41d4-a716-446655440002'}
};

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

const url = 'https://api.proxyrequest.com/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/data/reset';
const options = {
  method: 'POST',
  headers: {
    'Accept-Language': 'de',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"package_id":"550e8400-e29b-41d4-a716-446655440002"}'
};

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, "{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\" }")
val request = Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/data/reset")
  .post(body)
  .addHeader("Accept-Language", "de")
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build()

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

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.proxyrequest.com/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/data/reset";

    let payload = json!({"package_id": "550e8400-e29b-41d4-a716-446655440002"});

    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.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

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

    dbg!(results);
}

curl --request POST \
  --url https://api.proxyrequest.com/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/data/reset \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "package_id": "550e8400-e29b-41d4-a716-446655440002" }'

wget --quiet \
  --method POST \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --body-data '{ "package_id": "550e8400-e29b-41d4-a716-446655440002" }' \
  --output-document \
  - https://api.proxyrequest.com/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/data/reset

Atomically resets remaining data to zero for package_id, including zero or negative balances. Supply package_id only; data is not accepted. System administrators may reset any user; other accounts may reset only their direct children. Purchased root orders have their ledger balances cleared; virtual child orders have their quota set to usage without changing the parent’s pool. Usage history and invoices are preserved. Unlimited packages are rejected. Use Idempotency-Key for safe retries so a repeated request cannot clear a subsequent top-up.

Authorizations

BearerAuth
StaticAuth

Parameters

Path Parameters

required

string format: uuid

A UUID string identifying this user.

Header Parameters

Idempotency-Key

string

<= 255 characters

Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409.

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^required

object

package_id

required

Package whose remaining data is reset to zero.

string format: uuid

Examples

ResetDataRequest

Reset data request

{
  "package_id": "550e8400-e29b-41d4-a716-446655440002"
}

object

package_id

required

Package whose remaining data is reset to zero.

string format: uuid

Examples

ResetDataRequest

Reset data request

package_id=550e8400-e29b-41d4-a716-446655440002

object

package_id

required

Package whose remaining data is reset to zero.

string format: uuid

Examples

ResetDataRequest

Reset data request

{
  "package_id": "550e8400-e29b-41d4-a716-446655440002"
}

Responses

202

The request was accepted and the updated resource is returned.

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

string

<= 36 characters

name

required

Unique display name for this package shown to customers and in the admin. Residential Starter Business Pro

string

>= 2 characters <= 255 characters

alias

required

Lowercase alphanumeric identifier used internally for package resolution and proxy username routing. Cannot be changed without affecting active connections. residential01 bizpro

string

>= 2 characters <= 255 characters /^[a-z0-9]+$/

is_unlimited_data

Unlimited Data

When enabled, users on this package have no data cap. The proxy will not enforce any bandwidth limit.

boolean

targeting_options

required

object

package

required

string

split_char

required

string

value_char

required

string

continent

required

string

country

required

string

region

required

string

city

required

string

asn

required

string

isp

required

string

username

required

string

pool

required

string

location

required

string

location_format

required

string

session

required

string

session_mode_tag

required

string

session_ttl

required

string

session_ttl_format

required

integer

required

string

os_combined

required

boolean

os_split_char

required

string

os_linux

required

string

os_windows

required

string

os_ios

required

string

os_macos

required

string

os_android

required

string

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>

A purchased data bucket, not a complete transaction history. Finite purchases with an expiration have separate buckets. Compatible non-expiring top-ups and unlimited packages may reuse an existing bucket.

object

required

string

data

required

Data Amount (bytes)

Total data allocated to this ledger entry in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB

integer

data_remaining

required

Remaining Data (bytes)

Bytes still available for consumption from this ledger entry. Decremented in FIFO order as the customer uses the proxy. When this reaches zero the entry is exhausted.

integer

expires

required

Expiration Date

Date and time when this ledger entry expires and any remaining data is forfeited. Leave blank for entries that do not expire.

string format: date-time

nullable

updated

required

string format: date-time

created

required

string format: date-time

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": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Residential 10 GB",
    "alias": "residential-10gb",
    "is_unlimited_data": true,
    "targeting_options": {
      "package": "package",
      "split_char": "-",
      "value_char": "-",
      "continent": "continent",
      "country": "us",
      "region": "california",
      "city": "los_angeles",
      "asn": "15169",
      "isp": "comcast",
      "username": "developer",
      "pool": "residential",
      "location": "location",
      "location_format": "location format",
      "session": "session",
      "session_mode_tag": "session mode tag",
      "session_ttl": "session ttl",
      "session_ttl_format": 1,
      "os": "os",
      "os_combined": true,
      "os_split_char": "os split char",
      "os_linux": "os linux",
      "os_windows": "os windows",
      "os_ios": "os ios",
      "os_macos": "os macos",
      "os_android": "os android"
    }
  },
  "proxy_password": "p9W4rT2xK7mQ",
  "proxy_password_reset": "2026-07-01T12:30:00Z",
  "pools": [
    "residential"
  ],
  "data": 1073741824,
  "data_remaining": 1,
  "data_spent": 1073741824,
  "ledgers": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "data": 1073741824,
      "data_remaining": 1,
      "expires": "2026-07-01T12:30:00Z",
      "updated": "2026-07-01T12:30:00Z",
      "created": "2026-07-01T12:30:00Z"
    }
  ],
  "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

Idempotency-Replayed

string

Allowed values: true

True when the response was replayed from a prior request.

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.

409

The idempotency key is in progress or was reused for a different request.

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

Content-Language

string

Language used for human-readable errors.

Reset a user's remaining data

Authorizations

Parameters

Path Parameters

Header Parameters

Examples

Request Bodyrequired

Examples

Examples

Examples

Responses

202

Examples

Headers

400

Examples

Headers

401

Examples

Headers

403

Examples

Headers

404

Examples

Headers

409

Examplegenerated

Headers

Request Body^required

Example^generated