GET /apiv2/billing/limits

آپ کے پوسٹ پیڈ اکاؤنٹ پر موجود ہر حد — Netts کی جانب سے مقرر کردہ کریڈٹ کی حد اور آپ کی اپنی حدود — بشمول اس کے کہ ان میں سے کتنی استعمال ہو چکی ہے اور کتنی باقی ہے، اور ہر پروڈکٹ پر اب بھی کتنا خرچ کیا جا سکتا ہے۔ پوسٹ پیڈ بلنگ کا حصہ۔

اینڈ پوائنٹ URL

GET https://netts.io/apiv2/billing/limits

درخواست کے ہیڈرز

ہیڈر	لازمی	تفصیل
X-API-KEY	ہاں	billing.read اجازت نامے کے ساتھ API کلید
X-Real-IP	ہاں	کلید کی وائٹ لسٹ سے ایک پتہ

درخواست کا کوئی پیرامیٹر نہیں ہے۔

مثال

curl -s 'https://netts.io/apiv2/billing/limits' \
  -H 'X-API-KEY: your-api-key' \
  -H 'X-Real-IP: 203.0.113.10'

{
  "success": true,
  "data": {
    "limits": [
      {
        "id": 1,
        "scope": "account",
        "origin": "netts",
        "editable": false,
        "canDisable": false,
        "period": "outstanding",
        "productCode": null,
        "apiKeyId": null,
        "enabled": true,
        "revision": 3,
        "limit": { "unit": "USD", "value": "30000.000000" },
        "equivalent": { "unit": "TRX", "value": "90677.230000" },
        "used": { "unit": "USD", "value": "1250.400000" },
        "available": { "unit": "USD", "value": "28749.600000" },
        "creditApplied": { "unit": "USD", "value": "0" },
        "status": "ok",
        "periodStart": null,
        "periodEnd": null,
        "cappedBy": null
      },
      {
        "id": 5,
        "scope": "account",
        "origin": "client",
        "editable": true,
        "canDisable": true,
        "period": "day",
        "productCode": "energy_5m",
        "apiKeyId": null,
        "enabled": true,
        "revision": 1,
        "limit": { "unit": "USD", "value": "200.000000" },
        "equivalent": { "unit": "TRX", "value": "604.514867" },
        "used": { "unit": "USD", "value": "35.200000" },
        "available": { "unit": "USD", "value": "164.800000" },
        "creditApplied": null,
        "status": "ok",
        "periodStart": "2026-10-19T00:00:00+00:00",
        "periodEnd": "2026-10-20T00:00:00+00:00",
        "cappedBy": null
      }
    ],
    "products": {
      "energy_1h": { "unit": "USD", "spendable": "28749.600000", "limitingLimitIds": [1], "maxPerOrder": null, "status": "ok" },
      "energy_5m": { "unit": "USD", "spendable": "164.800000", "limitingLimitIds": [5], "maxPerOrder": null, "status": "ok" }
    },
    "unit": "USD",
    "asOf": "2026-10-19T20:24:26.525887+00:00",
    "checkedApiKeyId": 6,
    "valuationStatus": "ok",
    "creditUsdc": "0",
    "fx": { "usdPerTrx": "0.33084276", "at": "2026-10-19T20:24:23.449930+00:00" },
    "fxStatus": "ok"
  },
  "timestamp": "2026-10-19T20:24:26+00:00"
}

ایک حد

فیلڈ	تفصیل
id	حد کا نمبر — اپنی حد کو تبدیل کرنے، بند یا آن کرنے کے لیے اسے استعمال کریں
scope	account — پورے اکاؤنٹ پر لاگو ہوتا ہے؛ key — ایک API کلید پر لاگو ہوتا ہے (apiKeyId)
origin	netts — Netts کی جانب سے مقرر کردہ، صرف پڑھنے کے لیے؛ client — آپ کی اپنی حد
editable, canDisable	آیا آپ اس حد کو تبدیل یا بند کر سکتے ہیں
period	outstanding، day، week یا order — دیکھیں کیا شمار کیا جاتا ہے
productCode	وہ پروڈکٹ جس پر یہ حد لاگو ہوتی ہے، مجموعی حد کے لیے null
enabled	false — حد بند ہے اور لاگو نہیں ہوتی
revision	موجودہ ورژن؛ جب آپ حد تبدیل کریں تو اسے expectedRevision کے طور پر بھیجیں
limit, equivalent	حد اور، حوالہ کے لیے، موجودہ شرح پر دوسری کرنسی میں اس کی قدر
used, available	کتنا استعمال ہو چکا ہے اور کتنا باقی ہے؛ بند شدہ حد اور order حدود کے لیے null
creditApplied	outstanding حد میں شمار ہونے والی زائد ادائیگیوں سے حاصل کردہ کریڈٹ
maxPerOrder	order حد کے لیے: سب سے بڑا انفرادی آرڈر
periodStart, periodEnd	day اور week کے لیے: موجودہ UTC مدت
cappedBy	Netts کی جانب سے حد کم کرنے کے بعد آپ کی حد Netts کی حد سے زیادہ ہے: Netts حد کی id جو اس کے بجائے لاگو ہوتی ہے
status	ok, limit_reached, disabled, other_key (آپ کی دوسری کلیدوں میں سے کسی کی حد)، یا unavailable

پروڈکٹس

products ہر پروڈکٹ کے لیے دکھاتا ہے کہ اس پروڈکٹ کا اگلا آرڈر کتنا استعمال کر سکتا ہے: لاگو ہونے والی تمام حدود میں سب سے کم باقی رقم spendable ہے، اور limitingLimitIds ان حدود کے نام بتاتا ہے جو اسے مقرر کرتی ہیں۔ اگر order کی کوئی حد لاگو ہوتی ہے تو maxPerOrder سب سے بڑا انفرادی آرڈر ہے۔

کلید کی حدود اس کلید کے لیے شمار کی جاتی ہیں جس نے یہ درخواست بھیجی تھی — checkedApiKeyId۔ اگر اس وقت اعداد و شمار کا حساب نہیں لگایا جا سکتا تو valuationStatus کی قیمت unavailable ہوگی: حدود بدستور درج ہوتی ہیں، used، available اور spendable کی قیمت null ہوتی ہے۔ اس صورت میں وہ کبھی بھی صفر یا لامحدود ظاہر نہیں کی جاتیں۔

خرابی کے جوابات

HTTP	code	مطلب
401	-1, -2	کلید موجود نہیں ہے یا غلط ہے، یا IP وائٹ لسٹ میں شامل نہیں ہے — API گیٹ وے کی طرف سے جواب دیا گیا، دیکھیں جواب کی ساخت
403	billing_read_required	کلید کے پاس billing.read کی اجازت نہیں ہے
403	postpaid_required	اکاؤنٹ میں پوسٹ پیڈ بلنگ موجود نہیں ہے

تمام کوڈز پوسٹ پیڈ بلنگ میں درج ہیں۔