Toggle-active subscription package
# 1. Tổng quan
- Action URL:
/subscription/toggle-active - Đặc tả chi tiết: Swagger Link (opens new window)
- Mô tả:
- Kích hoạt hoặc vô hiệu hóa gói subscription package.
- Chỉ F1 agency mới có thể bật/tắt subscription thuộc về mình.
- Hệ thống sẽ tự động chuyển đổi giữa ACTIVE và INACTIVE.
- Chỉ áp dụng cho tài khoản agency F1.
# 2. Hướng dẫn
- Bước 1: Thực hiện xây dựng request và POST tới API action URL.
- Bước 2: Nhận về response.
# 3. Parameters
# Ví dụ Parameters
| Thuộc tính | Bắt buộc | Kiểu dữ liệu | Mô tả |
|---|---|---|---|
| ID | Có | String | ID của subscription cần bật/tắt |
| x-api-token | Có | String | Token API (F1) |
| x-api-password | Có | String | Mật khẩu API (F1) |
| x-api-account | Có | String | Tài khoản API (F1) |
# 4. Response
# 4.1 Ví dụ Response
{
"StatusCode": "201",
"Timestamp": "2025-10-22T07:00:00Z",
"Path": "/subscription/toggle-active",
"Message": "Subscription đã được bật/tắt thành công",
"Data": {
"message": "Subscription is now ACTIVE"
},
"Errors": null,
"RequestId": "req_123456789",
"TotalDuration": 123
}
# 4.2 Bảng mô tả Response
| Thuộc tính | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|
| StatusCode | String | Tình trạng request | 201: sub được bật/tắt thành công 400: dữ liệu không hợp lệ 401: Không có quyền bật/tắt sub 403: Chỉ F1 agency mới có quyền bật/tắt sub 404: Không tìm thấy sub 409: Không thể thao tác hiện tại |
| Timestamp | String | Thời gian phản hồi | "2025-10-22T07:00:00Z" |
| Path | String | Đường dẫn API | "/subscription/toggle-active" |
| Message | String | Tin nhắn thông báo | "Subscription đã được bật/tắt thành công" |
| Data.message | String | Thông tin trạng thái mới của subscription | "Subscription is now ACTIVE" |
| Errors | String | Lỗi khi thực hiện request | null |
| RequestId | String | Mã định danh request | "req_123456789" |
| TotalDuration | number | Thời gian xử lý request (ms) | 123 |