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

> Query subscription order details

## Overview

This page documents the `GET /open/institution/v1/order/detail` 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/orderDetail-openapi.json GET /open/institution/v1/order/detail
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/order/detail:
    get:
      summary: Query Subscription Order Detail
      description: Query subscription order details
      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/subscriptionOrderNo'
        - $ref: '#/components/parameters/merchantSubscriptionOrderNo'
      responses:
        '200':
          description: Query subscription order details successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubscriptionPlanResponse'
              examples:
                successResponse:
                  summary: Success Response
                  value:
                    code: '0'
                    message: ''
                    data:
                      subscriptionOrderNo: '63812942625112175'
                      merchantSubscriptionOrderNo: rhys-60
                      subscriptionLink: >-
                        https://119.28.35.132:13555/zh/web3-subscribe?subscriptionOrderNo=63812942625112175
                      planNo: '2033844612305932301'
                      planName: plan031701 fiat currency with trial period no discount
                      planDesc: Plan Description 01
                      merchantId: '10002'
                      productNo: '3'
                      productName: Youku
                      priceNo: '7'
                      priceName: Daily
                      cryptoCurrency: USDT
                      chain: BSC
                      userAddress: '0xbe6D780C23E77D979Fad5FbEa249a44E5cAC0463'
                      userId: 10086001
                      authorizedAmount: '31.95'
                      cryptoAmount: '0.10026792'
                      paidCount: 0
                      totalPaidAmount: '0'
                      period: DAY
                      interval: 1
                      totalPayCount: 2
                      trialDays: 3
                      endTime: 0
                      lastPayTime: 0
                      promoAmount: '0'
                      promoRate: '0'
                      nextPayTime: 0
                      callbackUrl: https://gate.com
                      orderStatus: TRIAL
                      createTime: 1773921305887
                      updateTime: 1773893750000
                      priceType: FIX_AMOUNT
                      paymentChannel: GATEPAY
                      authTime: 1773921306000
                    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.
    subscriptionOrderNo:
      name: subscriptionOrderNo
      in: query
      required: false
      description: Subscription order number (choose one with merchantSubscriptionOrderNo)
      schema:
        type: string
        example: PLAN_20240101_001
    merchantSubscriptionOrderNo:
      name: merchantSubscriptionOrderNo
      in: query
      required: false
      description: Merchant subscription order number (choose one with subscriptionOrderNo)
      schema:
        type: string
        example: PRICE_ABC123
  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:
            subscriptionOrderNo:
              type: string
              description: Subscription order number
              example: SUB_ABC123456
            merchantSubscriptionOrderNo:
              type: string
              description: Merchant subscription order number
              example: MSUB_20240312_001
            subscriptionLink:
              type: string
              description: >-
                Subscription page link, used for users to initiate subscription
                authorization
              format: uri
              example: https://pay.example.com/subscription/authorize?token=xxxxxx
            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
              example: USDT
            chain:
              type: string
              description: Cryptocurrency network
              example: TRON
            userAddress:
              type: string
              description: User authorized address
            userId:
              type: integer
              format: int64
              description: >-
                User ID; returned in certain integration scenarios; omitted or
                null when not applicable
            authorizedAmount:
              type: string
              description: Authorized amount, the number of tokens users need to authorize
            cryptoAmount:
              type: string
              description: Single deduction amount
            paidCount:
              type: integer
              description: Number of deductions made
              example: 2
            totalPaidAmount:
              type: string
              description: Total amount deducted
            period:
              type: string
              description: Deduction period
              example: ''
            interval:
              type: integer
              description: Deduction interval
              example: 1
            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 (timestamp, milliseconds)
            lastPayTime:
              type: integer
              format: int64
              description: Last deduction time (timestamp, milliseconds)
            promoAmount:
              type: string
              description: First period special price amount
            promoRate:
              type: string
              description: First period special price percentage
            nextPayTime:
              type: integer
              format: int64
              description: Next deduction time (timestamp, milliseconds)
            callbackUrl:
              type: string
              description: Page URL to redirect after successful subscription
              format: uri
            orderStatus:
              type: string
              enum:
                - CREATED
                - AUTHORIZED
                - CONFIRMING
                - TRIAL
                - RUNNING
                - UNPAID
                - COMPLETED
                - CANCELLED
                - CLOSED
                - BLOCKED
              description: >-
                Subscription order status: `CREATED` created, awaiting user
                authorization; `AUTHORIZED` authorized, awaiting first deduction
                or trial start; `CONFIRMING` confirming (awaiting first
                deduction result); `TRIAL` in trial, deduction not started;
                `RUNNING` running; `UNPAID` payment pending (trial ended or
                deduction failed, within retry limit); `COMPLETED` completed;
                `CANCELLED` cancelled; `CLOSED` closed (e.g. deduction failures
                exceeded); `BLOCKED` blocked (funds risk after deduction).
              example: TRIAL
            createTime:
              type: integer
              format: int64
              description: Order creation time (timestamp, milliseconds)
            updateTime:
              type: integer
              format: int64
              description: Order update time (timestamp, milliseconds)
            priceType:
              type: string
              enum:
                - FIX_AMOUNT
                - ACCOUNT_AUTH
              description: >-
                Price type. FIX_AMOUNT: fixed amount. ACCOUNT_AUTH: pay by
                account authorization.
            paymentChannel:
              type: string
              enum:
                - GATEPAY
                - WEB3
              description: >-
                Payment channel. GATEPAY: centralized GatePay payment. WEB3:
                on-chain transaction.
            authTime:
              type: integer
              format: int64
              description: >-
                Time when the user confirmed authorization (timestamp,
                milliseconds)

````