Antom, leading provider of tailored payment solutions

inquireSubscription

POST /v1/subscriptions/inquireSubscription
调用此接口可通过订阅创建成功后 Antom 返回的 ID 来获取订阅详情。成功调用此接口后,您可获得该订阅的详细信息,包括其状态、周期和金额等信息。

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息,有关报文头的结构信息,请参阅:
注意:将每个参数(除数组外)的数据类型设置为字符串,即参数的值必须使用英文双引号(" ")包裹起来。例如:
  • 如果参数的数据类型为整数属性,且其值为 20,设置为 "20"。
  • 如果参数的数据类型为布尔属性,且其值为 true,设置为 "true"。

入参

merchantAccountId String  

用于标识商户账户的专属 ID。

更多信息:

  • 最大长度:64 字符

subscriptionId String  REQUIRED

Antom 为识别订阅而分配的专属 ID。

更多信息:

  • 最大长度:64 字符

出参

result Result  REQUIRED

接口调用的结果。

subscription SubscriptionInfo  

符合条件的订阅列表。
API Explorer

请求

URL
Method
POST
json
{
  "merchantAccountId": "2188234232",
  "subscriptionId": "20251216190000000000000010001803096"
}

响应

json
{
  "result": {
    "resultStatus": "S",
    "resultCode": "SUCCESS",
    "resultMessage": "success"
  },
  "subscription": {
    "subscriptionId": "20251216190000000000000010001803095",
    "status": "ACTIVE",
    "periodType": "WEEK",
    "periodCount": 1,
    "paymentMethod": {
      "paymentMethodType": "CARD",
      "cardBrand": "VISA"
    },
    "currentPeriodStartTime": "2026-11-07T14:32:28+08:00",
    "currentPeriodEndTime": "2026-11-14T14:32:28+08:00",
    "paymentAmount": {
      "currency": "USD",
      "value": "10000"
    },
    "subscriptionStartTime": "2026-11-01T14:32:28+08:00",
    "subscriptionEndTime": "2026-12-31T14:32:28+08:00",
    "description": "Pro weekly subscription",
    "currentPhaseNo": 1,
    "trialPlan": {
      "trialEndTime": "2026-11-07T14:32:28+08:00",
      "freeTrialDays": 0,
      "trialPhases": [
        {
          "phaseNo": 1,
          "trialAmount": {
            "currency": "USD",
            "value": "6900"
          }
        }
      ]
    },
    "lastUpdateTime": "2026-11-08T14:32:28+08:00",
    "relatedSubscriptionId": null
  }
}

结果码

结果码值结果码信息行动建议
SUCCESSS成功。
接口调用成功。无需进一步操作。
ACCESS_DENIEDF访问被拒绝。
请咨询 Antom 技术支持以获取详细原因。
SUBSCRIPTION_NOT_EXISTF订阅不存在。
请尝试使用其他 subscriptionId 重试
PARAM_ILLEGALF缺少必需的参数,或者存在非法参数。例如,非数字输入,无效的日期,或者参数的长度和类型错误。
检查并验证当前接口所需的请求字段(包括头部字段和正文字段)是否正确传递并有效。 
UNKNOWN_EXCEPTIONU由于未知原因,接口调用失败。
再次调用接口解决问题。如果问题未解决,请联系 Antom 技术支持。
INVALID_APIF调用的接口无效或未激活。
请咨询 Antom 技术支持以解决问题。
KEY_NOT_FOUNDF未找到 Antom 或商户的私钥或公钥。
检查私钥或公钥是否存在。如果不存在,请在 Antom Dashboard 中上传私钥。
NO_INTERFACE_DEFF接口未定义。
请检查 URL 是否正确,具体端点请参考接口文档。
PROCESS_FAILF发生了常见的业务失败。
获取 Antom 技术支持前请勿重试。
SYSTEM_ERRORF发生系统错误。
详细原因请咨询 Antom 技术支持。 
REQUEST_TRAFFIC_EXCEED_LIMITU请求流量超过了限制。
再次调用接口解决问题。如果问题未解决,请联系 Antom 技术支持。