pop-parent 介面文件
更新時間:2026-04-29 16:23:12
查詢方案續約資訊
介面位址
GET /pcs/v1/customer/package-renewal/info
介面說明
查詢客戶的方案續約資訊、資源包續約資訊、資源包列表。
請求參數
| 參數名 | 類型 | 必填 | 說明 |
|---|---|---|---|
liveUserId |
String |
是 | 直播使用者 ID |
說明:
- 目前實作中,該介面實際主要使用
liveUserId。 - 非一般帳號會直接回傳空物件。
回傳結果
回傳物件:PackageRenewalInfoVO
| 欄位名 | 類型 | 說明 |
|---|---|---|
packageRenewalStatus |
PackageRenewalStatusVO |
方案續約狀態 |
resourcePackageStatus |
PackageRenewalStatusVO |
資源包續約狀態 |
resourcePackageList |
List<ResourcePackagesDetailVO> |
資源包列表 |
packageRenewalStatus / resourcePackageStatus 欄位
| 欄位名 | 類型 | 說明 |
|---|---|---|
renewalInfo |
PackageRenewalBasicInfo |
基礎續約狀態 |
livePackageInfo |
LivePackageInfo |
目前直播方案資訊 |
vodPackageInfo |
VodPackageInfo |
目前點播方案資訊 |
accountBalanceInfo |
AccountBalanceInfo |
帳戶餘額資訊 |
vodAgreementType |
String |
點播協議類型 |
liveAgreementType |
String |
直播協議類型 |
resourceAgreementType |
String |
資源包協議類型 |
livePackageInfoList |
List<LivePackageInfo> |
直播方案列表 |
vodPackageInfoList |
List<VodPackageInfo> |
點播方案列表 |
renewalInfo 欄位
| 欄位名 | 類型 | 說明 |
|---|---|---|
liveWaitOpenExists |
String |
直播是否存在待開通資源,Y/N |
vodWaitOpenExists |
String |
點播是否存在待開通資源,Y/N |
liveRenewalEnabled |
String |
直播是否可續約,Y/N |
vodRenewalEnabled |
String |
點播是否可續約,Y/N |
disabledByAccount |
String |
是否因帳戶驗證不可續約,Y/N |
LivePackageInfo 欄位
| 欄位名 | 類型 | 說明 |
|---|---|---|
packageId |
Long |
方案 ID |
billingPlanCode |
String |
方案編碼,如 live_duration、live_concurrent |
currentStartDate |
String |
目前方案開始時間 |
currentEndDate |
String |
目前方案結束時間 |
remainingDays |
Integer |
剩餘天數 |
renewalStartDate |
String |
新方案開始時間 |
renewalEndDate |
String |
新方案結束時間 |
validityUnit |
Integer |
有效月數 |
amount |
Long |
金額 |
packageName |
String |
方案名稱 |
packageDesc |
String |
方案描述 |
productCode |
String |
產品編碼 |
cooperationSubject |
String |
簽約主體,0/1/2/3 |
origin |
String |
來源 |
createUserName |
String |
建立人名稱 |
approvalStatus |
String |
審批狀態,如 audit/pass/reject |
validLiveDuration |
Long |
目前可用直播分鐘數 |
liveDuration |
Long |
方案直播分鐘數 |
liveConcurrences |
Long |
方案並發數 |
liveConcurrentIsLimit |
Short |
是否限制並發,0/1 |
VodPackageInfo 欄位
| 欄位名 | 類型 | 說明 |
|---|---|---|
packageId |
Long |
方案 ID |
billingPlanCode |
String |
方案編碼 |
currentStartDate |
String |
目前方案開始時間 |
currentEndDate |
String |
目前方案結束時間 |
remainingDays |
Integer |
剩餘天數 |
renewalStartDate |
String |
新方案開始時間 |
renewalEndDate |
String |
新方案結束時間 |
validityUnit |
Integer |
有效月數 |
amount |
Long |
金額 |
packageName |
String |
方案名稱 |
packageDesc |
String |
方案描述 |
productCode |
String |
產品編碼 |
cooperationSubject |
String |
簽約主體 |
origin |
String |
來源 |
createUserName |
String |
建立人名稱 |
approvalStatus |
String |
審批狀態 |
vodFlow |
Long |
點播流量 |
vodSpace |
Long |
點播空間 |
vodPackageIsAnnualFlow |
Short |
是否年流量方案 |
packageIsCustomize |
Short |
是否客製方案 |
vodPackageFlowMonthsOfYear |
Integer |
年流量月數 |
AccountBalanceInfo 欄位
| 欄位名 | 類型 | 說明 |
|---|---|---|
liveUserStatus |
String |
直播使用者狀態 |
validAmount |
Long |
帳戶餘額 |
resourcePackageList 欄位
| 欄位名 | 類型 | 說明 |
|---|---|---|
id |
Integer |
主鍵 |
categoryDisplay |
String |
分類顯示名稱 |
pricingTypeDisplay |
String |
使用時效規則 |
name |
String |
資源包名稱 |
description |
String |
資源包描述 |
category |
String |
資源包分類 |
crmProductId |
String |
CRM 產品 ID |
crmProductName |
String |
CRM 產品名稱 |
unitPrice |
String |
單價 |
billingUnit |
String |
計費單位 |
minPurchaseQty |
Integer |
最小購買數量 |
maxPurchaseQty |
Integer |
最大購買數量 |
pricingType |
String |
計費模式 |
durationDays |
Integer |
持續天數 |
presetQuantities |
List<Integer> |
預設數量 |
dependencyType |
List<String> |
依賴類型 |
sortOrder |
Integer |
排序 |
purchasable |
String |
是否可購買,Y/N |
cooperationSubject |
String |
支付主體 |
merchantCode |
String |
商家編碼 |
validityUnit |
Integer |
有效期值 |
validity |
Integer |
有效期單位 |
startDate |
String |
新方案開始時間 |
endDate |
String |
新方案截止時間 |
convertPrice |
BigDecimal |
換算單價 |
purchaseStep |
Integer |
購買步長 |
tags |
List<TagVO> |
標籤列表 |
請求範例
GET /pcs/v1/customer/package-renewal/info?liveUserId=9a8b7c6d5e
回傳範例
{
"packageRenewalStatus": {
"renewalInfo": {
"liveWaitOpenExists": "N",
"vodWaitOpenExists": "N",
"liveRenewalEnabled": "Y",
"vodRenewalEnabled": "Y",
"disabledByAccount": "N"
},
"livePackageInfo": {
"packageId": 1001,
"billingPlanCode": "live_duration",
"packageName": "直播分钟数套餐",
"amount": 120000
},
"vodPackageInfo": {
"packageId": 2001,
"billingPlanCode": "vod_package",
"packageName": "点播套餐",
"amount": 80000
}
},
"resourcePackageStatus": {
"renewalInfo": {
"liveRenewalEnabled": "Y",
"vodRenewalEnabled": "Y"
}
},
"resourcePackageList": [
{
"id": 1,
"name": "直播流量包",
"category": "live_flow",
"unitPrice": "1000"
}
]
}
