inquireSubscriptionList

2026-08-26 10:35

POST /v1/subscriptions/inquireSubscriptionList

Call this API to query a list of subscriptions that match specific filter conditions. Upon a successful call, the API returns detailed information about each subscription, including its status, billing period, amount, and more.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see：

Note: Set the data type of each parameter (except array) as String. This means that you must use double quotation marks (" ") to enclose the parameter value. Examples:

If the data type of a parameter is Integer and its value is 20, set it as "20".
If the data type of a parameter is Boolean and its value is true, set it as "true".

Request parameters

merchantAccountId String

A unique ID to identify a specific merchant account.

More information:

Maximum length: 64 characters

startTimeFrom String

Filter subscriptions with a start date after the specified date.

Defaults to 7 days prior to the request. if not specified.

More information:

Maximum length: 32 characters

startTimeTo String

Filter subscriptions with a start date before the specified date.

Defaults to the time of the request if not specified.

More information:

Maximum length: 32 characters

statuses Array<String>

Filter subscriptions whose status matches any value in the following list:

ACTIVE: Filter subscriptions that are active.
CANCELLED: Filter subscriptions that are cancelled.
TERMINATED: Filter subscriptions that are terminated.

Defaults to retrieving subscriptions with status in ACTIVE, CANCELLED and TERMINATED if not specified.

More information:

Maximum length: 32 characters
Maximum size: 3 elements

paymentMethodTypes Array<String>

Filter subscriptions whose payment method matches any value in Payment methods.

Defaults to returning subscriptions for all payment methods if not specified.

More information:

Maximum length: 64 characters

currencies Array<String>

Filter subscriptions whose currency matches any value defined by the ISO 4217 standard.

More information:

Maximum length: 3 characters

periodTypes Array<String>

Filter subscriptions whose period type matches any value in the following list:

DAY: Indicates that the subscription period is measured in days.
WEEK: Indicates that the subscription period is measured in weeks.
MONTH: Indicates that the subscription period is measured in months.
YEAR: Indicates that the subscription period is measured in years.

Defaults to returning subscriptions of all period types if not specified.

More information:

Maximum length: 20 characters
Maximum size: 4 elements

currentPage Integer

Current page number.

If not specified, all subscriptions on page 1 are retrieved by default.

More information:

Value range: 1 - 2147483647

pageSize Integer

Page size.

If not specified, a page size of 10 is used by default.

More information:

Value range: 1 - 100

Response parameters

result Result REQUIRED

Indicates whether this API is called successfully.

subscriptions Array<SubscriptionInfo> REQUIRED

List of subscriptions that match the criteria.

paginator Paginator REQUIRED

Pagination information.

API Explorer

Request

URL

Method

POST

{
  "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
}

Response

{
  "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
  }
}

Result/Error codes

Code	Value	Message	Further action
SUCCESS	S	Success.	The interface is called successfully.
ACCESS_DENIED	F	Access is denied.	Contact Antom Technical Support for detailed reasons.
PARAM_ILLEGAL	F	The required parameters are not passed, or illegal parameters exist. For example, a non-numeric input, an invalid date, or the length and type of the parameter are wrong.	Check and verify whether the required request fields (including the header fields and body fields) of the current API are correctly passed and valid.
PAYMENT_METHOD_NOT_SUPPORTED	F	Payment method not support.	Retry with other payment methods, or contact Antom Technical Support for support.
CURRENCY_NOT_SUPPORT	F	The currency is not supported.	Retry with other currencies.
UNKNOWN_EXCEPTION	U	An API call has failed, which is caused by unknown reasons.	Call the interface again to resolve the issue. If not resolved, contact Antom Technical Support.
INVALID_API	F	The called API is invalid or not active.	Contact Antom Technical Support to resolve the issue.
KEY_NOT_FOUND	F	The private key or public key of Antom or the merchant is not found.	Check whether the private key or public key exists. If not, upload the private key in Antom Dashboard.
NO_INTERFACE_DEF	F	API is not defined.	Check whether the URL is correct. Please refer to the endpoint in the API documentation.
PROCESS_FAIL	F	A general business failure occurred.	Do not retry. Human intervention is usually needed. It is recommended that you contact Antom Technical Support to troubleshoot the issue.
SYSTEM_ERROR	F	A system error occurred.	Contact Antom Technical Support for detailed reasons.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	The request traffic exceeds the limit.	Call the interface again to resolve the issue. If not resolved, contact Antom Technical Support.