# New package / top-up price; no debit `POST /account/api/v1/residential/quote` ## Authorization `Authorization: Bearer YOUR_ARNPROXY_API_KEY` `Accept: application/json` Required permission: `read` `Content-Type: application/json` ## Parameters | Name | Type | Required / Conditional | Default | Description | |---|---|---|---|---| | `mode` (body) | string | Required | — | new creates a package; topup adds GB to an owned package. | | `time_id` (body) | integer | Required | — | Period/GB-plan ID from the matching catalog/options, not a day/GB count. | | `location_id` (body) | integer | Conditional | — | Required for mode=new only; forbidden for topup. | | `package_id` (body) | integer | Conditional | — | Required for mode=topup only; forbidden for new. | | `promo_code` (body) | string | Optional | `""` | Optional promo, up to 100 bytes. Keep it identical between quote and purchase/renewal. | ## Request body Replace YOUR_/FROM_ placeholders with values from the relevant catalog, quote or scope. Examples leave consent false; only approve a real operation intentionally. ```json { "mode": "topup", "package_id": "YOUR_PACKAGE_ID", "time_id": "FROM_RESIDENTIAL_CATALOG", "promo_code": "" } ``` ## Additional usage examples IDs and prices are illustrative; use real values from the catalog and the same quote. JSON IDs and expected_total_minor must be numbers. Examples deliberately keep terms=false; submit terms=true only after explicit customer approval for the real paid operation. ### Residential: new package versus GB top-up · mode=new Neither residential_quote nor residential_purchase requires a purpose selection. A quote uses only mode, time_id, location_id or package_id and optional promo_code. For purchase, add the quoted currency, amount, selection hash and explicit approval. ```json { "mode": "new", "location_id": 20, "time_id": 201, "promo_code": "" } ``` ### Residential: new package versus GB top-up · mode=topup Neither residential_quote nor residential_purchase requires a purpose selection. A quote uses only mode, time_id, location_id or package_id and optional promo_code. For purchase, add the quoted currency, amount, selection hash and explicit approval. ```json { "mode": "topup", "package_id": 10001, "time_id": 201, "promo_code": "" } ``` ## Request example ### curl ```curl printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" | curl --silent --show-error --header @- \ --header 'Accept: application/json' \ --connect-timeout 10 --max-time 30 \ --request POST --header 'Content-Type: application/json' \ --data-binary @request.json \ 'https://www.arnproxy.com/account/api/v1/residential/quote' ``` ### python ```python import os, requests headers = {"Authorization": "Bearer " + os.environ["ARNPROXY_API_KEY"]} import json with open("request.json", encoding="utf-8") as f: payload = json.load(f) response = requests.post( "https://www.arnproxy.com/account/api/v1/residential/quote", headers=headers, json=payload, timeout=(10, 30), allow_redirects=False ) print(response.status_code, response.text) # No automatic write retry. ``` ### javascript ```javascript const headers = { Authorization: `Bearer ${process.env.ARNPROXY_API_KEY}` }; const { readFile } = await import('node:fs/promises'); headers['Content-Type'] = 'application/json'; const body = await readFile('request.json', 'utf8'); const response = await fetch("https://www.arnproxy.com/account/api/v1/residential/quote", { method: 'POST', headers, redirect: 'error', signal: AbortSignal.timeout(30000), body }); console.log(response.status, await response.text()); // A write timeout is ambiguous; query its saved operation. ``` ### php ```php true, CURLOPT_HTTPHEADER => $headers, CURLOPT_FOLLOWLOCATION => false, CURLOPT_SSL_VERIFYPEER => true, CURLOPT_SSL_VERIFYHOST => 2, CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 30, CURLOPT_POST => true, CURLOPT_POSTFIELDS => file_get_contents('request.json'), ]); $result = curl_exec($ch); if ($result === false) { // Do not repeat a write; use the original operation key. throw new RuntimeException('Transport result unknown'); } echo curl_getinfo($ch, CURLINFO_HTTP_CODE).PHP_EOL.$result; curl_close($ch); ``` ### go ```go package main import ( "fmt" "io" "net/http" "os" "time" ) func main() { client := &http.Client{Timeout: 30*time.Second, CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse }} var body io.Reader file, err := os.Open("request.json"); if err != nil { panic(err) } defer file.Close(); body = file req, err := http.NewRequest("POST", "https://www.arnproxy.com/account/api/v1/residential/quote", body) if err != nil { panic(err) } req.Header.Set("Authorization", "Bearer "+os.Getenv("ARNPROXY_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := client.Do(req); if err != nil { panic(err) } defer res.Body.Close() data, err := io.ReadAll(res.Body); if err != nil { panic(err) } fmt.Println(res.StatusCode, string(data)) } ``` ### csharp ```csharp using System; using System.IO; using System.Net.Http; using System.Net.Http.Headers; using System.Text; using var handler = new HttpClientHandler { AllowAutoRedirect = false }; using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) }; using var request = new HttpRequestMessage(HttpMethod.Post, "https://www.arnproxy.com/account/api/v1/residential/quote"); request.Headers.Authorization = new AuthenticationHeaderValue( "Bearer", Environment.GetEnvironmentVariable("ARNPROXY_API_KEY")); request.Content = new StringContent( await File.ReadAllTextAsync("request.json"), Encoding.UTF8, "application/json"); using var response = await client.SendAsync(request); Console.WriteLine((int)response.StatusCode); Console.WriteLine(await response.Content.ReadAsStringAsync()); // Never automatically retry an ambiguous write. ``` ### java ```java import java.net.URI; import java.net.http.*; import java.nio.charset.StandardCharsets; import java.nio.file.*; // Inside your application method: var client = HttpClient.newHttpClient(); var request = HttpRequest.newBuilder(URI.create("https://www.arnproxy.com/account/api/v1/residential/quote")) .header("Authorization", "Bearer " + System.getenv("ARNPROXY_API_KEY")) .header("Accept", "application/json") .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString( Files.readString(Path.of("request.json"), StandardCharsets.UTF_8))) .build(); var response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.statusCode()); ``` ## Responses · HTTP 200 ```json { "ok": true, "data": { "mode": "topup", "product_id": 33, "location_id": 20, "time_id": 201, "gb": 1, "days": 30, "package_id": 20001, "currency": "TRY", "base_total": "15.00", "quantity_discount_rate": 0, "subtotal": "15.00", "promotion": { "code": "", "rate": 0, "amount": "0.00" }, "total": "15.00", "total_minor": 1500, "last_service_date": "2030-02-01", "automatic_renewal": false, "stock_checked": false, "provider_checked": false, "selection_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "meta": { "request_id": "000000000000000000000001", "phase": "public_v1", "source": "arnproxy_records" } } ``` | Name | Type | Conditional | Description | |---|---|---|---| | `ok` | boolean | — | Success envelope flag; on false inspect error.code. | | `data` | object | — | Operation-specific result; examples are illustrative and synthetic. | | `data.mode` | string | — | Operation-specific mode value; preserve its demonstrated type and consult the behavior notes. | | `data.product_id` | integer | — | Local catalog location or product-type ID. | | `data.location_id` | integer | — | Local catalog location or product-type ID. | | `data.time_id` | integer | — | Local period/GB-plan record ID, not a day or GB count. | | `data.gb` | integer | — | Traffic amount; list/settings operations do not purchase traffic. | | `data.days` | integer | — | Plan duration in days, separate from a GB plan’s traffic amount. | | `data.package_id` | integer | — | Relevant ARNPROXY record ID; use it instead of the upstream internal ID. | | `data.currency` | string | — | Account transaction currency: TRY or USD. | | `data.base_total` | string | — | Money amount; preserve the returned string/integer representation for precision. | | `data.quantity_discount_rate` | integer | — | Operation-specific quantity discount rate value; preserve its demonstrated type and consult the behavior notes. | | `data.subtotal` | string | — | Money amount; preserve the returned string/integer representation for precision. | | `data.promotion` | object | — | Operation-specific promotion value; preserve its demonstrated type and consult the behavior notes. | | `data.promotion.code` | string | — | Operation-specific code value; preserve its demonstrated type and consult the behavior notes. | | `data.promotion.rate` | integer | — | Operation-specific rate value; preserve its demonstrated type and consult the behavior notes. | | `data.promotion.amount` | string | — | Money amount; preserve the returned string/integer representation for precision. | | `data.total` | string | — | Money amount; preserve the returned string/integer representation for precision. | | `data.total_minor` | integer | — | Integer minor units: 1000 means 10.00 TRY/USD. | | `data.last_service_date` | string | — | Last service day: current, previous or projected by the quote. A projection does not renew. | | `data.automatic_renewal` | boolean | — | Operation-specific automatic renewal value; preserve its demonstrated type and consult the behavior notes. | | `data.stock_checked` | boolean | — | A price/local result is not by itself a provider or stock guarantee. | | `data.provider_checked` | boolean | — | A price/local result is not by itself a provider or stock guarantee. | | `data.selection_hash` | string | — | Freshness fingerprint to copy unchanged to the corresponding write/price confirmation. | | `meta` | object | — | Request correlation and data-source metadata. | | `meta.request_id` | string | — | This HTTP request’s correlation ID, not an operation key or order ID. | | `meta.phase` | string | — | Operation-specific phase value; preserve its demonstrated type and consult the behavior notes. | | `meta.source` | string | — | Data source; local records and a live provider lookup are different evidence. | ## Behavior & important notes - Package and list IDs are ARNPROXY record IDs, not upstream package keys or list IDs. A stale package snapshot cannot grant access; refresh it with residential_package_refresh when needed. - mode=new creates a package; mode=topup adds GB to an existing one. Use residential_catalog/quote first. Balance acceptance and background delivery are separate; follow the same operation key. - Neither residential_quote nor residential_purchase requires a purpose selection. A quote uses only mode, time_id, location_id or package_id and optional promo_code. For purchase, add the quoted currency, amount, selection hash and explicit approval. Authentication and validation may reject a request before execution. Consult the error reference and retain request_id when contacting support. Never send keys or passwords. [Errors & limits](https://docs.arnproxy.com/api-v1/errors)