# 查询企业子账号可回收优惠券列表-ListEnterpriseMultiAccount #### 功能介绍 企业主账号在自建平台查询企业子账号的可回收优惠券。 ![](https://support.huaweicloud.com/api-oce/public_sys-resources/note_3.0-zh-cn.png) - 仅支持华为发放的测试类、商务类、活动类代金券。 #### 接口约束 该接口只允许使用企业主账号AK/SK或者Token调用。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=BSS&api=ListEnterpriseMultiAccount)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[策略授权参考](https://support.huaweicloud.com/api-oce/jac_000053.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 描述 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | |:---|:---|:---|:---|:---|:---| | businessUnitCenter:businessUnitFinance:view | 授予查看企业组织财务信息的权限 | read | - | - | - | #### URI GET /v2/enterprises/multi-accounts/retrieve-coupons 参数说明请参见下表。 表1查询参数 | 参数 | 是否必选 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---|:---| | sub_customer_id | 是 | String | \[1-64\] | 企业子账户的账号ID。 | | offset | 否 | Integer | \[0-2147483647\] | 偏移量，默认值为0。 说明： offset用于分页处理，如不涉及分页，请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1，则返回满足条件的第二个数据至最后一个数据。 示例1，满足查询条件的结果共10条数据，limit取值为10，offset取值为1，则返回的数据为2\~10，第一条数据不返回。 示例2，查询总数20条，期望每页返回10条数据，则获取第一页数据，入参offset填写0，limit填写10；获取第二页数据，入参offset填写10，limit填写10。 此参数不携带或携带值为空或携带值为null时，取默认值0；不支持携带值为空串。 | | limit | 否 | Integer | \[1-100\] | 每次查询条数，默认值为10。 此参数不携带或携带值为空或携带值为null时，取默认值0；不支持携带值为空串。 | #### 请求消息 **请求参数** 无。 **请求示例** ``` GET https://bss.myhuaweicloud.com/v2/enterprises/multi-accounts/retrieve-coupons?sub_customer_id=0970cf********60fbac0192a9e2bc0 HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ ``` #### 响应消息 **响应参数** | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | error_code | String | 最大长度：16 | 状态码。具体请参考[状态码]。只有失败才会返回这个参数。 | | error_msg | String | 最大长度：1024 | 错误描述信息。只有失败才会返回这个参数。 | | total_count | Integer | - | 记录条数。 | | avail_retrieve_coupons | List\ | - | 可回收余额信息，如果是余额账户，只会有一条记录。 具体请参见[表2]。 | 表2AvailRetrieveCoupons | 参数 | 参数类型 | 取值范围 | 描述 | |:---|:---|:---|:---| | coupon_id | String | 最大长度：64 | 主优惠券ID。 | | plan_name | String | 最大长度：256 | 促销计划名称。 | | sub_coupon_id | String | 最大长度：64 | 子优惠券ID。主优惠券拨款后生成的子优惠券ID。 | | balance | String | 最大长度：64 | 优惠券余额。单位为元 | | effective_time | String | 最大长度：20 | 生效时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如"2019-05-06T08:05:01Z"。 | | expire_time | String | 最大长度：20 | 失效时间。 UTC时间，格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如"2019-05-06T08:05:01Z"。 | | use_limits | List\ | - | 优惠券限制。 具体请参见[表3]。 | 表3ICouponUseLimitInfoV2 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | use_limiti_info_id | String | 使用限制ID，主键。 | | limit_key | String | 折扣限制，key的取值请参考[表4]。 | | value1 | String | value1。 | | value2 | String | value2。 | | value_unit | String | value单位。 | | limit_type | String | 限制类型。 | | promotion_plan_id | String | 促销计划ID。 | 表4ICouponUseLimitInfo的limit_key要求 | key值 | 含义 | 说明 | 备注 | |:---|:---|:---|:---| | baseValue | 订单金额 | value1中保存订单金额下限，value2中保存订单金额上限。 | 支持代金券，现金券，折扣券 | | serviceType | 云服务类型 | 只有value1有效，具体的云服务类型请调用[查询云服务类型列表-ListServiceTypes](https://support.huaweicloud.com/api-oce/zh-cn_topic_0000001256679455.html)接口获取。 | 支持代金券，现金券，折扣券 | | regionCode | 区域编码 | value2中保存区域名称，value1中保存区域编码。 | 支持代金券，现金券，折扣券 | | productId | 产品ID | 可以包含多个产品ID，英文逗号分隔。 | 支持代金券，现金券，折扣券 | | subscribeType | 订购类型 | 只有value1有效。取值为： - 下单：new - 续订：renew - 变更：change | 支持代金券，现金券，折扣券 | | firstOrderInService | 首次购买限制 | 只有value1有效。 | 支持代金券，现金券，折扣券 | | cycleNum | 周期数量 | 只有value1有效。 | 支持代金券，现金券，折扣券 | | cycleType | 适用周期类型 | 取值为： - 0：包年/包月-不限 - 1：包年/包月-年 - 2：包年/包月-月 - 3：包年/包月-天 - 4：包年/包月-小时 - 5：按需 - 6：通用 - 7：一次性 （只针对订购送事件活动） - 8：预留实例 - 11：节省计划 | 支持代金券，现金券，折扣券，折扣券仅支持包年/包月 | | simultaneousUseWithEmpowerDiscount | 代金券是否可以和授权折扣同享 | 代金券是否可以和授权折扣（包括商务折扣和伙伴授予折扣）同享。 - 0：否 - 1：是 | 支持代金券，现金券，折扣券，折扣券只能使用0。 | | usageTimes | 是否支持多次使用 | 是否支持多次使用，值保存在value1中。取值为： - 0：不限制次数 - 1：1次 - N：限制使用N次（目前旧版代金券固定填写为1） | - CouponType=折扣券时，只能设置为1；不指定或者指定为非1，均设置为1。 - CouponType=代金券、现金券时，如果不指定或者指定为0、1之外的值，均设置为0。 | | isOnlyForStrictSelected | 是否只能用于云商店严选产品 | 是否只能用于云商店严选产品，值保存在value1中。取值为： - 0：否 - 1：是 如果没有这个限制，等同于0；该限制只适用于现金券。 | 支持现金券 | | isRebate | 是否参与伙伴激励返点 | 是否参与伙伴激励返点，值保存在value1中。取值为： - 0：否 - 1：是 该限制只适用于现金券。 | 支持现金券 | | serviceTypeBlackList | 服务类型黑名单 | 服务类型黑名单，value1中保存服务类型编码；该限制只适用于现金券。 | 支持现金券 | | minConsumeDiscount | 最低客户消费折扣 | 最低客户消费折扣，值保存在value1中。取值为0-1之间（不包括0和1）。 | 支持代金券、现金券 | | isForAnnualContracts | 是否只能用于包年/包月1年的订单 | 是否只能用于包年/包月1年的订单。取值为： - 0：否 - 1：是 | 支持代金券、折扣券 | | simultaneousUseWithPromotionProduct | 是否可以和促销产品同享 | 代金券是否可以和促销产品同享，值保存在value1中。取值为： - 0：否 - 1：是 | 支持代金券/折扣券 | | simultaneousUseWithPromotionDiscount | 是否可以和促销折扣同享 | 代金券是否可以和促销折扣同享，值保存在value1中。取值为： - 0：否 - 1：是 | 支持代金券 | | simultaneousUseWithDiscountCoupon | 是否可以和折扣券同享 | 代金券是否可以和折扣券同享，值保存在value1中。取值为： - 0：否 - 1：是 | 支持代金券 | **响应示例** ``` HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "total_count": 1, "avail_retrieve_coupons": [ { "coupon_id": "CP2305040704283R06", "plan_name": "zhu-jihuo", "sub_coupon_id": "CP23050507081979U3", "balance": "2.0", "effective_time": "2023-05-30T16:00:00Z", "expire_time": "2024-04-01T15:59:59Z", "use_limits": [ { "use_limiti_info_id": "CU23050407022084407W509N1VZUEL1", "limit_key": "simultaneousUseWithContractDiscount", "value1": "0", "value2": null, "value_unit": null, "limit_type": "=", "promotion_plan_id": "PCP2305040702208201T5L92E11T4FCL" } ] } ] } ``` #### 状态码 ![](https://support.huaweicloud.com/api-oce/public_sys-resources/note_3.0-zh-cn.png) - 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 - 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 | HTTP状态码 | 错误码 | 错误描述 | |:---|:---|:---| | 400 | CBC.0100 | 参数错误。 | | 403 | CBC.0151 | 访问拒绝。 | | 403 | CBC.0155 | 不允许执行当前请求。 | | 500 | CBC.0999 | 其他错误。 | | 400 | CBC.99000086 | 不存在正常的企业主子关系，需企业主子同一法人且企业子财务独立模式。 |