GET /apiv2/billing/limits

Mọi hạn mức trên tài khoản trả sau của bạn — hạn mức tín dụng do Netts thiết lập và các hạn mức của riêng bạn — cùng với mức độ đã sử dụng và còn lại của từng hạn mức, cũng như số tiền mỗi sản phẩm vẫn có thể chi tiêu. Một phần của thanh toán trả sau.

URL của Endpoint

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

Headers của yêu cầu

Header	Bắt buộc	Mô tả
`X-API-KEY`	có	Khóa API có quyền `billing.read`
`X-Real-IP`	có	Một địa chỉ từ danh sách trắng (whitelist) của khóa

Yêu cầu không có tham số nào.

Ví dụ

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"
}

Một hạn mức

Trường	Mô tả
`id`	số định danh hạn mức — sử dụng nó để thay đổi, tắt hoặc bật hạn mức của riêng bạn
`scope`	`account` — áp dụng cho toàn bộ tài khoản; `key` — áp dụng cho một khóa API (`apiKeyId`)
`origin`	`netts` — do Netts thiết lập, chỉ đọc; `client` — hạn mức của riêng bạn
`editable`, `canDisable`	liệu bạn có thể thay đổi hoặc tắt hạn mức này hay không
`period`	`outstanding`, `day`, `week` hoặc `order` — xem những gì được tính
`productCode`	sản phẩm mà hạn mức áp dụng, `null` cho hạn mức tổng thể
`enabled`	`false` — hạn mức đã bị tắt và không áp dụng
`revision`	phiên bản hiện tại; gửi giá trị này dưới dạng `expectedRevision` khi bạn thay đổi hạn mức
`limit`, `equivalent`	hạn mức và giá trị tương đương của nó trong đơn vị tiền tệ khác theo tỷ giá hiện tại để tham khảo
`used`, `available`	số lượng đã sử dụng và còn lại; `null` đối với hạn mức đã bị tắt và hạn mức `order`
`creditApplied`	tín dụng từ các khoản thanh toán dư được tính vào hạn mức `outstanding`
`maxPerOrder`	đối với hạn mức `order`: đơn hàng đơn lẻ lớn nhất
`periodStart`, `periodEnd`	đối với `day` và `week`: khoảng thời gian UTC hiện tại
`cappedBy`	hạn mức của bạn cao hơn hạn mức của Netts sau khi Netts giảm xuống: `id` của hạn mức Netts được áp dụng thay thế
`status`	`ok`, `limit_reached`, `disabled`, `other_key` (hạn mức của một khóa khác của bạn), hoặc `unavailable`

Sản phẩm

products hiển thị số tiền mà đơn hàng tiếp theo của sản phẩm đó có thể sử dụng cho từng sản phẩm: spendable là số lượng còn lại nhỏ nhất trong số tất cả các hạn mức được áp dụng, và limitingLimitIds chỉ rõ các hạn mức thiết lập mức đó. maxPerOrder là đơn hàng đơn lẻ lớn nhất nếu áp dụng hạn mức order.

Các hạn mức của khóa được tính cho khóa đã thực hiện yêu cầu này — checkedApiKeyId. Nếu hiện tại không thể tính toán được các con số, valuationStatus sẽ là unavailable: các hạn mức vẫn được liệt kê, used, available và spendable sẽ là null. Trong trường hợp đó, chúng không bao giờ được hiển thị là bằng không hoặc không giới hạn.

Lỗi

HTTP	`code`	Ý nghĩa
401	`-1`, `-2`	khóa bị thiếu hoặc không hợp lệ, hoặc IP không nằm trong danh sách trắng — được phản hồi bởi cổng API gateway, xem định dạng phản hồi
403	`billing_read_required`	khóa không có quyền `billing.read`
403	`postpaid_required`	tài khoản chưa bật thanh toán trả sau

Tất cả các mã lỗi đều được liệt kê trong thanh toán trả sau.

GET /apiv2/billing/limits ​

URL của Endpoint ​

Headers của yêu cầu ​

Ví dụ ​

Một hạn mức ​

Sản phẩm ​

Lỗi ​