Create an invoice

POST

/invoices

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.proxyrequest.com/api/v1/invoices");

struct curl_slist *headers = NULL;
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\", \"data\": 10737418240, \"gateway\": \"stripe\" }");

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/invoices"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"data\": 10737418240, \"gateway\": \"stripe\" }")
    {
        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/invoices"

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

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

  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/invoices"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"data\": 10737418240, \"gateway\": \"stripe\" }"))
    .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\", \"data\": 10737418240, \"gateway\": \"stripe\" }");
Request request = new Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/invoices")
  .post(body)
  .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/invoices',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  data: {
    package_id: '550e8400-e29b-41d4-a716-446655440002',
    data: 10737418240,
    gateway: 'stripe'
  }
};

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

const url = 'https://api.proxyrequest.com/api/v1/invoices';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"package_id":"550e8400-e29b-41d4-a716-446655440002","data":10737418240,"gateway":"stripe"}'
};

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\", \"data\": 10737418240, \"gateway\": \"stripe\" }")
val request = Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/invoices")
  .post(body)
  .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/invoices";

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

    let mut headers = reqwest::header::HeaderMap::new();
    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/invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "package_id": "550e8400-e29b-41d4-a716-446655440002", "data": 10737418240, "gateway": "stripe" }'

wget --quiet \
  --method POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --body-data '{ "package_id": "550e8400-e29b-41d4-a716-446655440002", "data": 10737418240, "gateway": "stripe" }' \
  --output-document \
  - https://api.proxyrequest.com/api/v1/invoices

Calculates package pricing, creates a pending invoice, and initializes the selected payment provider when required.

Authorizations

BearerAuth
StaticAuth

Request Body^required

object

package_id

Package to purchase. Required for package purchases.

string format: uuid

user_id

Managed sub-user that should receive the purchase.

string format: uuid

gateway

required

crypto - crypto * wallet - wallet * manual - manual * stripe - stripe

string

Allowed values: crypto wallet manual stripe

crypto_currency

string

>= 1 characters

coupon_code

string

country_code

string

>= 1 characters <= 2 characters

data

Residential proxy data to purchase, in bytes.

integer

quantity

Number of static proxies to purchase.

integer

amount

Account balance amount to purchase, in the smallest currency unit.

integer

connection_limit

integer

>= -1

expires

Optional expiration as a Unix timestamp in seconds.

integer

company_name

string

>= 1 characters

company_registration_number

string

>= 1 characters

company_vat_number

string

>= 1 characters

Examples

PurchaseResidentialData

Purchase residential data

{
  "package_id": "550e8400-e29b-41d4-a716-446655440002",
  "data": 10737418240,
  "gateway": "stripe"
}

object

package_id

Package to purchase. Required for package purchases.

string format: uuid

user_id

Managed sub-user that should receive the purchase.

string format: uuid

gateway

required

crypto - crypto * wallet - wallet * manual - manual * stripe - stripe

string

Allowed values: crypto wallet manual stripe

crypto_currency

string

>= 1 characters

coupon_code

string

country_code

string

>= 1 characters <= 2 characters

data

Residential proxy data to purchase, in bytes.

integer

quantity

Number of static proxies to purchase.

integer

amount

Account balance amount to purchase, in the smallest currency unit.

integer

connection_limit

integer

>= -1

expires

Optional expiration as a Unix timestamp in seconds.

integer

company_name

string

>= 1 characters

company_registration_number

string

>= 1 characters

company_vat_number

string

>= 1 characters

Examples

example

Example request

package_id=550e8400-e29b-41d4-a716-446655440002&user_id=550e8400-e29b-41d4-a716-446655440001&gateway=crypto&crypto_currency=crypto+currency&coupon_code=coupon+code&country_code=us&data=1073741824&quantity=1&amount=1073741824&connection_limit=1&expires=1&company_name=company+name&company_registration_number=company+registration+number&company_vat_number=company+vat+number

object

package_id

Package to purchase. Required for package purchases.

string format: uuid

user_id

Managed sub-user that should receive the purchase.

string format: uuid

gateway

required

crypto - crypto * wallet - wallet * manual - manual * stripe - stripe

string

Allowed values: crypto wallet manual stripe

crypto_currency

string

>= 1 characters

coupon_code

string

country_code

string

>= 1 characters <= 2 characters

data

Residential proxy data to purchase, in bytes.

integer

quantity

Number of static proxies to purchase.

integer

amount

Account balance amount to purchase, in the smallest currency unit.

integer

connection_limit

integer

>= -1

expires

Optional expiration as a Unix timestamp in seconds.

integer

company_name

string

>= 1 characters

company_registration_number

string

>= 1 characters

company_vat_number

string

>= 1 characters

Examples

example

Example request

{
  "package_id": "550e8400-e29b-41d4-a716-446655440002",
  "user_id": "550e8400-e29b-41d4-a716-446655440001",
  "gateway": "crypto",
  "crypto_currency": "crypto currency",
  "coupon_code": "coupon code",
  "country_code": "us",
  "data": 1073741824,
  "quantity": 1,
  "amount": 1073741824,
  "connection_limit": 1,
  "expires": 1,
  "company_name": "company name",
  "company_registration_number": "company registration number",
  "company_vat_number": "company vat number"
}

Responses

201

The resource or action result was created successfully.

application/json

object

string

<= 36 characters

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

country

required

object

string

<= 36 characters

code

required

ISO 3166-1 Alpha-2 Code

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

string

<= 10 characters

name

required

English display name of the country used across the admin and API responses.

