> ## 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.

# Query Subscription Order List

> Query subscription order list

## Overview

This page documents the `GET /open/v1/order/list` endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

## Notes

* Authentication uses the standard GatePay signed headers.
* This page documents the standard merchant endpoint.
* For shared signing rules, see [/api-reference/version/100/en/common/securityAndSignature](/api-reference/version/100/en/common/securityAndSignature).


## OpenAPI

````yaml /api-reference/version/100/en/openapi/subscription/orderList-openapi.json GET /open/v1/order/list
openapi: 3.1.0
info:
  title: GatePay API
  description: GatePay Payment Platform API Documentation
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://openplatform.gateapi.io/pay-subscription
security: []
paths:
  /open/v1/order/list:
    get:
      summary: Query Subscription Order List
      description: Query subscription order list
      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/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: Query subscription order list successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubscriptionPlanResponse'
              examples:
                successResponse:
                  summary: Success Response
                  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: Test centralized payment
                          merchantId: '10002'
                          productNo: '4'
                          productName: AI password-free payment
                          priceNo: '9'
                          priceName: Automatic deduction
                          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: Merchant client ID, obtained from GatePay platform application
      schema:
        type: string
        example: 4186d0c6-6a35-55a9-8dc6-5312769dbff8
    X-GatePay-Signature:
      name: X-GatePay-Signature
      in: header
      required: true
      description: HMAC-SHA256 signature, used to verify request legitimacy
      schema:
        type: string
        example: >-
          672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77
    X-GatePay-Timestamp:
      name: X-GatePay-Timestamp
      in: header
      required: true
      description: >-
        Timestamp (milliseconds), time difference with server cannot exceed 5
        minutes
      schema:
        type: string
        example: '1672905655498'
    X-GatePay-Nonce:
      name: X-GatePay-Nonce
      in: header
      required: true
      description: Random number, used to prevent replay attacks
      schema:
        type: string
        example: '9578'
    orderList_merchantPlanNo:
      name: merchantPlanNo
      in: query
      required: false
      description: Merchant subscription plan number (choose one with planNo, or neither)
      schema:
        type: string
    orderList_planNo:
      name: planNo
      in: query
      required: false
      description: >-
        Platform subscription plan number (choose one with merchantPlanNo, or
        neither)
      schema:
        type: string
    orderList_userAddress:
      name: userAddress
      in: query
      required: false
      description: User authorized address
      schema:
        type: string
    orderList_orderStatus:
      name: orderStatus
      in: query
      required: false
      description: Subscription status filter
      schema:
        type: string
    orderList_startTime:
      name: startTime
      in: query
      required: false
      description: Creation start time, millisecond timestamp
      schema:
        type: integer
        format: int64
    orderList_endTime:
      name: endTime
      in: query
      required: false
      description: Creation end time, millisecond timestamp, maximum 1 year
      schema:
        type: integer
        format: int64
    orderList_page:
      name: page
      in: query
      required: true
      description: Page number, starts from 0 (required)
      schema:
        type: string
        pattern: ^[0-9]+$
        example: '1'
    orderList_count:
      name: count
      in: query
      required: true
      description: Number per page, maximum 100 (required)
      schema:
        type: string
        pattern: ^[0-9]+$
        example: '10'
  schemas:
    CreateSubscriptionPlanResponse:
      type: object
      properties:
        code:
          type: string
          description: Response code, 0 indicates success
          example: '0'
        message:
          type: string
          description: Response description, empty when successful
          example: ''
        success:
          type: boolean
          description: Whether the request was successful
          example: true
        data:
          type: object
          properties:
            total:
              type: integer
              description: Total count
            list:
              type: array
              description: Subscription order list
              items:
                type: object
                properties:
                  subscriptionOrderNo:
                    type: string
                    description: Platform subscription order number
                  merchantSubscriptionOrderNo:
                    type: string
                    description: Merchant subscription order number
                  subscriptionLink:
                    type: string
                    description: >-
                      Subscription page link, used for users to initiate
                      subscription authorization
                  planNo:
                    type: string
                    description: Platform subscription plan number
                  planName:
                    type: string
                    description: Subscription plan name
                  planDesc:
                    type: string
                    description: Subscription plan description
                  merchantId:
                    type: string
                    description: Merchant number who created the subscription plan
                  productNo:
                    type: string
                    description: Product number
                  productName:
                    type: string
                    description: Product name
                  priceNo:
                    type: string
                    description: Price number
                  priceName:
                    type: string
                    description: Price name
                  cryptoCurrency:
                    type: string
                    description: Cryptocurrency type
                  chain:
                    type: string
                    description: Cryptocurrency network
                  userAddress:
                    type: string
                    description: User authorized address
                  merchantAddress:
                    type: string
                    description: Address for platform to receive deduction
                  cryptoAmount:
                    type: string
                    description: Single deduction amount
                  paidCount:
                    type: integer
                    description: Number of deductions made
                  totalPaidAmount:
                    type: string
                    description: Total amount deducted
                  period:
                    type: string
                    description: Deduction period
                  interval:
                    type: integer
                    description: Deduction interval
                  totalPayCount:
                    type: integer
                    description: Total number of deductions that need to be completed
                  trialDays:
                    type: integer
                    description: Trial days
                  endTime:
                    type: integer
                    format: int64
                    description: Subscription auto-end date
                  lastPayTime:
                    type: integer
                    format: int64
                    description: Last deduction time
                  promoAmount:
                    type: string
                    description: First period special price amount
                  promoRate:
                    type: string
                    description: First period special price percentage
                  callbackUrl:
                    type: string
                    description: Page URL to redirect after successful subscription
                  orderStatus:
                    type: string
                    description: Subscription status
                  createTime:
                    type: integer
                    format: int64
                    description: Order creation time
                  updateTime:
                    type: integer
                    format: int64
                    description: Order update time

````