Skip to main content
POST
/
api
/
v1
/
subscription
/
inquiry
Subscription Inquiry
curl --request POST \
  --url https://www.waffo.com/api/v1/subscription/inquiry \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriptionRequest": "<subscriptionRequest>",
  "subscriptionId": "<subscriptionId>",
  "paymentDetails": 1
}
'
{
  "code": "<string>",
  "msg": "<string>",
  "data": {
    "subscriptionRequest": "<string>",
    "merchantSubscriptionId": "<string>",
    "subscriptionId": "<string>",
    "payMethodSubscriptionId": "<string>",
    "subscriptionStatus": "<string>",
    "subscriptionAction": "<string>",
    "currency": "IDR",
    "userCurrency": "<string>",
    "amount": "<string>",
    "productInfo": {
      "description": "<string>",
      "periodType": "<string>",
      "periodInterval": "<string>",
      "numberOfPeriod": "<string>",
      "trialPeriodAmount": "<string>",
      "numberOfTrialPeriod": "<string>",
      "trialPeriodType": "<string>",
      "trialPeriodInterval": "<string>",
      "startDateTime": "<string>",
      "endDateTime": "<string>",
      "nextPaymentDateTime": "<string>",
      "currentPeriod": "<string>"
    },
    "merchantInfo": {
      "merchantId": "<string>",
      "subMerchantId": "<string>"
    },
    "userInfo": {
      "userId": "<string>",
      "userEmail": "<string>",
      "userPhone": "<string>",
      "userFirstName": "<string>",
      "userLastName": "<string>",
      "userCreatedAt": "<string>"
    },
    "paymentInfo": {
      "productName": "<string>",
      "payMethodName": "<string>",
      "payMethodType": "<string>",
      "payMethodProperties": "<string>",
      "payMethodResponse": "<string>",
      "payMethodUserAccountType": "<string>",
      "payMethodUserAccountNo": "<string>",
      "payMethodPublicUid": "<string>",
      "payMethodUserAccessToken": "<string>"
    },
    "requestedAt": "<string>",
    "updatedAt": "<string>",
    "failedReason": "<string>",
    "subscriptionManagementUrl": "<string>",
    "extendInfo": "<string>",
    "paymentDetails": [
      {
        "acquiringOrderId": "<string>",
        "orderCurrency": "<string>",
        "orderAmount": "<string>",
        "orderStatus": "<string>",
        "orderUpdatedAt": "<string>",
        "period": "<string>"
      }
    ],
    "goodsInfo": {
      "goodsId": "<string>",
      "goodsName": "<string>",
      "goodsCategory": "<string>",
      "goodsUrl": "<string>",
      "appName": "<string>",
      "skuName": "<string>",
      "goodsUniquePrice": "<string>",
      "goodsQuantity": 123
    },
    "addressInfo": {
      "address": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postcode": "<string>",
      "addressCountryCode": "<string>"
    }
  }
}

Body

application/json

Provide subscriptionRequest or subscriptionId

subscriptionRequest
string

Merchant subscription plan ID assigned to this user (provide subscriptionRequest or subscriptionId)

Maximum string length: 32
Example:

"<subscriptionRequest>"

subscriptionId
string

Waffo subscription Id (provide subscriptionRequest or subscriptionId)

Maximum string length: 64
Example:

"<subscriptionId>"

paymentDetails
integer<int32>

Indicate if merchant wants to inquiry all the payment details associated with the subscription. Default is 0

  • 0 (meaning payment details are not required)
  • 1 (meaning payment details are required)
Example:

1

Response

200 - */*

OK

response data

code
string
msg
string
data
object