pop-parent API Documentation

Updated: 2026-04-29 16:23:12

Query Package Renewal Information

API Endpoint

GET /pcs/v1/customer/package-renewal/info

API Description

Query the customer's package renewal information, resource package renewal information, and resource package list.

Request Parameters

Parameter	Type	Required	Description
`liveUserId`	`String`	Yes	Live streaming user ID

Notes:

In the current implementation, this API primarily uses liveUserId.
Non-standard accounts will directly return an empty object.

Response Result

Return object: PackageRenewalInfoVO

Field	Type	Description
`packageRenewalStatus`	`PackageRenewalStatusVO`	Package renewal status
`resourcePackageStatus`	`PackageRenewalStatusVO`	Resource package renewal status
`resourcePackageList`	`List<ResourcePackagesDetailVO>`	Resource package list

packageRenewalStatus / resourcePackageStatus Fields

Field	Type	Description
`renewalInfo`	`PackageRenewalBasicInfo`	Basic renewal status
`livePackageInfo`	`LivePackageInfo`	Current live streaming package information
`vodPackageInfo`	`VodPackageInfo`	Current video-on-demand (VOD) package information
`accountBalanceInfo`	`AccountBalanceInfo`	Account balance information
`vodAgreementType`	`String`	VOD protocol type
`liveAgreementType`	`String`	Live streaming protocol type
`resourceAgreementType`	`String`	Resource package protocol type
`livePackageInfoList`	`List<LivePackageInfo>`	Live streaming package list
`vodPackageInfoList`	`List<VodPackageInfo>`	VOD package list

renewalInfo Fields

Field	Type	Description
`liveWaitOpenExists`	`String`	Whether live streaming has pending resources to activate, `Y/N`
`vodWaitOpenExists`	`String`	Whether VOD has pending resources to activate, `Y/N`
`liveRenewalEnabled`	`String`	Whether live streaming is renewable, `Y/N`
`vodRenewalEnabled`	`String`	Whether VOD is renewable, `Y/N`
`disabledByAccount`	`String`	Whether renewal is blocked due to account validation, `Y/N`

LivePackageInfo Fields

Field	Type	Description
`packageId`	`Long`	Package ID
`billingPlanCode`	`String`	Package code, e.g., `live_duration`, `live_concurrent`
`currentStartDate`	`String`	Current package start time
`currentEndDate`	`String`	Current package end time
`remainingDays`	`Integer`	Remaining days
`renewalStartDate`	`String`	New package start time
`renewalEndDate`	`String`	New package end time
`validityUnit`	`Integer`	Valid months
`amount`	`Long`	Amount
`packageName`	`String`	Package name
`packageDesc`	`String`	Package description
`productCode`	`String`	Product code
`cooperationSubject`	`String`	Contracting entity, `0/1/2/3`
`origin`	`String`	Source
`createUserName`	`String`	Creator name
`approvalStatus`	`String`	Approval status, e.g., `audit/pass/reject`
`validLiveDuration`	`Long`	Currently available live streaming minutes
`liveDuration`	`Long`	Package live streaming minutes
`liveConcurrences`	`Long`	Package concurrent connections
`liveConcurrentIsLimit`	`Short`	Whether concurrent connections are limited, `0/1`

VodPackageInfo Fields

Field	Type	Description
`packageId`	`Long`	Package ID
`billingPlanCode`	`String`	Package code
`currentStartDate`	`String`	Current package start time
`currentEndDate`	`String`	Current package end time
`remainingDays`	`Integer`	Remaining days
`renewalStartDate`	`String`	New package start time
`renewalEndDate`	`String`	New package end time
`validityUnit`	`Integer`	Valid months
`amount`	`Long`	Amount
`packageName`	`String`	Package name
`packageDesc`	`String`	Package description
`productCode`	`String`	Product code
`cooperationSubject`	`String`	Contracting entity
`origin`	`String`	Source
`createUserName`	`String`	Creator name
`approvalStatus`	`String`	Approval status
`vodFlow`	`Long`	VOD traffic
`vodSpace`	`Long`	VOD storage
`vodPackageIsAnnualFlow`	`Short`	Whether it is an annual traffic package
`packageIsCustomize`	`Short`	Whether it is a custom package
`vodPackageFlowMonthsOfYear`	`Integer`	Annual traffic months

AccountBalanceInfo Fields

Field	Type	Description
`liveUserStatus`	`String`	Live streaming user status
`validAmount`	`Long`	Account balance

resourcePackageList Fields

Field	Type	Description
`id`	`Integer`	Primary key
`categoryDisplay`	`String`	Category display name
`pricingTypeDisplay`	`String`	Usage validity rules
`name`	`String`	Resource package name
`description`	`String`	Resource package description
`category`	`String`	Resource package category
`crmProductId`	`String`	CRM product ID
`crmProductName`	`String`	CRM product name
`unitPrice`	`String`	Unit price
`billingUnit`	`String`	Billing unit
`minPurchaseQty`	`Integer`	Minimum purchase quantity
`maxPurchaseQty`	`Integer`	Maximum purchase quantity
`pricingType`	`String`	Billing mode
`durationDays`	`Integer`	Duration in days
`presetQuantities`	`List<Integer>`	Preset quantity
`dependencyType`	`List<String>`	Dependency type
`sortOrder`	`Integer`	Sort order
`purchasable`	`String`	Whether purchasable, `Y/N`
`cooperationSubject`	`String`	Payment entity
`merchantCode`	`String`	Merchant code
`validityUnit`	`Integer`	Validity period value
`validity`	`Integer`	Validity period unit
`startDate`	`String`	New package start time
`endDate`	`String`	New package end time
`convertPrice`	`BigDecimal`	Converted unit price
`purchaseStep`	`Integer`	Purchase step size
`tags`	`List<TagVO>`	Tag list

Request Example

GET /pcs/v1/customer/package-renewal/info?liveUserId=9a8b7c6d5e

Response Example

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

POLYV Help Center