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

> Query subscription plan details

## Overview

This page documents the `GET /open/v1/plan/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/subscription/planDetail-openapi.json GET /open/v1/plan/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/v1/plan/detail:
    get:
      summary: Query Subscription Plan Detail
      description: Query subscription plan 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/planDetail_planNo'
        - $ref: '#/components/parameters/planDetail_merchantPlanNo'
      responses:
        '200':
          description: Query subscription plan details successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubscriptionPlanResponse'
              examples:
                successResponse:
                  summary: Success Response
                  value:
                    code: '0'
                    message: ''
                    data:
                      merchantPlanNo: plan031004
                      planNo: '63784604430893064'
                      planName: Plan 01
                      planDesc: Plan Description 01
                      merchantId: '10002'
                      productNo: '2'
                      productName: Tencent
                      priceNo: '3'
                      priceName: Weekly
                      cryptoCurrency: USDT
                      cryptoAmount: '5'
                      fiatCurrency: null
                      fiatAmount: '0'
                      period: WEEK
                      interval: 1
                      trialDays: 97
                      totalPayCount: 65
                      endTime: null
                      planStatus: 'on'
                      authorizedAmount: '331.95'
                      promoAmount: '0'
                      promoRate: '0.1'
                      createTime: 1773099791000
                      updateTime: 1773099791000
                    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'
    planDetail_planNo:
      name: planNo
      in: query
      required: false
      description: Platform subscription plan number (choose one with merchantPlanNo)
      schema:
        type: string
        example: '63784604430893064'
    planDetail_merchantPlanNo:
      name: merchantPlanNo
      in: query
      required: false
      description: Merchant subscription plan number (choose one with planNo)
      schema:
        type: string
        example: PLAN_20240101_001
  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
          description: Response data
          properties:
            merchantPlanNo:
              type: string
              description: Merchant subscription plan number
              example: plan031004
            planNo:
              type: string
              description: Platform subscription plan number
              example: '63784604430893064'
            planName:
              type: string
              description: Subscription plan name
              example: Premium Membership Monthly Subscription
            planDesc:
              type: string
              description: Subscription plan description
              example: >-
                Enjoy ad-free experience across the entire site plus exclusive
                multiple privileges
            merchantId:
              type: string
              description: Merchant number who created the subscription plan
              example: M202308150001
            productNo:
              type: string
              description: Associated product number
              example: PROD8899001
            productName:
              type: string
              description: Associated product name
              example: VIP Monthly Subscription Service
            priceNo:
              type: string
              description: Associated price number
              example: PRC445566
            priceName:
              type: string
              description: Associated price name
              example: Basic Monthly Price
            cryptoCurrency:
              type: string
              description: Cryptocurrency type
              example: USDT
            cryptoAmount:
              type: string
              description: Cryptocurrency amount
              example: '9.99'
            fiatCurrency:
              type: string
              description: Fiat currency type
              example: USD
            fiatAmount:
              type: string
              description: Fiat currency amount
              example: '9.99'
            period:
              type: string
              description: Deduction period
              example: MONTH
            interval:
              type: integer
              description: Deduction interval
              example: 1
            trialDays:
              type: integer
              description: Trial days
              example: 7
            totalPayCount:
              type: integer
              description: Total number of deductions
              example: 12
            endTime:
              type: integer
              description: Subscription end time (millisecond timestamp)
              example: 1735660799000
            planStatus:
              type: string
              description: 'Subscription plan status: ACTIVE/INACTIVE'
              example: ACTIVE
            authorizedAmount:
              type: string
              description: Authorized amount, the number of tokens users need to authorize
              example: '100.00'
            promoAmount:
              type: string
              description: First period special price amount
              example: '0.99'
            promoRate:
              type: string
              description: First period special price percentage
              example: '10.00'
            updateTime:
              type: integer
              description: Last update time (millisecond timestamp)
              example: 1704038400000

````