Check out a rental reservation

POST

/static/purchases/{id}/checkout

CURL *hnd = curl_easy_init();

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

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, "{ \"country_code\": \"us\", \"company_vat_number\": \"company vat number\", \"company_name\": \"company name\", \"company_registration_number\": \"company registration number\", \"gateway\": \"crypto\", \"crypto_currency\": \"btc\", \"payment_currency\": \"payment currency\", \"coupon_code\": \"coupon code\" }");

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/static/purchases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/checkout"),
    Headers =
    {
        { "Accept-Language", "de" },
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"country_code\": \"us\", \"company_vat_number\": \"company vat number\", \"company_name\": \"company name\", \"company_registration_number\": \"company registration number\", \"gateway\": \"crypto\", \"crypto_currency\": \"btc\", \"payment_currency\": \"payment currency\", \"coupon_code\": \"coupon code\" }")
    {
        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/static/purchases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/checkout"

  payload := strings.NewReader("{ \"country_code\": \"us\", \"company_vat_number\": \"company vat number\", \"company_name\": \"company name\", \"company_registration_number\": \"company registration number\", \"gateway\": \"crypto\", \"crypto_currency\": \"btc\", \"payment_currency\": \"payment currency\", \"coupon_code\": \"coupon code\" }")

  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/static/purchases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/checkout"))
    .header("Accept-Language", "de")
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"country_code\": \"us\", \"company_vat_number\": \"company vat number\", \"company_name\": \"company name\", \"company_registration_number\": \"company registration number\", \"gateway\": \"crypto\", \"crypto_currency\": \"btc\", \"payment_currency\": \"payment currency\", \"coupon_code\": \"coupon code\" }"))
    .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, "{ \"country_code\": \"us\", \"company_vat_number\": \"company vat number\", \"company_name\": \"company name\", \"company_registration_number\": \"company registration number\", \"gateway\": \"crypto\", \"crypto_currency\": \"btc\", \"payment_currency\": \"payment currency\", \"coupon_code\": \"coupon code\" }");
Request request = new Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/static/purchases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/checkout")
  .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/static/purchases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/checkout',
  headers: {
    'Accept-Language': 'de',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  data: {
    country_code: 'us',
    company_vat_number: 'company vat number',
    company_name: 'company name',
    company_registration_number: 'company registration number',
    gateway: 'crypto',
    crypto_currency: 'btc',
    payment_currency: 'payment currency',
    coupon_code: 'coupon code'
  }
};

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

const url = 'https://api.proxyrequest.com/api/v1/static/purchases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/checkout';
const options = {
  method: 'POST',
  headers: {
    'Accept-Language': 'de',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"country_code":"us","company_vat_number":"company vat number","company_name":"company name","company_registration_number":"company registration number","gateway":"crypto","crypto_currency":"btc","payment_currency":"payment currency","coupon_code":"coupon code"}'
};

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, "{ \"country_code\": \"us\", \"company_vat_number\": \"company vat number\", \"company_name\": \"company name\", \"company_registration_number\": \"company registration number\", \"gateway\": \"crypto\", \"crypto_currency\": \"btc\", \"payment_currency\": \"payment currency\", \"coupon_code\": \"coupon code\" }")
val request = Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/static/purchases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/checkout")
  .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/static/purchases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/checkout";

    let payload = json!({
        "country_code": "us",
        "company_vat_number": "company vat number",
        "company_name": "company name",
        "company_registration_number": "company registration number",
        "gateway": "crypto",
        "crypto_currency": "btc",
        "payment_currency": "payment currency",
        "coupon_code": "coupon code"
    });

    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/static/purchases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/checkout \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "country_code": "us", "company_vat_number": "company vat number", "company_name": "company name", "company_registration_number": "company registration number", "gateway": "crypto", "crypto_currency": "btc", "payment_currency": "payment currency", "coupon_code": "coupon code" }'

wget --quiet \
  --method POST \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --body-data '{ "country_code": "us", "company_vat_number": "company vat number", "company_name": "company name", "company_registration_number": "company registration number", "gateway": "crypto", "crypto_currency": "btc", "payment_currency": "payment currency", "coupon_code": "coupon code" }' \
  --output-document \
  - https://api.proxyrequest.com/api/v1/static/purchases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/checkout

Create one shared billing invoice for this reservation using the selected gateway, coupon and billing details. A repeated request returns the existing invoice.

Authorizations

BearerAuth
StaticAuth

Parameters

Path Parameters

required

string format: uuid

Header Parameters

Accept-Language

string

default: en

Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es. 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

Invoice transport validation with an explicitly composed application command.

object

country_code

string

>= 1 characters <= 2 characters

company_vat_number

string

>= 1 characters <= 128 characters

company_name

string

>= 1 characters <= 128 characters

company_registration_number

string

>= 1 characters <= 128 characters

