> ## 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/v1/plan/list` 接口。完整的请求参数、响应结构与示例由上方关联的 OpenAPI 定义渲染。

## 说明

* 认证方式使用 GatePay 标准签名请求头。
* 本页展示普通商户接口。
* 通用签名规则请参见 [/api-reference/version/100/cn/common/securityAndSignature](/api-reference/version/100/cn/common/securityAndSignature)。


## OpenAPI

````yaml api-reference/version/100/cn/openapi/subscription/planList-openapi.json GET /open/v1/plan/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/v1/plan/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/planList_planStatus'
        - $ref: '#/components/parameters/planList_productNo'
        - $ref: '#/components/parameters/planList_page'
        - $ref: '#/components/parameters/planList_count'
      responses:
        '200':
          description: 查询订阅计划列表成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubscriptionPlanResponse'
              examples:
                successResponse:
                  summary: 成功响应
                  value:
                    code: '0'
                    message: ''
                    data:
                      total: 1
                      list:
                        - merchantPlanNo: plan031004
                          planNo: '63784847096545341'
                          planName: 计划01
                          planDesc: 计划描述01
                          productName: '2'
                          productNo: '2'
                          priceNo: '3'
                          priceName: 每周
                          cryptoCurrency: USDT
                          cryptoAmount: '5'
                          period: WEEK
                          planStatus: 'on'
                          createTime: 1773107374000
                          updateTime: 1773107374000
                    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'
    planList_planStatus:
      name: planStatus
      in: query
      required: false
      description: 订阅计划状态筛选
      schema:
        type: string
        enum:
          - ACTIVE
          - INACTIVE
        example: ACTIVE
    planList_productNo:
      name: productNo
      in: query
      required: false
      description: 产品编号筛选
      schema:
        type: string
        example: PROD_ABC123
    planList_page:
      name: page
      in: query
      required: false
      description: 页码，从 1 开始，默认 1
      schema:
        type: integer
        format: int32
        minimum: 1
        default: 1
        example: 1
    planList_count:
      name: count
      in: query
      required: false
      description: 每页数量，最大 100，默认 10
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        default: 10
        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
          description: 响应数据
          properties:
            total:
              type: integer
              description: 总数量
              format: int32
              example: 100
            list:
              type: array
              description: 订阅计划列表
              items:
                type: object
                properties:
                  merchantPlanNo:
                    type: string
                    description: 商户订阅计划编号
                    example: plan031004
                  planNo:
                    type: string
                    description: 平台订阅计划编号
                    example: '63784604430893064'
                  planName:
                    type: string
                    description: 订阅计划名称
                    example: 月度会员计划
                  planDesc:
                    type: string
                    description: 订阅计划描述
                    example: 每月自动续费，享受会员专属权益
                  productNo:
                    type: string
                    description: 关联的产品编号
                    example: PROD_ABC123
                  productName:
                    type: string
                    description: 关联的产品名称
                    example: 会员产品
                  priceNo:
                    type: string
                    description: 关联的价格编号
                    example: PRICE_ABC123
                  priceName:
                    type: string
                    description: 关联的价格名称
                    example: 月度价格
                  cryptoCurrency:
                    type: string
                    description: 加密货币币种
                    example: USDT
                  cryptoAmount:
                    type: string
                    description: 加密货币金额
                    example: '10.000000'
                  period:
                    type: string
                    description: 扣款周期
                    example: MONTH
                  interval:
                    type: integer
                    description: 扣款间隔
                    format: int32
                    example: 1
                  planStatus:
                    type: string
                    description: 订阅计划状态
                    example: ACTIVE
                  createTime:
                    type: integer
                    description: 创建时间
                    format: int64
                    example: 1767225600000
                  updateTime:
                    type: integer
                    description: 更新时间
                    format: int64
                    example: 1767225600000

````