Gói dịch vụ & thanh toán
Gói của tôi
Lấy trạng thái cửa hàng, tính năng, hạn mức, gói hiện hành, hoá đơn đang chờ và thông tin chuyển khoản
Chỉ có trên Hubport SaaS
Trên bản cài đặt riêng (máy chủ riêng), endpoint trả HTTP 404 error_saas_mode_inactive.
Endpoint
GET /v1/platformsubscriptions/me
Trả thông tin của công ty đang đăng nhập (lấy từ JWT, không nhận company_id từ client). Mọi người dùng của cửa hàng đều gọi được; endpoint vẫn dùng được khi cửa hàng bị khoá (error_company_locked) để hiển thị màn hình khoá / nâng cấp.
Response Schema
HTTP 200 - JSON Object
| Trường | Kiểu | Mô tả |
|---|---|---|
company_id | int | ID công ty |
state | string | Trạng thái cửa hàng: trial, paid, past_due, comped, free, suspended, soft_deleted, hard_deleted. Xem Gói, dùng thử & giới hạn |
access | string | Quyền truy cập: full, limited, blocked |
reason | string | Lý do khi bị khoá (rỗng nếu không bị khoá) |
features | object | Tính năng của gói đang được dùng, dạng {"connector.marketplace": bool, "connector.social": bool, "custom_domain": bool} |
limits | object | Hạn mức hiện hành, dạng {"ecomplatform_marketplace": int, "ecomchannel": int, "synced_order_monthly": int}. -1 = không giới hạn |
trial_started_at | int | Thời điểm bắt đầu dùng thử (Unix timestamp) |
trial_ends_at | int | Thời điểm hết dùng thử (Unix timestamp) |
trial_days_left | int | Số ngày dùng thử còn lại (0 nếu đã hết) |
restorable | bool | true nếu cửa hàng đang bị xoá mềm và còn khôi phục được (xem Khôi phục cửa hàng) |
subscription | object | null | Gói đăng ký hiện hành (xem bên dưới), null nếu chưa có |
plan | object | null | Plan Object của gói hiện hành, null nếu chưa có |
open_invoices | array | Tối đa 20 hoá đơn đang chờ thanh toán (status = open), mỗi phần tử là Invoice Object |
bank_info | object | Thông tin tài khoản nhận chuyển khoản của Hubport: bank_name, bank_code (tên ngắn ngân hàng dùng cho VietQR, vd MBBank), account_no, account_name, branch |
is_owner | bool | true nếu người đang đăng nhập là chủ cửa hàng (chỉ chủ cửa hàng được chọn gói và khôi phục cửa hàng) |
Subscription (subscription)
| Trường | Kiểu | Mô tả |
|---|---|---|
id | int | ID gói đăng ký |
company_id | int | ID công ty |
plan_id | int | ID gói |
plan_code | string | Mã gói (vd TRIAL, FREE, PRO) |
status | string | trialing (dùng thử), active (đang hiệu lực), past_due (quá hạn, đang ân hạn), expired (hết hạn), canceled (đã huỷ) |
cycle | string | Chu kỳ: month, year, custom |
price | int | Giá mỗi kỳ (VND) |
limits | object | Tính năng và hạn mức của gói tại thời điểm đăng ký: limit_marketplace_shops, limit_social_channels, limit_synced_orders_month, paid_features, extra_limits |
period_start | int | Bắt đầu kỳ hiện tại (Unix timestamp) |
period_end | int | Kết thúc kỳ hiện tại (Unix timestamp). 0 = không kỳ hạn |
cancel_at_period_end | int | 1 nếu gói sẽ dừng khi hết kỳ hiện tại |
canceled_at | int | Thời điểm huỷ (Unix timestamp, 0 nếu chưa huỷ) |
is_paid_plan | bool | true nếu là gói trả phí đang hiệu lực / quá hạn |
date_created | int | Thời gian tạo (Unix timestamp) |
date_modified | int | Thời gian cập nhật (Unix timestamp) |
Error Codes
| HTTP | Mã lỗi | Mô tả |
|---|---|---|
| 403 | error_company_required | Phiên đăng nhập không gắn với công ty nào |
| 404 | error_not_found | Không tìm thấy công ty |
| 404 | error_saas_mode_inactive | Không phải Hubport SaaS (bản cài đặt riêng) |
Ví dụ
curl -X GET "https://api.hubport.vn/v1/platformsubscriptions/me" \
-H "Authorization: <JWT>"{
"company_id": 12,
"state": "trial",
"access": "full",
"reason": "",
"features": {
"connector.marketplace": true,
"connector.social": true,
"custom_domain": true
},
"limits": {
"ecomplatform_marketplace": 3,
"ecomchannel": 5,
"synced_order_monthly": 1000
},
"trial_started_at": 1760317200,
"trial_ends_at": 1760922000,
"trial_days_left": 7,
"restorable": false,
"subscription": {
"id": 45,
"company_id": 12,
"plan_id": 1,
"plan_code": "TRIAL",
"status": "trialing",
"cycle": "custom",
"price": 0,
"limits": {
"limit_marketplace_shops": 3,
"limit_social_channels": 5,
"limit_synced_orders_month": 1000,
"paid_features": ["connector.marketplace", "connector.social", "custom_domain"],
"extra_limits": {}
},
"period_start": 1760317200,
"period_end": 1760922000,
"date_created": 1760317200,
"date_modified": 1760317200,
"cancel_at_period_end": 0,
"canceled_at": 0,
"is_paid_plan": false
},
"plan": {
"id": 1,
"code": "TRIAL",
"name": "Dùng thử",
"description": "",
"price_month": 0,
"price_year": 0,
"limit_marketplace_shops": 3,
"limit_social_channels": 5,
"limit_synced_orders_month": 1000,
"paid_features": ["connector.marketplace", "connector.social", "custom_domain"],
"is_free": 0
},
"open_invoices": [],
"bank_info": {
"bank_name": "Ngân hàng ABC",
"bank_code": "MBBank",
"account_no": "0000000000",
"account_name": "TEN CHU TAI KHOAN",
"branch": "Chi nhánh XYZ"
},
"is_owner": true
}