inquireSubscription

2026-05-12 01:35

POST /v1/subscriptions/inquireSubscription

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

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息，有关报文头的结构信息，请参阅：

注意：将每个字段（除数组外）的数据类型设置为字符串。这意味字段值必须使用双引号（" "）括起来。例如：
如果字段的数据类型为整数属性，且其值为 20，设置为 "20"。
如果字段的数据类型为布尔属性，且其值为 true，设置为 "true"。

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

更多信息：

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

更多信息：

接口调用的结果。

Show child parameters

符合条件的订阅列表。

Show child parameters

API Explorer

示例代码沙箱运行

URL

Method

POST

请求体

响应体

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