inquireSubscription
Call this API to retrieve a subscription using its ID returned by Antom after successfully created. After this API is called successfully, you can obtain detailed information about that subscription, including its status, period, amount.
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
subscriptionId String REQUIRED
The unique ID assigned by Antom to identify a subscription.
More information:
- Maximum length: 64 characters
Response parameters
result Result REQUIRED
Indicates whether this API is called successfully.
subscription SubscriptionInfo
Information about subscription whose ID match with the specified ID in the request.
Request
{
"merchantAccountId": "2188234232",
"subscriptionId": "20251216190000000000000010001803096"
}Response
{
"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
}
}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. |
| SUBSCRIPTION_NOT_EXIST | F | Subscription does not exist. | Retry with another subscriptionId. |
| 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. |
| 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. |
| 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. |