Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Determining Whether to Display a Popup Message Based on the Current Tenant's Subscription Status

Updated on 2025-09-08 GMT+08:00

Online Debugging

CLI Examples

View PDF

Determining Whether to Display a Popup Message Based on the Current Tenant's Subscription Status

Function

This API is used to determine whether to display a popup message based on the current tenant's subscription status.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{tenant_id}/api/popup-status

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
tenant_id	Yes	String	Definition: Tenant ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
projectDomainName	String	Definition: Name of the tenant to which the project belongs. Value range: N/A
currentDomainName	String	Definition: Tenant name of the current account. Value range: N/A
packageName	String	Definition: Tenant package name. Value range: N/A
isFreeze	Boolean	Definition: Whether the account is frozen. Value range: true: The account is frozen. false: The account is not frozen.
freezeType	Array of strings	Definition: Freezing type. Value range: normal: The account is normal. freeze: The account is frozen due to standard check. freeze_POLICE: The account is frozen due to security reasons. freeze_ARREAR: The account is frozen due to arrears. freeze_ILLEGAL: The account is frozen due to abuse. freeze_PARTNER: The account is frozen for partnership. close: The account is disabled.