Antom, leading provider of tailored payment solutions

inquireSubscriptionList

POST /v1/subscriptions/inquireSubscriptionList
调用此接口可查询符合特定筛选条件的订阅列表。调用成功后,接口将返回每个订阅的详细信息,包括其状态、计费周期、金额等。

结构

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

入参

merchantAccountId String  

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

更多信息:

  • 最大长度:64 字符

startTimeFrom String  

筛选在指定日期之后开始的订阅。
如果未指定此参数,则默认从请求发起时间的 7 天前开始。

更多信息:

  • 最大长度:32 字符

startTimeTo String  

筛选在指定日期之前开始的订阅。
如果未指定此参数,则默认截止至请求发起的时间。

更多信息:

  • 最大长度:32 字符

statuses Array<String>  

筛选出状态符合下列任意值的订阅:
  • ACTIVE:筛选状态为激活的订阅。
  • CANCELLED:筛选状态为已取消的订阅。
  • TERMINATED:筛选状态为已终止的订阅。
如果未指定此参数,则默认检索状态为 ACTIVE、CANCELLED 和 TERMINATED 的订阅。

更多信息:

  • 最大长度:32 字符
  • 最多可包含元素个数:3

paymentMethodTypes Array<String>  

筛选与支付方式枚举值中任意值匹配的订阅。
如果未指定此参数,默认返回所有支付方式的订阅。

更多信息:

  • 最大长度:64 字符

currencies Array<String>  

筛选出货币类型与 ISO 4217 标准中任意货币代码匹配的订阅。

更多信息:

  • 最大长度:3 字符

periodTypes Array<String>  

筛选订阅周期类型与下列任意值匹配的订阅:
  • DAY:表示订阅周期以天为单位。
  • WEEK:表示订阅周期以周为单位。
  • MONTH:表示订阅周期以月为单位。
  • YEAR:表示订阅周期以年为单位。
如果未指定此参数,则默认返回所有周期类型的订阅。

更多信息:

  • 最大长度:20 字符
  • 最多可包含元素个数:4

currentPage Integer  

当前页码。
如果未指定此参数,则默认检索首页的所有订阅。

更多信息:

  • 值范围: 1 - 2147483647

pageSize Integer  

每页包含的条目数。
如果未指定此参数,则默认每页显示 10 条信息。

更多信息:

  • 值范围: 1 - 100

出参

result Result  REQUIRED

接口调用的结果。

subscriptions Array<SubscriptionInfo>  REQUIRED

符合条件的订阅列表。

paginator Paginator  REQUIRED

分页信息。
API Explorer

请求

URL
Method
POST
json
{
  "merchantAccountId": "2188234232",
  "startTimeFrom": "2026-01-07T14:32:28+08:00",
  "startTimeTo": "2026-01-17T14:32:28+08:00",
  "statuses": [
    "ACTIVE",
    "CANCELLED",
    "TERMINATED"
  ],
  "paymentMethodTypes": [
    "GCASH",
    "CARD"
  ],
  "currencies": [
    "PHP",
    "USD",
    "SGD"
  ],
  "periodTypes": [
    "WEEK"
  ],
  "currentPage": 1,
  "pageSize": 10
}

响应

json
{
  "result": {
    "resultStatus": "S",
    "resultCode": "SUCCESS",
    "resultMessage": "success"
  },
  "subscriptions": [
    {
      "subscriptionId": "20251216190000000000000010001803095",
      "status": "ACTIVE",
      "periodType": "WEEK",
      "periodCount": 1,
      "paymentMethod": {
        "paymentMethodType": "GCASH"
      },
      "currentPeriodStartTime": "2026-11-07T14:32:28+08:00",
      "currentPeriodEndTime": "2026-11-14T14:32:28+08:00",
      "paymentAmount": {
        "currency": "PHP",
        "value": "10000"
      },
      "subscriptionStartTime": "2026-11-01T14:32:28+08:00",
      "subscriptionEndTime": "2026-12-31T14:32:28+08:00",
      "description": "Weekly Subscription",
      "currentPhaseNo": 1,
      "trialPlan": {
        "trialEndTime": "2026-11-07T14:32:28+08:00",
        "freeTrialDays": 0,
        "trialPhases": [
          {
            "phaseNo": 1,
            "trialAmount": {
              "currency": "PHP",
              "value": "6900"
            }
          }
        ]
      },
      "lastUpdateTime": "2026-11-08T14:32:28+08:00"
    },
    {
      "subscriptionId": "20251216190000000000000010001803096",
      "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": "PHP",
        "value": "10000"
      },
      "subscriptionStartTime": "2026-11-01T14:32:28+08:00",
      "subscriptionEndTime": "2026-12-31T14:32:28+08:00",
      "description": "Weekly subscription pro",
      "currentPhaseNo": 1,
      "trialPlan": {
        "trialEndTime": "2026-11-07T14:32:28+08:00",
        "freeTrialDays": 0,
        "trialPhases": [
          {
            "phaseNo": 1,
            "trialAmount": {
              "currency": "PHP",
              "value": "6900"
            }
          }
        ]
      },
      "lastUpdateTime": "2026-11-08T14:32:28+08:00",
      "relatedSubscriptionId": "20251216190000000000000010001803099"
    }
  ],
  "paginator": {
    "currentPage": 1,
    "pageSize": 10,
    "totalPage": 1,
    "totalCount": 2
  }
}

结果码

结果码值结果码信息行动建议
SUCCESSS成功。
接口调用成功。无需进一步操作。
ACCESS_DENIEDF访问被拒绝。
请咨询 Antom 技术支持以获取详细原因。
PARAM_ILLEGALF缺少必需的参数,或者存在非法参数。例如,非数字输入,无效的日期,或者参数的长度和类型错误。
检查并验证当前接口所需的请求字段(包括头部字段和正文字段)是否正确传递并有效。 
PAYMENT_METHOD_NOT_SUPPORTEDF支付方式不支持。
请尝试其他支付方式,或联系 Antom 技术支持寻求帮助。
CURRENCY_NOT_SUPPORTF币种不支持。
请用其他币种重试。
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 技术支持。