> ## 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 Deduction List

> Query deduction order list

## Overview

This page documents the `GET /open/institution/v1/deduction/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/institution/subscription/deductionOrderList-openapi.json GET /open/institution/v1/deduction/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/institution/v1/deduction/order/list:
    get:
      summary: Query Deduction Order List
      description: Query deduction 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/X-GatePay-On-Behalf-Of'
        - $ref: '#/components/parameters/deductionList_subscriptionOrderNo'
        - $ref: '#/components/parameters/deductionList_merchantSubscriptionOrderNo'
        - $ref: '#/components/parameters/deductionList_payStatus'
        - $ref: '#/components/parameters/deductionList_startTime'
        - $ref: '#/components/parameters/deductionList_endTime'
        - $ref: '#/components/parameters/deductionList_page'
        - $ref: '#/components/parameters/deductionList_count'
      responses:
        '200':
          description: Query deduction order list successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubscriptionPlanResponse'
              examples:
                successResponse:
                  summary: Success Response
                  value:
                    code: '0'
                    message: ''
                    data:
                      total: 1
                      list:
                        - subscriptionOrderNo: '70778338049917032'
                          merchantSubscriptionOrderNo: rhys-81
                          planNo: '70778338049916930'
                          paymentOrderNo: '70778338049917033'
                          merchantDeductNo: ''
                          txHash: >-
                            0x658d3a403a4d6879dfd94229270a13e04249b50020ead15f6b7dceeb11286aee
                          merchantId: '10002'
                          cryptoCurrency: USDT
                          chain: BSC
                          userAddress: '0xbe6D780C23E77D979Fad5FbEa249a44E5cAC0463'
                          merchantAddress: '0xeEfAe46E6551E54879C80C16882f745c25361473'
                          cryptoAmount: '0.01000000'
                          isDiscounted: false
                          payTime: 1773989575000
                          payStatus: SUCCESS
                          description: null
                          failReason: null
                    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'
    X-GatePay-On-Behalf-Of:
      name: X-GatePay-On-Behalf-Of
      in: header
      required: true
      schema:
        type: string
      description: >-
        Required delegated-subject header. Provide the initiating account ID for
        this request. For institution merchant APIs, this is typically the
        target sub-account ID; for institution charge and transfer APIs, it can
        be either an institution account ID or a sub-account ID.
    deductionList_subscriptionOrderNo:
      name: subscriptionOrderNo
      in: query
      required: false
      description: >-
        Subscription order number (choose one with merchantSubscriptionOrderNo)
        At least one of subscriptionOrderNo or merchantSubscriptionOrderNo is
        required
      schema:
        type: string
    deductionList_merchantSubscriptionOrderNo:
      name: merchantSubscriptionOrderNo
      in: query
      required: false
      description: >-
        Merchant subscription order number (choose one with subscriptionOrderNo)
        At least one of subscriptionOrderNo or merchantSubscriptionOrderNo is
        required
      schema:
        type: string
    deductionList_payStatus:
      name: payStatus
      in: query
      required: false
      description: 'Deduction status filter: SUCCESS/FAIL/BLOCK'
      schema:
        type: string
    deductionList_startTime:
      name: startTime
      in: query
      required: false
      description: Deduction start time, millisecond timestamp
      schema:
        type: integer
        format: int64
    deductionList_endTime:
      name: endTime
      in: query
      required: false
      description: Deduction end time, millisecond timestamp, maximum 1 year
      schema:
        type: integer
        format: int64
    deductionList_page:
      name: page
      in: query
      required: false
      description: Page number, starts from 0
      schema:
        type: integer
        format: int32
        minimum: 1
        example: 1
    deductionList_count:
      name: count
      in: query
      required: false
      description: Number per page, maximum 100
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        example: 10
  schemas:
    CreateSubscriptionPlanResponse:
      type: object
      properties:
        total:
          type: integer
          description: Total count
        list:
          type: array
          description: Deduction record list
          items:
            type: object
            properties:
              subscriptionOrderNo:
                type: string
                description: Subscription order number
              merchantSubscriptionOrderNo:
                type: string
                description: Merchant subscription order number
              planNo:
                type: string
                description: Subscription plan number
              paymentOrderNo:
                type: string
                description: Order number for subscription deduction
              txHash:
                type: string
                description: On-chain transaction ID
              merchantId:
                type: string
                description: Merchant number who created the subscription plan
              cryptoCurrency:
                type: string
                description: Cryptocurrency type
              chain:
                type: string
                description: Cryptocurrency network
              userAddress:
                type: string
                description: User payment on-chain address
              merchantAddress:
                type: string
                description: Address for platform to receive deduction
              cryptoAmount:
                type: string
                description: Single deduction amount
              isDiscounted:
                type: boolean
                description: Whether it's a special price deduction
              discountInfo:
                type: object
                description: Special price information (if any)
              payTime:
                type: integer
                format: int64
                description: Time when deduction order was created
              payStatus:
                type: string
                description: 'Deduction status: SUCCESS/FAIL/BLOCK'

````