订阅订单查询

用于获取订阅数据，以及查询订阅订单详情。

Content-Type: application/json; charset=UTF-8 ❌
Content-Type: application/json ✅

请求参数

POST

Parameter	Type	Length	Required	Signed	Description
merchantNo	String	20	Yes	Yes	Merchant number assigned by Onerway upon registration, obtained from the Onerway merchant dashboard.
contractId	String	/	No	Yes	Subscription contract ID for subscription-related queries.
sign	String	/	Yes	No	Digital signature string for request verification and security. Please refer to Signature for signature generation method.

响应

Name	Type	Description
respCode	String	Response code from Onerway
respMsg	String	Response message from Onerway
data	Object	Response data. Refer to object data

Data

Name	Type	Description
contractId	String	Subscription contract ID
merchantNo	String	Merchant number assigned by Onerway
merchantCustomerId	String	Unique customer identifier in merchant system
products	String	Product information in JSON format
orderAmount	String	Total amount per billing cycle
orderCurrency	String	Currency for the order amount
expireDate	String	Subscription expiration date
frequencyType	String	Frequency type. See FrequencyTypeEnum
frequencyPoint	String	Frequency value (interval between billing cycles)
cycleCount	String	Total number of billing cycles for the subscription
notificationEmail	String	Email address for subscription notifications
billingCycleAnchor	String	Next billing cycle time
dataStatus	String	Contract data status. See DataStatusEnum
subscriptionStatus	String	Subscription status. See SubscriptionStatusEnum
createTime	String	Time when the subscription was initially created
tokenId	String	Subscription token ID

订阅订单查询请求示例

POST

根据 合同ID 查询订阅：

请求参数

{
  "contractId": "1855041133621940224",
  "merchantNo": "800209",
  "sign": "f4764dc3c6ebdb481f1bbde2bf77085f781bfc1d71210fa0d99527b5c66c5202"
}

响应参数

{
  "respCode": "20000",
  "respMsg": "Success",
  "data": {
    "contractId": "1855041133621940224",
    "merchantNo": "800209",
    "merchantCustomerId": "787c6235-c030-4edf-bac4-86485de63397",
    "products": "[{\"name\":\"Plus-Year\",\"price\":\"180.00\",\"num\":\"1\",\"currency\":\"USD\"}]",
    "orderAmount": "180.00",
    "orderCurrency": "USD",
    "expireDate": "2124-11-09",
    "frequencyType": "D",
    "frequencyPoint": 365,
    "cycleCount": null,
    "notificationEmail": null,
    "billingCycleAnchor": null,
    "dataStatus": "1",
    "subscriptionStatus": "active",
    "createTime": "2024-11-09 08:14:06",
    "tokenId": "24dd360d464054a74e167cbe06235772f5c5c82ff6a12cddf5e9d05861638ae4"
  }
}