Gói & sử dụng
goi & su dungGói dịch vụ, đo lường giao dịch, thanh quota, trần chi tiêu, hoá đơn và nạp credit dịch vụ. goi dich vu, do luong giao dich, thanh quota, tran chi tieu, hoa don va nap credit dich vu.Gói dịch vụ, đo lường giao dịch, thanh quota, trần chi tiêu, hoá đơn và nạp credit dịch vụ.
Endpoint
Phần tiêu đề “Endpoint”| Method | Path | Tóm tắt | Quyền | Nhóm tốc độ | Tương tác |
|---|---|---|---|---|---|
GET | /v1/billing/credit | Số dư credit dịch vụ và lịch sử biến động | billing.read | read | Scalar |
POST | /v1/billing/credit:topup-qr | Tạo mã VietQR nạp credit dịch vụ | billing.write | write | Scalar |
GET | /v1/billing/info | Thông tin xuất hoá đơn tài chính | billing.read | read | Scalar |
PUT | /v1/billing/info | Cập nhật thông tin xuất hoá đơn tài chính | billing.write | write | Scalar |
GET | /v1/billing/invoices | Danh sách hoá đơn gói dịch vụ | billing.read | read | Scalar |
POST | /v1/billing/invoices/{id}:pay-qr | Tạo mã VietQR thanh toán hoá đơn gói | billing.write | write | Scalar |
GET | /v1/billing/meter | Thanh đo hạn mức sử dụng kỳ hiện tại | billing.read | read | Scalar |
GET | /v1/billing/plan | Thông tin gói cước và hạn mức hiện tại | billing.read | read | Scalar |
GET | /v1/billing/spend-cap | Xem trần chi tiêu tự đặt | billing.read | read | Scalar |
PUT | /v1/billing/spend-cap | Cập nhật trần chi tiêu tự đặt | billing.write | write | Scalar |
GET | /v1/billing/usage | Chi tiết số lượng giao dịch sử dụng | billing.read | read | Scalar |
GET | /v1/public/plans | Bảng giá và tính năng các gói công khai | Công khai, không cần khoá | read | Scalar |
Chi tiết endpoint
Phần tiêu đề “Chi tiết endpoint”GET /v1/billing/credit
Phần tiêu đề “GET /v1/billing/credit”Số dư credit dịch vụ và lịch sử biến động
Tra cứu số dư credit dịch vụ hiện tại và sổ cái biến động (nạp tiền, trừ hoá đơn, hoàn trả).
Quyền: billing.read Scope: billing:read- Nhóm tốc độ:
read - Phản hồi thành công
200: Số dư credit dịch vụ. —ServiceCreditBalanceResponse,application/json - Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/billing/credit" \ -H "Authorization: Bearer $DT_API_KEY"import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.GET("/v1/billing/credit");import os
from dongtien import DongTienfrom dongtien_api.api.goi_su_dung import get_billing_credit
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = get_billing_credit.sync(client=dt.client)POST /v1/billing/credit:topup-qr
Phần tiêu đề “POST /v1/billing/credit:topup-qr”Tạo mã VietQR nạp credit dịch vụ
Tạo mã VietQR nạp trước credit dịch vụ để tự động trừ vào các kỳ hoá đơn tiếp theo. Lưu ý: credit không phải ví tiền, không thể rút.
Quyền: billing.write- Nhóm tốc độ:
write - Nội dung yêu cầu:
TopupQrRequest(application/json) - Phản hồi thành công
200: Thông tin mã VietQR nạp credit. —TopupQrResponse,application/json - Mã lỗi riêng của endpoint:
conflict
curl -sS -X POST "https://api.dongtien.pro/v1/billing/credit:topup-qr" \ -H "Authorization: Bearer $DT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "amount_vnd": 4500000}'import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.POST("/v1/billing/credit:topup-qr", { body: { "amount_vnd": 4500000 },});import os
from dongtien import DongTienfrom dongtien_api.api.goi_su_dung import topup_credit_qrfrom dongtien_api.models import TopupQrRequest
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = topup_credit_qr.sync( client=dt.client, body=TopupQrRequest.from_dict({ "amount_vnd": 4500000, }), )GET /v1/billing/info
Phần tiêu đề “GET /v1/billing/info”Thông tin xuất hoá đơn tài chính
Thông tin doanh nghiệp (MST, tên công ty, địa chỉ, email nhận hoá đơn GTGT) để xuất hoá đơn điện tử.
Quyền: billing.read Scope: billing:read- Nhóm tốc độ:
read - Phản hồi thành công
200: Thông tin hoá đơn tài chính. —BillingInfo,application/json - Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/billing/info" \ -H "Authorization: Bearer $DT_API_KEY"import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.GET("/v1/billing/info");import os
from dongtien import DongTienfrom dongtien_api.api.goi_su_dung import get_billing_info
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = get_billing_info.sync(client=dt.client)PUT /v1/billing/info
Phần tiêu đề “PUT /v1/billing/info”Cập nhật thông tin xuất hoá đơn tài chính
Cập nhật mã số thuế, tên công ty và email để nhận hoá đơn điện tử GTGT hợp lệ.
Quyền: billing.write- Nhóm tốc độ:
write - Nội dung yêu cầu:
UpdateBillingInfo(application/json) - Phản hồi thành công
200: Thông tin hoá đơn tài chính đã cập nhật. —BillingInfo,application/json - Mã lỗi riêng của endpoint:
conflict
curl -sS -X PUT "https://api.dongtien.pro/v1/billing/info" \ -H "Authorization: Bearer $DT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "tax_id": "0312345678", "company_name": "Công ty TNHH Thương mại Sao Việt", "invoice_address": "25 Nguyễn Huệ, Phường Bến Nghé, Quận 1, TP. Hồ Chí Minh", "invoice_email": "ketoan@saoviet.vn", "contact_name": "Nguyễn Thị Lan", "contact_email": "lan.nguyen@saoviet.vn"}'import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.PUT("/v1/billing/info", { body: { "tax_id": "0312345678", "company_name": "Công ty TNHH Thương mại Sao Việt", "invoice_address": "25 Nguyễn Huệ, Phường Bến Nghé, Quận 1, TP. Hồ Chí Minh", "invoice_email": "ketoan@saoviet.vn", "contact_name": "Nguyễn Thị Lan", "contact_email": "lan.nguyen@saoviet.vn" },});import os
from dongtien import DongTienfrom dongtien_api.api.goi_su_dung import update_billing_infofrom dongtien_api.models import UpdateBillingInfo
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = update_billing_info.sync( client=dt.client, body=UpdateBillingInfo.from_dict({ "tax_id": "0312345678", "company_name": "Công ty TNHH Thương mại Sao Việt", "invoice_address": "25 Nguyễn Huệ, Phường Bến Nghé, Quận 1, TP. Hồ Chí Minh", "invoice_email": "ketoan@saoviet.vn", "contact_name": "Nguyễn Thị Lan", "contact_email": "lan.nguyen@saoviet.vn", }), )GET /v1/billing/invoices
Phần tiêu đề “GET /v1/billing/invoices”Danh sách hoá đơn gói dịch vụ
Danh sách hoá đơn hàng tháng của tổ chức (mã DTP-INV-YYMM), trạng thái thanh toán và mã nội dung.
Quyền: billing.read Scope: billing:read- Nhóm tốc độ:
read - Phản hồi thành công
200: Danh sách hoá đơn. —BillingInvoiceList,application/json - Mã lỗi riêng của endpoint:
invalid_cursor
Tham số
Phần tiêu đề “Tham số”| Tên | Vị trí | Bắt buộc | Kiểu | Mô tả |
|---|---|---|---|---|
limit | query | Không | integer | Số phần tử mỗi trang (1–100, mặc định 20). |
cursor | query | Không | Cursor | Con trỏ phân trang mờ (cur_…) lấy từ next_cursor; không tự tạo hay sửa. |
state | query | Không | string | Lọc theo trạng thái hoá đơn. |
curl -sS -X GET "https://api.dongtien.pro/v1/billing/invoices" \ -H "Authorization: Bearer $DT_API_KEY"import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.GET("/v1/billing/invoices");import os
from dongtien import DongTienfrom dongtien_api.api.goi_su_dung import list_billing_invoices
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = list_billing_invoices.sync(client=dt.client)POST /v1/billing/invoices/{id}:pay-qr
Phần tiêu đề “POST /v1/billing/invoices/{id}:pay-qr”Tạo mã VietQR thanh toán hoá đơn gói
Tạo mã chuyển khoản VietQR chuẩn EMVCo có gắn mã nội dung DTP… độc nhất. Hiệu lực 15 phút, tự gạch nợ sau khi tiền về.
Quyền: billing.write- Nhóm tốc độ:
write - Phản hồi thành công
200: Thông tin mã VietQR thanh toán hoá đơn. —PayQrResponse,application/json - Mã lỗi riêng của endpoint:
resource_not_found,conflict
Tham số
Phần tiêu đề “Tham số”| Tên | Vị trí | Bắt buộc | Kiểu | Mô tả |
|---|---|---|---|---|
id | path | Có | BillingInvoiceId | Mã hoá đơn thanh toán (bin_…). |
curl -sS -X POST "https://api.dongtien.pro/v1/billing/invoices/$ID:pay-qr" \ -H "Authorization: Bearer $DT_API_KEY"import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.POST("/v1/billing/invoices/{id}:pay-qr", { params: { path: { "id": "bin_0f5k2m9q4h7t3n8r6v1w0x5yz0" }, },});import os
from dongtien import DongTienfrom dongtien_api.api.goi_su_dung import pay_invoice_qr
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = pay_invoice_qr.sync(id="bin_0f5k2m9q4h7t3n8r6v1w0x5yz0", client=dt.client)GET /v1/billing/meter
Phần tiêu đề “GET /v1/billing/meter”Thanh đo hạn mức sử dụng kỳ hiện tại
Đo lường số giao dịch đã xác thực trong tháng theo giờ VN, hạn mức miễn phí, dự kiến cuối tháng và trần chi tiêu.
Quyền: billing.read Scope: billing:read- Nhóm tốc độ:
read - Phản hồi thành công
200: Thông số đo lường hiện tại. —BillingMeter,application/json - Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/billing/meter" \ -H "Authorization: Bearer $DT_API_KEY"import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.GET("/v1/billing/meter");import os
from dongtien import DongTienfrom dongtien_api.api.goi_su_dung import get_billing_meter
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = get_billing_meter.sync(client=dt.client)GET /v1/billing/plan
Phần tiêu đề “GET /v1/billing/plan”Thông tin gói cước và hạn mức hiện tại
Chi tiết gói cước đang áp dụng, bảng giá bậc luỹ tiến và các quyền hạn mức.
Quyền: billing.read Scope: billing:read- Nhóm tốc độ:
read - Phản hồi thành công
200: Thông tin gói cước. —CurrentPlanResponse,application/json - Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/billing/plan" \ -H "Authorization: Bearer $DT_API_KEY"import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.GET("/v1/billing/plan");import os
from dongtien import DongTienfrom dongtien_api.api.goi_su_dung import get_billing_plan
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = get_billing_plan.sync(client=dt.client)GET /v1/billing/spend-cap
Phần tiêu đề “GET /v1/billing/spend-cap”Xem trần chi tiêu tự đặt
Hạn mức trần do khách tự đặt để tự bảo vệ chi phí, tránh vượt dự toán ngoài ý muốn.
Quyền: billing.read Scope: billing:read- Nhóm tốc độ:
read - Phản hồi thành công
200: Hạn mức trần chi tiêu hiện tại. —SpendCap,application/json - Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/billing/spend-cap" \ -H "Authorization: Bearer $DT_API_KEY"import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.GET("/v1/billing/spend-cap");import os
from dongtien import DongTienfrom dongtien_api.api.goi_su_dung import get_billing_spend_cap
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = get_billing_spend_cap.sync(client=dt.client)PUT /v1/billing/spend-cap
Phần tiêu đề “PUT /v1/billing/spend-cap”Cập nhật trần chi tiêu tự đặt
Cập nhật mức trần chi tiêu. Chạm trần không chặn nhận giao dịch và webhook, chỉ tạm dừng AI nền tảng và lệnh xuất mới.
Quyền: billing.write- Nhóm tốc độ:
write - Nội dung yêu cầu:
UpdateSpendCap(application/json) - Phản hồi thành công
200: Trần chi tiêu đã lưu. —SpendCap,application/json - Mã lỗi riêng của endpoint:
conflict
curl -sS -X PUT "https://api.dongtien.pro/v1/billing/spend-cap" \ -H "Authorization: Bearer $DT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "spend_cap_vnd": 4500000}'import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.PUT("/v1/billing/spend-cap", { body: { "spend_cap_vnd": 4500000 },});import os
from dongtien import DongTienfrom dongtien_api.api.goi_su_dung import update_billing_spend_capfrom dongtien_api.models import UpdateSpendCap
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = update_billing_spend_cap.sync( client=dt.client, body=UpdateSpendCap.from_dict({ "spend_cap_vnd": 4500000, }), )GET /v1/billing/usage
Phần tiêu đề “GET /v1/billing/usage”Chi tiết số lượng giao dịch sử dụng
Phân bổ số giao dịch đã xác thực theo ngày, kênh nguồn hoặc theo từng công ty.
Quyền: billing.read Scope: billing:read- Nhóm tốc độ:
read - Phản hồi thành công
200: Thống kê chi tiết lượng giao dịch. —UsageBreakdownResponse,application/json - Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
Tham số
Phần tiêu đề “Tham số”| Tên | Vị trí | Bắt buộc | Kiểu | Mô tả |
|---|---|---|---|---|
from | query | Không | string | Từ ngày YYYY-MM-DD. |
to | query | Không | string | Đến ngày YYYY-MM-DD. |
group_by | query | Không | string | Nhóm theo ngày, nguồn dữ liệu hoặc công ty thành viên. |
curl -sS -X GET "https://api.dongtien.pro/v1/billing/usage" \ -H "Authorization: Bearer $DT_API_KEY"import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.GET("/v1/billing/usage");import os
from dongtien import DongTienfrom dongtien_api.api.goi_su_dung import get_billing_usage
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = get_billing_usage.sync(client=dt.client)GET /v1/public/plans
Phần tiêu đề “GET /v1/public/plans”Bảng giá và tính năng các gói công khai
Danh sách các gói dịch vụ, hạn mức quota miễn phí, đơn giá luỹ tiến theo giao dịch và các quyền hạn mức công khai. Không yêu cầu đăng nhập, cache 5 phút.
Quyền: Công khai, không cần khoá- Nhóm tốc độ:
read - Phản hồi thành công
200: Bảng giá công khai các gói cước. —PublicPlansResponse,application/json - Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
curl -sS -X GET "https://api.dongtien.pro/v1/public/plans"import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.GET("/v1/public/plans");import os
from dongtien import DongTienfrom dongtien_api.api.goi_su_dung import get_public_plans
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = get_public_plans.sync(client=dt.client)Đối tượng
Phần tiêu đề “Đối tượng”ServiceCreditBalanceResponse
Phần tiêu đề “ServiceCreditBalanceResponse”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
balance_vnd | integer | Có | Số dư credit dịch vụ hiện có (không phải ví tiền, không rút được). |
entries | ServiceCreditEntry[] | Có | — |
entries[].amount_vnd | integer | Có | Biến động VND (dương = cộng, âm = trừ). |
entries[].balance_after_vnd | integer | Có | Số dư sau biến động (luôn >= 0). |
entries[].created_at | Timestamp | Có | — |
entries[].description | string | Có | — |
entries[].id | string | Có | Mã dòng sổ cái credit. |
entries[].kind | string | Có | Giá trị: topup, invoice_deduct, overpay_credit, adjustment_credit, adjustment_debit, refund. |
entries[].reference_id | string | null | Có | Mã tham chiếu (hoá đơn, topup, v.v.). |
TopupQrRequest
Phần tiêu đề “TopupQrRequest”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
amount_vnd | integer | Có | Số tiền nạp (tối thiểu 50.000 ₫). |
TopupQrResponse
Phần tiêu đề “TopupQrResponse”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
amount_vnd | PositiveVnd | Có | — |
bank_account | BankAccountRecipient | Có | — |
bank_account.account_name | string | Có | Tên chủ tài khoản. |
bank_account.account_no | string | Có | Số tài khoản nhận tiền. |
bank_account.bank_name | string | Có | Tên ngân hàng ngắn gọn. |
bank_account.bin | string | Có | Mã BIN ngân hàng thụ hưởng (VietQR). |
expires_at | Timestamp | Có | — |
memo_code | string | Có | Mã nội dung DTP… |
qr_payload | string | Có | — |
topup_id | string | Có | Mã giao dịch nạp credit. |
BillingInfo
Phần tiêu đề “BillingInfo”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
company_name | string | null | Có | Tên doanh nghiệp trên hoá đơn GTGT. |
contact_email | string (email) | null | Có | — |
contact_name | string | null | Có | — |
invoice_address | string | null | Có | Địa chỉ nhận hoá đơn GTGT. |
invoice_email | string (email) | null | Có | Email nhận hoá đơn GTGT điện tử. |
tax_id | string | null | Có | Mã số thuế doanh nghiệp. |
UpdateBillingInfo
Phần tiêu đề “UpdateBillingInfo”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
company_name | string | null | Không | Tên doanh nghiệp trên hoá đơn GTGT. |
contact_email | string (email) | null | Không | — |
contact_name | string | null | Không | — |
invoice_address | string | null | Không | Địa chỉ nhận hoá đơn GTGT. |
invoice_email | string (email) | null | Không | Email nhận hoá đơn GTGT điện tử. |
tax_id | string | null | Không | Mã số thuế doanh nghiệp. |
BillingInvoiceList
Phần tiêu đề “BillingInvoiceList”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
data | BillingInvoice[] | Có | — |
data[].billed_count | integer | Có | Số giao dịch tính phí ngoài quota. |
data[].code | string | Có | Mã hoá đơn hiển thị, ví dụ DTP-INV-2610. |
data[].created_at | Timestamp | Có | — |
data[].credit_deducted_vnd | integer | Có | Credit dịch vụ đã tự động trừ. |
data[].due_at | Timestamp | null | Có | — |
data[].id | BillingInvoiceId | Có | — |
data[].memo_code | string | null | Có | Mã nội dung DTP… gắn với hoá đơn này. |
data[].paid_at | Timestamp | null | Có | — |
data[].period | string | Có | — |
data[].received_vnd | integer | Có | Số tiền đã nhận qua VietQR. |
data[].state | string | Có | Giá trị: accruing, open, paid, overdue, void, free_tier. |
data[].subtotal_vnd | integer | Có | Tiền trước thuế: giá theo bậc (đã gồm VAT) trừ phần VAT tách ra. |
data[].total_vnd | integer | Có | Tổng tiền còn phải thanh toán sau khi trừ credit: subtotal_vnd + vat_vnd - credit_deducted_vnd. |
data[].tx_count | integer | Có | Tổng giao dịch trong kỳ. |
data[].updated_at | Timestamp | Có | — |
data[].vat_invoice_ref | string | null | Có | Số hoá đơn GTGT điện tử (hoadon.pro). |
data[].vat_issued_at | Timestamp | null | Có | — |
data[].vat_percent | integer | Có | Tỷ lệ VAT (%). |
data[].vat_vnd | integer | Có | Tiền thuế VAT nằm trong giá theo bậc (subtotal_vnd + vat_vnd = giá theo bậc, VAT không cộng thêm). |
has_more | boolean | Có | — |
next_cursor | string | null | Có | Con trỏ trang kế; null khi hết dữ liệu. |
object | string | Có | Giá trị: list. |
PayQrResponse
Phần tiêu đề “PayQrResponse”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
amount_vnd | integer | Có | Số tiền cần chuyển chính xác. |
bank_account | BankAccountRecipient | Có | — |
bank_account.account_name | string | Có | Tên chủ tài khoản. |
bank_account.account_no | string | Có | Số tài khoản nhận tiền. |
bank_account.bank_name | string | Có | Tên ngân hàng ngắn gọn. |
bank_account.bin | string | Có | Mã BIN ngân hàng thụ hưởng (VietQR). |
expires_at | string | Có | Thời điểm hết hiệu lực thanh toán (15 phút). |
invoice_id | BillingInvoiceId | Có | — |
memo_code | string | Có | Mã nội dung chuyển tiền DTP… chuẩn. |
qr_data_url | string | Không | Ảnh QR định dạng data:image/png (nếu có). |
qr_payload | string | Có | Chuỗi chuẩn VietQR EMV Co. |
BillingMeter
Phần tiêu đề “BillingMeter”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
capped | boolean | Có | true khi đã vượt trần chi tiêu. |
estimated_fee_vnd | integer | Có | Ước tính phí phát sinh kỳ hiện tại (giá theo bậc, đã gồm VAT). |
is_illustrative | boolean | Có | true khi giá và phí còn gắn nhãn minh hoạ. |
period | string | Có | Kỳ đo lường YYYY-MM (giờ VN). |
projected | integer | Có | Dự kiến số giao dịch cuối tháng. |
quota | integer | Có | Số giao dịch miễn phí trong gói. |
spend_cap_vnd | integer | null | Có | Trần chi tiêu do khách đặt (null = không đặt). |
today | integer | Có | Số giao dịch tính đến hiện tại trong ngày. |
used | integer | Có | Số giao dịch đã xác thực trong kỳ. |
CurrentPlanResponse
Phần tiêu đề “CurrentPlanResponse”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
description | string | null | Có | — |
dunning_stage | string | Có | Giá trị: current, reminder_3d, reminder_7d, reminder_14d, suspended_30d. |
is_illustrative | boolean | Có | — |
limits | PlanLimits | Có | — |
name | string | Có | — |
plan_key | string | Có | Giá trị: free, per_tx, enterprise, trial, internal. |
state | string | Có | Giá trị: trial, active, overdue, suspended, closing. |
tiers | PlanTier[] | Có | — |
tiers[].unit_vnd | integer | Có | Đơn giá mỗi giao dịch trong bậc (VND). |
tiers[].up_to | integer | null | Có | Hạn mức tối đa của bậc (null = không giới hạn). |
trial_ends_at | Timestamp | null | Có | — |
SpendCap
Phần tiêu đề “SpendCap”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
spend_cap_vnd | integer | null | Có | Hạn mức trần chi tiêu (null = không hạn chế). |
UpdateSpendCap
Phần tiêu đề “UpdateSpendCap”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
spend_cap_vnd | integer | null | Có | Đặt lại hạn mức trần chi tiêu VND (null để gỡ bỏ). |
UsageBreakdownResponse
Phần tiêu đề “UsageBreakdownResponse”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
items | UsageBreakdownItem[] | Có | — |
items[].company_id | string | Không | — |
items[].count | integer | Có | — |
items[].date | Date | Không | — |
items[].source | string | Không | — |
period | string | Có | — |
total_count | integer | Có | — |
Đối tượng khác của nhóm này (xem tài liệu tương tác): PublicPlansResponse
Lưu ý về từ "đã xác thực": đây là xác thực nguồn, không phải ngân hàng xác nhận quyết toán.
do don dong dat de dia dien da dinh doc dang den doi duoc diem day