Buy residential data
Buy whole GB of residential IP data from your Orgo credits, at $3 per GB. Retries with the same Idempotency-Key never buy twice.
expected_price_cents. If the price has moved, the answer is 409 with code PRICE_CHANGED and the new price_cents, and nothing is spent.
Who can buy
The data belongs to the workspace owner, and every computer in the owner’s workspaces draws on it. Buy with the owner’s sign-in, or a key for the whole account with full access or Billing write.- The account needs a paid plan or credit it bought (
403PLAN_REQUIRED), and a Linux computer outside Bops (403RESIDENTIAL_NO_COMPUTER). - A key for one workspace or one computer answers
403ACCOUNT_KEY_REQUIRED. An MCP sign-in answers403RESIDENTIAL_BUY_NEEDS_BILLING. A share-link guest answers403GUEST_RESTRICTED. desktop_idis optional. When sent, only that computer’s workspace owner may buy: anyone else gets403ACCOUNT_OWNER_REQUIRED.- When the credits don’t cover it, the answer is
402INSUFFICIENT_CREDITSwithprice_centsandavailable_cents, and nothing is spent.
Retries never buy twice
Send a new UUID asIdempotency-Key for each purchase. A retry with the same key answers what the first call came to, whatever has changed since:
409 RESIDENTIAL_PURCHASE_IN_PROGRESS means another purchase for the account is still finishing. Try again in a minute.
Auto-buy
Auto-buy buys 1 GB when the account’s data falls under 0.25 GB, up to a monthly limit, after the month’s included data is used. It starts after the account’s first purchase by hand, which accepts the Residential IPs terms: until thenterms_accepted is false and auto-buy buys nothing. Only a person signed in to Orgo turns it on, in Settings → Plan & billing. No key can.Authorizations
API key authentication. Get your key at orgo.ai/workspaces
Headers
A new UUID for each purchase (8 to 255 printable characters). A retry with it never buys twice.
8 - 255Body
Whole GB to buy. One purchase has a most; past it the answer is 400 invalid_gb, and its error names the range.
x >= 1The price of 1 GB you agreed to, in cents, as price_cents in GET /api/billing/residential-data read it.
Optional. The computer this is for. Only its workspace owner may buy for it: anyone else gets 403 ACCOUNT_OWNER_REQUIRED.
Response
Added and charged.