Skip to main content
POST
/
api
/
v1
/
subscription
/
change
Subscription change
curl --request POST \
  --url https://www.waffo.com/api/v1/subscription/change \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriptionRequest": "<string>",
  "originSubscriptionRequest": "ORG_SUB_REQ_001",
  "remainingAmount": 50000,
  "currency": "USD",
  "requestedAt": "2023-11-07T05:31:56Z",
  "notifyUrl": "https://merchant.com/notify",
  "productInfoList": [
    {
      "description": "Premium Monthly Subscription",
      "periodType": "MONTHLY",
      "amount": 100000,
      "periodInterval": 1,
      "numberOfPeriod": 12,
      "trialPeriodAmount": 0,
      "numberOfTrialPeriod": 1,
      "trialPeriodType": "MONTHLY",
      "trialPeriodInterval": 1
    }
  ],
  "merchantInfo": {
    "merchantId": "M0001",
    "subMerchantId": "<string>"
  },
  "userInfo": {
    "userId": "USER001",
    "userEmail": "user@example.com",
    "userTerminal": "<string>",
    "userPhone": "+62-08990013157",
    "userFirstName": "<string>",
    "userLastName": "<string>",
    "userCreatedAt": "2023-11-07T05:31:56Z"
  },
  "goodsInfo": {
    "goodsId": "GOODS001",
    "goodsName": "Premium Subscription Plan",
    "goodsCategory": "<string>",
    "goodsUrl": "<string>",
    "appName": "<string>",
    "skuName": "<string>",
    "goodsUniquePrice": "<string>",
    "goodsQuantity": 123
  },
  "paymentInfo": {
    "productName": "SUBSCRIPTION",
    "payMethodType": "<string>",
    "payMethodName": "<string>",
    "payMethodProperties": "<string>",
    "payMethodUserAccountType": "<string>",
    "payMethodUserAccountNo": "<string>",
    "payMethodUserAccessToken": "<string>",
    "cashierAppearance": "<string>"
  },
  "merchantSubscriptionId": "<string>",
  "userCurrency": "<string>",
  "successRedirectUrl": "<string>",
  "failedRedirectUrl": "<string>",
  "cancelRedirectUrl": "<string>",
  "subscriptionManagementUrl": "<string>",
  "extendInfo": "<string>",
  "orderExpiredAt": "2023-11-07T05:31:56Z",
  "addressInfo": {
    "address": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postcode": "<string>",
    "addressCountryCode": "<string>"
  },
  "brandInfo": {
    "cashierLogoUrl": "<string>",
    "cashierDisplayName": "<string>",
    "cashierProductImageUrl": "<string>"
  },
  "riskData": {
    "userType": "<string>",
    "userCategory": "<string>",
    "userLegalName": "<string>",
    "userDisplayName": "<string>",
    "userRegistrationIp": "<string>",
    "userLastSeenIp": "<string>",
    "userIsNew": "<string>",
    "userIsFirstPurchase": "<string>"
  }
}
'
{
  "code": "<string>",
  "msg": "<string>",
  "data": {
    "subscriptionId": "<string>",
    "originSubscriptionRequest": "<string>",
    "subscriptionRequest": "<string>",
    "merchantSubscriptionId": "<string>",
    "subscriptionChangeStatus": "<string>",
    "subscriptionAction": "<string>"
  }
}

Body

application/json

Subscription change request

​
subscriptionRequest
string
required

New subscription request id sent from Merchant. It will also be used for idempotent check.

Maximum string length: 32
​
originSubscriptionRequest
string
required

Original subscription request id that needs to be changed

Maximum string length: 32
Example:

"ORG_SUB_REQ_001"

​
remainingAmount
string
required

Remaining amount from the original subscription to be applied to the new subscription

Maximum string length: 24
Example:

50000

​
currency
string
required

Subscription currency, for example USD

Maximum string length: 12
Example:

"USD"

​
requestedAt
string<date-time>
required

Merchant-side request time

​
notifyUrl
string
required

The callback address to notify the merchant after the subscription change is completed / failed

Maximum string length: 256
Example:

"https://merchant.com/notify"

​
productInfoList
object[]
required

New subscription product information list

Minimum array length: 1
​
merchantInfo
object
required

Merchant info

​
userInfo
object
required

User info

​
goodsInfo
object
required

Merchant goods information

​
paymentInfo
object
required

Payment information

​
merchantSubscriptionId
string

New merchant subscription plan ID assigned to this user

Maximum string length: 64
​
userCurrency
string

User payment currency. This is needed when merchant order currency is NOT the same as user payment currency

Maximum string length: 12
​
successRedirectUrl
string

The address of the merchant page to redirect to after successful subscription change. If no value is provided, it will stay on the cashier page after successful payment.

Maximum string length: 256
​
failedRedirectUrl
string

The address of the merchant page to which the payment pre-verification fails, or the redirection after the payment fails. If no value is provided, it will stay on the cashier page after the payment fails

Maximum string length: 256
​
cancelRedirectUrl
string

User will be redirected to this page if user choose to cancel and not continue the payment

Maximum string length: 512
​
subscriptionManagementUrl
string

It refers to the subscription management page for users on the merchant side.

Maximum string length: 256
​
extendInfo
string

Reserved. Json format e.g. {"key1":"value1", "key2":"value2"}

Maximum string length: 256
​
orderExpiredAt
string<date-time>

The order expiry time set by merchant. User is required to input payment data on Waffo cashier page prior to merchant's order expiry time. If not provided, the default is 4 hours

​
addressInfo
object

Address Information

​
brandInfo
object

Brand display information for cashier

​
riskData
object

Risk data for compliance and risk management

Response

200 - */*

OK

response data

​
code
string
​
msg
string
​
data
object

Subscription change response