gateway

required

crypto - crypto * credit_card - credit_card * wallet - wallet * manual - manual * stripe - stripe * coinbase - coinbase * cryptomus - cryptomus * coingate - coingate * whitepay - whitepay * wayforpay - wayforpay * usegateway - usegateway * binance - binance * anymoney - anymoney * coinpayments - coinpayments * checkoutcom - checkoutcom * nowpayments - nowpayments * btcpay - btcpay * braintree - braintree * monobank - monobank * liqpay - liqpay * iyzico - iyzico * paytr - paytr * payu - payu * tpay - tpay * przelewy24 - przelewy24 * gopay - gopay * comgate - comgate * monei - monei * redsys - redsys * payplug - payplug * mollie - mollie * unzer - unzer * payone - payone * nexi_xpay - nexi_xpay * halyk_epay - halyk_epay * kaspi_pay - kaspi_pay * vipps_mobilepay - vipps_mobilepay * paytrail - paytrail

string

Allowed values: crypto credit_card wallet manual stripe coinbase cryptomus coingate whitepay wayforpay usegateway binance anymoney coinpayments checkoutcom nowpayments btcpay braintree monobank liqpay iyzico paytr payu tpay przelewy24 gopay comgate monei redsys payplug mollie unzer payone nexi_xpay halyk_epay kaspi_pay vipps_mobilepay paytrail

crypto_currency

btc - btc * eth - eth * usdt - usdt

string

Allowed values: btc eth usdt

payment_currency

string

>= 1 characters <= 3 characters

coupon_code

string

<= 64 characters

Examples

example

Example request

{
  "country_code": "us",
  "company_vat_number": "company vat number",
  "company_name": "company name",
  "company_registration_number": "company registration number",
  "gateway": "crypto",
  "crypto_currency": "btc",
  "payment_currency": "payment currency",
  "coupon_code": "coupon code"
}

Invoice transport validation with an explicitly composed application command.

object

country_code

string

>= 1 characters <= 2 characters

company_vat_number

string

>= 1 characters <= 128 characters

company_name

string

>= 1 characters <= 128 characters

company_registration_number

string

>= 1 characters <= 128 characters

gateway

required

crypto - crypto * credit_card - credit_card * wallet - wallet * manual - manual * stripe - stripe * coinbase - coinbase * cryptomus - cryptomus * coingate - coingate * whitepay - whitepay * wayforpay - wayforpay * usegateway - usegateway * binance - binance * anymoney - anymoney * coinpayments - coinpayments * checkoutcom - checkoutcom * nowpayments - nowpayments * btcpay - btcpay * braintree - braintree * monobank - monobank * liqpay - liqpay * iyzico - iyzico * paytr - paytr * payu - payu * tpay - tpay * przelewy24 - przelewy24 * gopay - gopay * comgate - comgate * monei - monei * redsys - redsys * payplug - payplug * mollie - mollie * unzer - unzer * payone - payone * nexi_xpay - nexi_xpay * halyk_epay - halyk_epay * kaspi_pay - kaspi_pay * vipps_mobilepay - vipps_mobilepay * paytrail - paytrail

string

crypto_currency

btc - btc * eth - eth * usdt - usdt

string

Allowed values: btc eth usdt

payment_currency

string

>= 1 characters <= 3 characters

coupon_code

string

<= 64 characters

Examples

example

Example request

country_code=us&company_vat_number=company+vat+number&company_name=company+name&company_registration_number=company+registration+number&gateway=crypto&crypto_currency=btc&payment_currency=payment+currency&coupon_code=coupon+code

Invoice transport validation with an explicitly composed application command.

object

country_code

string

>= 1 characters <= 2 characters

company_vat_number

string

>= 1 characters <= 128 characters

company_name

string

>= 1 characters <= 128 characters

company_registration_number

string

>= 1 characters <= 128 characters

gateway

required

crypto - crypto * credit_card - credit_card * wallet - wallet * manual - manual * stripe - stripe * coinbase - coinbase * cryptomus - cryptomus * coingate - coingate * whitepay - whitepay * wayforpay - wayforpay * usegateway - usegateway * binance - binance * anymoney - anymoney * coinpayments - coinpayments * checkoutcom - checkoutcom * nowpayments - nowpayments * btcpay - btcpay * braintree - braintree * monobank - monobank * liqpay - liqpay * iyzico - iyzico * paytr - paytr * payu - payu * tpay - tpay * przelewy24 - przelewy24 * gopay - gopay * comgate - comgate * monei - monei * redsys - redsys * payplug - payplug * mollie - mollie * unzer - unzer * payone - payone * nexi_xpay - nexi_xpay * halyk_epay - halyk_epay * kaspi_pay - kaspi_pay * vipps_mobilepay - vipps_mobilepay * paytrail - paytrail

string

crypto_currency

