Orgo - Cloud computers for AI agents

GET

billing

residential-data

Get residential data

curl --request GET \
  --url https://www.orgo.ai/api/billing/residential-data \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.orgo.ai/api/billing/residential-data', 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://www.orgo.ai/api/billing/residential-data",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://www.orgo.ai/api/billing/residential-data"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.orgo.ai/api/billing/residential-data")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "left_bytes": 1885339648,
  "counted_at": "2026-11-10T14:05:00.000Z",
  "price_cents": 300,
  "can_buy": true,
  "buy_blocked_reason": null,
  "available_cents": 1250,
  "terms_accepted": true,
  "purchases": [
    {
      "id": "5f0c2b8e-3a1d-4c7e-9b2f-8d6a4e1c0b93",
      "gb": 1,
      "price_cents": 300,
      "status": "added",
      "auto": false,
      "created_at": "2026-11-03T09:12:44.000Z"
    }
  ],
  "auto_buy": {
    "enabled": false,
    "available": true,
    "monthly_cap_gb": null,
    "price_cents": null,
    "paused_reason": null,
    "bought_this_month_gb": 0
  },
  "included": {
    "plan": "Starter",
    "gb_per_month": 1,
    "used_bytes": 262144000,
    "left_bytes": 811597824,
    "resets_at": "2026-12-01T00:00:00.000Z"
  }
}

Reads the calling account’s own residential data: what is left, what the plan includes this UTC month, the price of 1 GB, whether the account can buy now, its credits, its purchases and its auto-buy setting. Read it before Buy residential data, and send its price_cents as expected_price_cents. See Residential IP.

It reads the account that calls, never a workspace’s: use the workspace owner’s sign-in or an account-wide key with Billing read. A key for one workspace or one computer answers 403 with code ACCOUNT_KEY_REQUIRED, and a share-link guest 403 with GUEST_RESTRICTED.

curl https://www.orgo.ai/api/billing/residential-data \
  -H "Authorization: Bearer $ORGO_API_KEY"

left_bytes counts data bought and this month’s included data. It is the network’s count at counted_at, less what the computers reported since, so it is an estimate between counts.
included is what the plan includes this UTC month: 1 GB on Starter, 5 GB on Growth, 20 GB on Scale and Enterprise. It is used before data bought, comes back in full at resets_at, and does not roll over. It is absent on a plan with none, such as Free.
can_buy is false with buy_blocked_reason: not_paying (the account needs a paid plan or credit it bought), credit_short (the credits don’t cover 1 GB) or unavailable (data can’t be added right now).
purchases lists the last 20, newest first. A pending purchase has its credits held, not spent; a returned one was not added, and its credits went back.
auto_buy is set by a person in Settings → Plan & billing, never by a key. It buys nothing until the account has bought once by hand (terms_accepted).

Authorizations

Authorization

string

header

required

API key authentication. Get your key at orgo.ai/workspaces

Response

The account’s residential data.

left_bytes

integer

required

Data left: bought, and this month’s included data. As the network last counted it, less what the computers reported since, never below zero. An estimate between counts.

counted_at

string<date-time> | null

required

When the network last counted the account’s use. Null before the first count.

price_cents

integer | null

required

The price of 1 GB, in cents. Null while it is not for sale.

can_buy

boolean

required

The account can buy data now.

buy_blocked_reason

enum<string> | null

required

not_paying: the account needs a paid plan or credit it bought. credit_short: the credits don’t cover 1 GB. unavailable: data can’t be added right now. Null when can_buy is true.

Available options:

not_paying,

credit_short,

unavailable,

null

available_cents

integer | null

required

The account’s credits, in cents, when they were read.

purchases

object[]

required

Newest first, at most 20. Included data is not a purchase.

Show child attributes

auto_buy

object

required

Buying 1 GB from credits when data falls under 0.25 GB. Set by a person in Plan and billing, and only there. It buys nothing until the account has bought once by hand, which accepts the Residential IPs terms (terms_accepted).

Show child attributes

terms_accepted

boolean

The account has bought before, and with that accepted the Residential IPs terms. Auto-buy buys nothing while this is false. Absent while it is not for sale.

included

object

Residential data the plan includes this UTC month, used before data bought. Absent on a plan with none, such as Free.

Show child attributes

Get residential data

curl --request GET \
  --url https://www.orgo.ai/api/billing/residential-data \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.orgo.ai/api/billing/residential-data', 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://www.orgo.ai/api/billing/residential-data",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://www.orgo.ai/api/billing/residential-data"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.orgo.ai/api/billing/residential-data")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "left_bytes": 1885339648,
  "counted_at": "2026-11-10T14:05:00.000Z",
  "price_cents": 300,
  "can_buy": true,
  "buy_blocked_reason": null,
  "available_cents": 1250,
  "terms_accepted": true,
  "purchases": [
    {
      "id": "5f0c2b8e-3a1d-4c7e-9b2f-8d6a4e1c0b93",
      "gb": 1,
      "price_cents": 300,
      "status": "added",
      "auto": false,
      "created_at": "2026-11-03T09:12:44.000Z"
    }
  ],
  "auto_buy": {
    "enabled": false,
    "available": true,
    "monthly_cap_gb": null,
    "price_cents": null,
    "paused_reason": null,
    "bought_this_month_gb": 0
  },
  "included": {
    "plan": "Starter",
    "gb_per_month": 1,
    "used_bytes": 262144000,
    "left_bytes": 811597824,
    "resets_at": "2026-12-01T00:00:00.000Z"
  }
}

Overview

API keys

Support

Account

Agent signups

Clients

Computer use

Workspaces

Computers

Public URLs

Lifecycle

Actions

Screens

Files

Templates

Workflows

Get residential data

Authorizations

Response