string

<= 255 characters

original_name

Native-language name of the country as it appears in the source data. Deutschland Français

string

<= 255 characters

isps

required

Array<object>

object

code

required

string

name

required

string

asns

required

Array<object>

object

code

required

string

name

required

string

user_id

required

string format: uuid

coupon

required

object

string

<= 36 characters

is_expired

required

boolean

is_redeemed

required

boolean

packages

required

Array<object>

object

key

additional properties

created

required

string format: date-time

value

required

Arbitrary coupon value

integer format: int64

>= -9223372036854776000 <= 9223372036854776000

code

required

Leaving this field empty will generate a random code.

string

is_multi_use

Multi-use

If true, coupon can be used multiple times.

boolean

is_available_to_one_time

Available for One-Time Purchases

If true, coupon can not be used for one-time package tiers.

boolean

type

required

free_data - Free Data * monetary - Money * percentage - Percentage

string

Allowed values: free_data monetary percentage

limit

Number of times coupon can be used

integer

>= -2147483648 <= 2147483647

valid_until

Leave empty for coupons that never expire

string format: date-time

nullable

marketer

The marketer who owns this coupon. Required if is_marketer is true.

string format: uuid

nullable

user

required

The user who created this coupon.

string format: uuid

nullable

updated

required

string format: date-time

created

required

string format: date-time

type

The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * static - Static * residential - Residential * balance - Balance

string

Allowed values: static residential balance

is_one_time

One-Time Purchase

Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.

boolean

is_payout

Payout

Indicates whether this invoice is a payout to the marketer. Default is False.

boolean

internal_id

A unique identifier for the invoice, generated automatically.

string

<= 25 characters

status

After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package’s data or proxies. * pending - Pending * paid - Paid * unpaid - Unpaid * error - Error

string

Allowed values: pending paid unpaid error

description

A description of the invoice. This field is optional and can be left blank.

string

connection_limit

The maximum number of concurrent connections allowed for this package.

integer

>= -1 <= 2147483647

quantity

The number of proxies to assign.

integer

<= 2147483647

data

Data (bytes)

The amount of data in bytes.

integer format: int64

<= 1000000000000000

balance

Balance Top Up (cents)

The balance to top up for the user. Must be zero or positive.

integer format: int64

<= 10000000000

price_total

Price (cents)

The total price of the invoice, including any discounts. Must be at least 1 cent.

integer format: int64

>= 1 <= 10000000000

gateway

Payment Gateway

The payment gateway used for processing the payment. * coinbase - Coinbase * cryptomus - Cryptomus * stripe - Stripe * coingate - Coingate * wallet - Wallet * manual - Manual

string

Allowed values: coinbase cryptomus stripe coingate wallet manual

payment_url

The URL for making the payment. Optional field with a maximum length of 500 characters.

string format: uri

<= 500 characters

coingate_order_token

The Coingate order token for the payment. Optional field with a maximum length of 255 characters.

string

<= 255 characters

coinbase_charge_id

The Coinbase charge ID for the payment. Optional field with a maximum length of 255 characters.

string

<= 255 characters

vat

VAT (%)

The VAT percentage applied to the invoice. Must be between 0 and 100.

number format: double

<= 100

company_name

string

<= 255 characters

company_address

string

<= 255 characters

company_city

string

<= 255 characters

company_postal_code

string

<= 255 characters

company_registration_number

string

<= 255 characters

company_vat_number

string

<= 255 characters

paid

The date and time when the invoice was paid.

string format: date-time

nullable

Examples

example

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "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"
    }
  },
  "country": "us",
  "user_id": "550e8400-e29b-41d4-a716-446655440001",
  "coupon": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "is_expired": true,
    "is_redeemed": true,
    "packages": [
      {}
    ],
    "created": "2026-07-01T12:30:00Z",
    "value": 1,
    "code": "us",
    "is_multi_use": true,
    "is_available_to_one_time": true,
    "type": "free_data",
    "limit": 100,
    "valid_until": "2026-07-01T12:30:00Z",
    "marketer": "550e8400-e29b-41d4-a716-446655440001",
    "user": "550e8400-e29b-41d4-a716-446655440001"
  },
  "updated": "2026-07-01T12:30:00Z",
  "created": "2026-07-01T12:30:00Z",
  "type": "static",
  "is_one_time": true,
  "is_payout": true,
  "internal_id": "550e8400-e29b-41d4-a716-446655440001",
  "status": "pending",
  "description": "description",
  "connection_limit": 1,
  "quantity": 1,
  "data": 1073741824,
  "balance": 1,
  "price_total": 1,
  "gateway": "coinbase",
  "payment_url": "https://developer.example.com/resource",
  "coingate_order_token": "coingate order token",
  "coinbase_charge_id": "550e8400-e29b-41d4-a716-446655440001",
  "vat": 24.99,
  "company_name": "company name",
  "company_address": "company address",
  "company_city": "company city",
  "company_postal_code": "company postal code",
  "company_registration_number": "company registration number",
  "company_vat_number": "company vat number",
  "paid": "2026-07-01T12:30:00Z"
}

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>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

ValidationError

Validation error

{
  "non_field_errors": [
    "The request could not be processed."
  ],
  "translation": "errors.request.invalid"
}

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>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

AuthenticationRequired

Authentication required

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

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>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

PermissionDenied

Permission denied

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

Create an invoice

Authorizations

Request Bodyrequired

Examples

Examples

Examples

Responses

201

Examples

400

Examples

401

Examples

403

Examples

Request Body^required