Skip to main content
GET
/
open
/
v1
/
plan
/
list
Query Subscription Plan List
curl --request GET \
  --url https://openplatform.gateapi.io/pay-subscription/open/v1/plan/list \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'
{
  "code": "0",
  "message": "",
  "data": {
    "total": 1,
    "list": [
      {
        "merchantPlanNo": "plan031004",
        "planNo": "63784847096545341",
        "planName": "Plan 01",
        "planDesc": "Plan Description 01",
        "productName": "2",
        "productNo": "2",
        "priceNo": "3",
        "priceName": "Weekly",
        "cryptoCurrency": "USDT",
        "cryptoAmount": "5",
        "period": "WEEK",
        "planStatus": "on",
        "createTime": 1773107374000,
        "updateTime": 1773107374000
      }
    ]
  },
  "success": true
}

​
Overview

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

​
Notes

Headers

​
X-GatePay-Certificate-ClientId
string
required

Merchant client ID, obtained from GatePay platform application

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

​
X-GatePay-Signature
string
required

HMAC-SHA256 signature, used to verify request legitimacy

Example:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

​
X-GatePay-Timestamp
string
required

Timestamp (milliseconds), time difference with server cannot exceed 5 minutes

Example:

"1672905655498"

​
X-GatePay-Nonce
string
required

Random number, used to prevent replay attacks

Example:

"9578"

Query Parameters

​
planStatus
enum<string>

Subscription plan status filter

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

​
productNo
string

Product number filter

Example:

"PROD_ABC123"

​
page
integer<int32>
default:1

Page number, starting from 1, default 1

Required range: x >= 1
Example:

1

​
count
integer<int32>
default:10

Number per page, maximum 100, default 10

Required range: 1 <= x <= 100
Example:

10

Response

200 - application/json

Query subscription plan list successful

​
code
string

Response code, 0 indicates success

Example:

"0"

​
message
string

Response description, empty when successful

Example:

""

​
success
boolean

Whether the request was successful

Example:

true

​
data
object

Response data