btc - btc * eth - eth * usdt - usdt

string

Allowed values: btc eth usdt

payment_currency

string

>= 1 characters <= 3 characters

coupon_code

string

<= 64 characters

Examples

example

Example request

{
  "country_code": "us",
  "company_vat_number": "company vat number",
  "company_name": "company name",
  "company_registration_number": "company registration number",
  "gateway": "crypto",
  "crypto_currency": "btc",
  "payment_currency": "payment currency",
  "coupon_code": "coupon code"
}

Responses

200

The operation completed 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

connection_limit

required

integer

country

required

object

count

required

Node count in Rust search mode.

integer

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

count

required

Node count in Rust search mode; unknown quantities are zero.

integer

code

required

string

name

required

string

asns

required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

Array<object>

object

count

required

Node count in Rust search mode; unknown quantities are zero.

integer

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

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

connection_limit

required

integer

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

payment_amount

required

integer

payment_currency

required

string

fx_market_rate

required

string

fx_effective_rate

required

string

fx_markup_percent

required

string

fx_quoted_at

required

string format: date-time

nullable

updated

required

string format: date-time

created

required

string format: date-time

rental_kind

required

string

rental_status

required

string

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

Whether this pricing tier is restricted to a one-time purchase. False does not create a recurring subscription or a renewal schedule.

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

Payment state. A paid package invoice funds an order; a paid balance invoice credits money. Confirm the resulting order before delivering access, because fulfillment can recover asynchronously. Creating an invoice with status=paid requires a superuser. This read field is not a public status-update or refund endpoint. * 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 * whitepay - Whitepay * wayforpay - WayForPay * usegateway - UseGateway * binance - Binance Pay * anymoney - Any.Money * coinpayments - CoinPayments * checkoutcom - Checkout.com * nowpayments - NOWPayments * btcpay - BTCPay Server * braintree - Braintree * monobank - monobank * liqpay - LiqPay * iyzico - iyzico * paytr - PayTR * payu - PayU * tpay - Tpay * przelewy24 - Przelewy24 * gopay - GoPay * comgate - Comgate * monei - MONEI * redsys - Redsys * payplug - PayPlug * mollie - Mollie * unzer - Unzer * payone - PAYONE * nexi_xpay - Nexi XPay * halyk_epay - Halyk ePay * kaspi_pay - Kaspi Pay * vipps_mobilepay - Vipps MobilePay * paytrail - Paytrail

string

Allowed values: coinbase cryptomus stripe coingate wallet manual whitepay wayforpay usegateway binance anymoney coinpayments checkoutcom nowpayments btcpay braintree monobank liqpay iyzico paytr payu tpay przelewy24 gopay comgate monei redsys payplug mollie unzer payone nexi_xpay halyk_epay kaspi_pay vipps_mobilepay paytrail

payment_url

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

string format: uri

<= 500 characters

currency

Billing Currency

ISO 4217 currency captured when the invoice is created.

string

<= 3 characters

provider_checkout_id

Provider-side hosted checkout identifier used for reconciliation.

string

<= 255 characters

provider_payment_id

Provider-side payment or transaction identifier used for reconciliation.

string

<= 255 characters

checkout_status

not_required - Not required * initializing - Initializing * ready - Ready * failed - Failed

string

Allowed values: not_required initializing ready failed

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

rental_order

required

string

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"
    },
    "connection_limit": 1
  },
  "country": "us",
  "user_id": "550e8400-e29b-41d4-a716-446655440001",
  "coupon": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "is_expired": true,
    "is_redeemed": true,
    "packages": [
      {
        "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"
        },
        "connection_limit": 1
      }
    ],
    "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"
  },
  "payment_amount": 1,
  "payment_currency": "payment currency",
  "fx_market_rate": "fx market rate",
  "fx_effective_rate": "fx effective rate",
  "fx_markup_percent": "fx markup percent",
  "fx_quoted_at": "2026-07-01T12:30:00Z",
  "updated": "2026-07-01T12:30:00Z",
  "created": "2026-07-01T12:30:00Z",
  "rental_kind": "rental kind",
  "rental_status": "rental status",
  "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",
  "currency": "USD",
  "provider_checkout_id": "550e8400-e29b-41d4-a716-446655440001",
  "provider_payment_id": "550e8400-e29b-41d4-a716-446655440001",
  "checkout_status": "not_required",
  "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",
  "rental_order": "rental order"
}

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

example

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

example

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

example

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

example

Resource not found

{
  "detail": "Not found."
}

Headers

Content-Language

string

Language used for human-readable errors.

Check out a rental reservation

Authorizations

Parameters

Path Parameters

Header Parameters

Examples

Request Bodyrequired

Examples

Examples

Examples

Responses

200

Examples

400

Examples

Headers

401

Examples

Headers

403

Examples

Headers

404

Examples

Headers

Request Body^required