GET /apiv2/billing/limits

วงเงินทุกรายการในบัญชีแบบชำระเงินภายหลัง (postpaid) ของคุณ — ทั้งวงเงินสินเชื่อที่ Netts กำหนดและวงเงินที่คุณกำหนดขึ้นเอง — พร้อมระบุจำนวนที่ใช้ไปแล้วและจำนวนที่เหลือของแต่ละรายการ รวมถึงจำนวนเงินที่แต่ละผลิตภัณฑ์ยังสามารถใช้จ่ายได้ เป็นส่วนหนึ่งของ การเรียกเก็บเงินแบบชำระเงินภายหลัง

URL ของ Endpoint

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

Headers ของคำขอ

Header	จำเป็น	คำอธิบาย
`X-API-KEY`	ใช่	API key ที่มีสิทธิ์ `billing.read`
`X-Real-IP`	ใช่	ที่อยู่ IP ที่อยู่ในไวท์ลิสต์ของคีย์

คำขอนี้ไม่มีพารามิเตอร์

ตัวอย่าง

bash

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

json

{
  "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 key รายการเดียว (`apiKeyId`)
`origin`	`netts` — กำหนดโดย Netts, อ่านได้อย่างเดียว; `client` — วงเงินที่คุณกำหนดเอง
`editable`, `canDisable`	ระบุว่าคุณสามารถแก้ไขหรือปิดใช้งานวงเงินนี้ได้หรือไม่
`period`	`outstanding`, `day`, `week` หรือ `order` — ดูที่ สิ่งที่นำมานับคำนวณ
`productCode`	ผลิตภัณฑ์ที่วงเงินนี้มีผลบังคับใช้, `null` สำหรับวงเงินภาพรวม
`enabled`	`false` — วงเงินถูกปิดใช้งานและไม่มีผลบังคับใช้
`revision`	เวอร์ชันปัจจุบัน; ส่งค่านี้เป็น `expectedRevision` เมื่อคุณทำการแก้ไขวงเงิน
`limit`, `equivalent`	วงเงิน และมูลค่าในอีกสกุลเงินหนึ่งตามอัตราแลกเปลี่ยนปัจจุบันเพื่อใช้อ้างอิง
`used`, `available`	จำนวนที่ใช้ไปแล้วและจำนวนที่เหลือ; เป็น `null` สำหรับวงเงินที่ปิดใช้งานและวงเงินประเภท `order`
`creditApplied`	เครดิตจากการชำระเงินเกินที่นำมานับคำนวณในวงเงินแบบ `outstanding`
`maxPerOrder`	สำหรับวงเงินประเภท `order`: มูลค่าคำสั่งซื้อเดี่ยวสูงสุด
`periodStart`, `periodEnd`	สำหรับ `day` และ `week`: รอบเวลา UTC ปัจจุบัน
`cappedBy`	กรณีที่วงเงินของคุณสูงกว่าวงเงินของ Netts หลังจากที่ Netts ปรับลดลง: จะแสดง `id` วงเงินของ Netts ที่มีผลบังคับใช้แทน
`status`	`ok`, `limit_reached`, `disabled`, `other_key` (วงเงินของคีย์อื่นของคุณ) หรือ `unavailable`

ผลิตภัณฑ์

products จะแสดงจำนวนเงินที่ คำสั่งซื้อถัดไป ของแต่ละผลิตภัณฑ์สามารถใช้ได้: spendable คือจำนวนเงินที่เหลือน้อยที่สุดในบรรดาวงเงินทั้งหมดที่มีผลบังคับใช้ และ limitingLimitIds จะระบุรายการวงเงินที่เป็นตัวกำหนดค่านั้น maxPerOrder คือมูลค่าคำสั่งซื้อเดี่ยวสูงสุดหากมีวงเงินประเภท order บังคับใช้อยู่

วงเงินระดับคีย์จะถูกนับคำนวณสำหรับคีย์ที่ส่งคำขอนี้ — checkedApiKeyId หากไม่สามารถคำนวณตัวเลขได้ในขณะนั้น valuationStatus จะเป็น unavailable: โดยวงเงินจะยังคงแสดงรายการอยู่ แต่ used, available และ spendable จะมีค่าเป็น null ซึ่งในกรณีดังกล่าวจะไม่มีการแสดงผลเป็นศูนย์หรือไม่จำกัดโดยเด็ดขาด

ข้อผิดพลาด

HTTP	`code`	ความหมาย
401	`-1`, `-2`	คีย์ขาดหายไปหรือไม่ถูกต้อง หรือ IP ไม่ได้อยู่ในไวท์ลิสต์ — ตอบกลับโดย API gateway ดูที่ รูปแบบการตอบกลับ
403	`billing_read_required`	คีย์ไม่มีสิทธิ์ `billing.read`
403	`postpaid_required`	บัญชีไม่ได้เปิดใช้งานการเรียกเก็บเงินแบบชำระเงินภายหลัง

รหัสทั้งหมดมีระบุไว้ใน การเรียกเก็บเงินแบบชำระเงินภายหลัง

GET /apiv2/billing/limits ​

URL ของ Endpoint ​

Headers ของคำขอ ​

ตัวอย่าง ​

วงเงินหนึ่งรายการ ​

ผลิตภัณฑ์ ​

ข้อผิดพลาด ​