Skip to main content
WEBHOOK
subscriptionOrderNotify
{
  "bizId": "82285581939245166",
  "bizStatus": "CANCELLED",
  "bizType": "SUBSCRIPTION_ORDER_STATUS",
  "data": {
    "authorizedAmount": "0.01",
    "chain": "USDC",
    "createTime": 1774942804115,
    "cryptoAmount": "0.01",
    "cryptoCurrency": "USDT",
    "endTime": 1806478803644,
    "interval": 2,
    "lastPayTime": 0,
    "merchantId": "1627288",
    "merchantSubscriptionOrderNo": "4322055233",
    "orderStatus": "CANCELLED",
    "paidCount": 0,
    "paymentChannel": "WEB3",
    "period": "MONTH",
    "planDesc": "hello world subscription plan",
    "planName": "plan001",
    "planNo": "82285581939245065",
    "productName": "test goods",
    "productNo": "79367222528049209",
    "subscriptionOrderNo": "82285581939245166",
    "totalPaidAmount": "0",
    "totalPayCount": 2,
    "trialDays": 0,
    "updateTime": 1775031195787,
    "userAddress": ""
  }
}
{
  "returnCode": "SUCCESS",
  "returnMessage": ""
}

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.

​
Overview

This page documents webhook subscriptionOrderNotify. The full schema, parameters, and examples are rendered from the linked OpenAPI or webhook definition above.

​
Notes

  • This page describes a callback payload sent by GatePay, not a merchant-initiated request.
  • Verify the signature first, then apply idempotent processing before updating business state.
  • For callback guidance organized by business flow, read this page together with the Notification guide.
  • For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

Body

application/json

Subscription order status update notification POST method

​
bizType
string

Business type: SUBSCRIPTION_ORDER_STATUS

​
bizStatus
enum<string>

Business status: subscription order status code; same values as data.orderStatus.

Available options:
CREATED,
AUTHORIZED,
CONFIRMING,
TRIAL,
RUNNING,
UNPAID,
COMPLETED,
CANCELLED,
CLOSED,
BLOCKED
​
data
object

Response

200 - application/json

Return HTTP 200 to indicate callback notification has been received.

​
returnCode
string

Response code, SUCCESS indicates success, FAIL indicates failure

​
returnMessage
string

Response description, empty when successful