> ## Documentation Index > Fetch the complete documentation index at: https://docs.gate.com/llms.txt > Use this file to discover all available pages before exploring further. # 查询订阅订单列表 > 查询订阅订单列表 ## 概述 本页说明 `GET /open/institution/v1/order/list` 接口。完整的请求参数、响应结构与示例由上方关联的 OpenAPI 定义渲染。 ## 说明 * 认证方式使用 GatePay 标准签名请求头。 * 本页展示同一接口的机构路径版本。 * 除创建子账户、查询子账户详情、分页查询子账户外，机构侧请求需携带 `X-GatePay-On-Behalf-Of`。 * 通用签名规则请参见 [/api-reference/version/100/cn/common/securityAndSignature](/api-reference/version/100/cn/common/securityAndSignature)。 ## OpenAPI ````yaml api-reference/version/100/cn/openapi/institution/subscription/orderList-openapi.json GET /open/institution/v1/order/list openapi: 3.1.0 info: title: GatePay 机构订阅 API description: GatePay 支付平台 API 接口文档 license: name: MIT version: 1.0.0 servers: - url: https://openplatform.gateapi.io/pay-subscription security: [] paths: /open/institution/v1/order/list: get: summary: 查询订阅订单列表 description: 查询订阅订单列表 parameters: - $ref: '#/components/parameters/X-GatePay-Certificate-ClientId' - $ref: '#/components/parameters/X-GatePay-Signature' - $ref: '#/components/parameters/X-GatePay-Timestamp' - $ref: '#/components/parameters/X-GatePay-Nonce' - $ref: '#/components/parameters/X-GatePay-On-Behalf-Of' - $ref: '#/components/parameters/orderList_merchantPlanNo' - $ref: '#/components/parameters/orderList_planNo' - $ref: '#/components/parameters/orderList_userAddress' - $ref: '#/components/parameters/orderList_orderStatus' - $ref: '#/components/parameters/orderList_startTime' - $ref: '#/components/parameters/orderList_endTime' - $ref: '#/components/parameters/orderList_page' - $ref: '#/components/parameters/orderList_count' responses: '200': description: 查询订阅订单列表成功 content: application/json: schema: $ref: '#/components/schemas/CreateSubscriptionPlanResponse' examples: successResponse: summary: 成功响应 value: code: '0' message: '' data: records: - subscriptionOrderNo: '2037430636859437083' merchantSubscriptionOrderNo: central-1 subscriptionLink: >- https://119.28.35.132:13555/zh/web3-subscribe?subscriptionOrderNo=2037430636859437083 planNo: '2037430636851048458' planName: test_central planDesc: 测试 中心化支付 merchantId: '10002' productNo: '4' productName: ai免密支付 priceNo: '9' priceName: 代扣 cryptoCurrency: USDT chain: '' userAddress: '' cryptoAmount: null paidCount: 0 totalPaidAmount: '0' period: NONE interval: 1 totalPayCount: 0 trialDays: 0 endTime: 0 lastPayTime: 0 promoAmount: '0' promoRate: '0' callbackUrl: https://gate.com orderStatus: CANCELLED createTime: 1774599056574 updateTime: 1774656660000 total: 78 success: true components: parameters: X-GatePay-Certificate-ClientId: name: X-GatePay-Certificate-ClientId in: header required: true description: 商户客户端ID，在 GatePay 平台申请获得 schema: type: string example: 4186d0c6-6a35-55a9-8dc6-5312769dbff8 X-GatePay-Signature: name: X-GatePay-Signature in: header required: true description: HMAC-SHA256签名，用于验证请求合法性 schema: type: string example: >- 672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77 X-GatePay-Timestamp: name: X-GatePay-Timestamp in: header required: true description: 时间戳（毫秒），与服务器时间差不能超过5分钟 schema: type: string example: '1672905655498' X-GatePay-Nonce: name: X-GatePay-Nonce in: header required: true description: 随机数，用于防止重放攻击 schema: type: string example: '9578' X-GatePay-On-Behalf-Of: name: X-GatePay-On-Behalf-Of in: header required: true schema: type: string description: >- 必填代理归属请求头。请填写本次请求的发起方账户 ID；在机构代理商户 API 中通常填写目标子账户 ID，在机构代扣与划转接口中可填写机构账户 ID 或子账户 ID。 orderList_merchantPlanNo: name: merchantPlanNo in: query required: false description: 商户订阅计划编号（与planNo任选一个，或都不传） schema: type: string orderList_planNo: name: planNo in: query required: false description: 平台订阅计划编号（与merchantPlanNo任选一个，或都不传） schema: type: string orderList_userAddress: name: userAddress in: query required: false description: 用户授权地址 schema: type: string orderList_orderStatus: name: orderStatus in: query required: false description: 订阅状态筛选 schema: type: string orderList_startTime: name: startTime in: query required: false description: 创建开始时间，毫秒时间戳 schema: type: integer format: int64 orderList_endTime: name: endTime in: query required: false description: 创建结束时间，毫秒时间戳，最长1年 schema: type: integer format: int64 orderList_page: name: page in: query required: true description: 页码，从0开始（必填） schema: type: string pattern: ^[0-9]+$ example: '1' orderList_count: name: count in: query required: true description: 每页数量，最大100（必填） schema: type: string pattern: ^[0-9]+$ example: '10' schemas: CreateSubscriptionPlanResponse: type: object properties: code: type: string description: 响应码，0 表示成功 example: '0' message: type: string description: 响应描述，成功时为空 example: '' success: type: boolean description: 请求是否成功 example: true data: type: object properties: total: type: integer description: 总数量 list: type: array description: 订阅订单列表 items: type: object properties: subscriptionOrderNo: type: string description: 平台订阅订单编号 merchantSubscriptionOrderNo: type: string description: 商户订阅订单编号 subscriptionLink: type: string description: 订阅页面链接，用于用户发起订阅授权 planNo: type: string description: 平台订阅计划编号 planName: type: string description: 订阅计划名称 planDesc: type: string description: 订阅计划描述 merchantId: type: string description: 创建订阅计划的商户编号 productNo: type: string description: 产品编号 productName: type: string description: 产品名称 priceNo: type: string description: 价格编号 priceName: type: string description: 价格名称 cryptoCurrency: type: string description: 加密货币币种 chain: type: string description: 加密货币网络 userAddress: type: string description: 用户授权的地址 merchantAddress: type: string description: 平台接收扣款的地址 cryptoAmount: type: string description: 单次扣款金额 paidCount: type: integer description: 已扣款次数 totalPaidAmount: type: string description: 已扣款总金额 period: type: string description: 扣款周期 interval: type: integer description: 扣款间隔 totalPayCount: type: integer description: 一共需要完成的扣款次数 trialDays: type: integer description: 试用天数 endTime: type: integer format: int64 description: 订阅自主结束的日期 lastPayTime: type: integer format: int64 description: 最近一次扣款时间 promoAmount: type: string description: 首期特价金额 promoRate: type: string description: 首期特价百分比 callbackUrl: type: string description: 订阅成功后跳转的页面URL orderStatus: type: string description: 订阅状态 createTime: type: integer format: int64 description: 订单创建时间 updateTime: type: integer format: int64 description: 订单更新时间 ````