Skip to main content
POST
/
api
/
v1
/
subscription
/
update
Subscription update
curl --request POST \
  --url https://api.example.com/api/v1/subscription/update \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriptionRequest": "<subscriptionRequest>",
  "subscriptionId": "<subscriptionId>",
  "amount": 100,
  "productInfo": {
    "trialPeriodAmount": 0,
    "scheduledAmounts": [
      {
        "period": "<string>",
        "amount": "<string>"
      }
    ]
  }
}
'
import requests

url = "https://api.example.com/api/v1/subscription/update"

payload = {
"subscriptionRequest": "<subscriptionRequest>",
"subscriptionId": "<subscriptionId>",
"amount": 100,
"productInfo": {
"trialPeriodAmount": 0,
"scheduledAmounts": [
{
"period": "<string>",
"amount": "<string>"
}
]
}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
subscriptionRequest: '<subscriptionRequest>',
subscriptionId: '<subscriptionId>',
amount: 100,
productInfo: {
trialPeriodAmount: 0,
scheduledAmounts: [{period: '<string>', amount: '<string>'}]
}
})
};

fetch('https://api.example.com/api/v1/subscription/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/subscription/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subscriptionRequest' => '<subscriptionRequest>',
'subscriptionId' => '<subscriptionId>',
'amount' => 100,
'productInfo' => [
'trialPeriodAmount' => 0,
'scheduledAmounts' => [
[
'period' => '<string>',
'amount' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/v1/subscription/update"

payload := strings.NewReader("{\n \"subscriptionRequest\": \"<subscriptionRequest>\",\n \"subscriptionId\": \"<subscriptionId>\",\n \"amount\": 100,\n \"productInfo\": {\n \"trialPeriodAmount\": 0,\n \"scheduledAmounts\": [\n {\n \"period\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ]\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/subscription/update")
.header("Content-Type", "application/json")
.body("{\n \"subscriptionRequest\": \"<subscriptionRequest>\",\n \"subscriptionId\": \"<subscriptionId>\",\n \"amount\": 100,\n \"productInfo\": {\n \"trialPeriodAmount\": 0,\n \"scheduledAmounts\": [\n {\n \"period\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ]\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/subscription/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"subscriptionRequest\": \"<subscriptionRequest>\",\n \"subscriptionId\": \"<subscriptionId>\",\n \"amount\": 100,\n \"productInfo\": {\n \"trialPeriodAmount\": 0,\n \"scheduledAmounts\": [\n {\n \"period\": \"<string>\",\n \"amount\": \"<string>\"\n }\n ]\n }\n}"

response = http.request(request)
puts response.read_body
{
  "code": 0,
  "msg": "success",
  "data": {
    "subscriptionId": "<string>",
    "subscriptionRequest": "<string>",
    "previousTrialPeriodAmount": "<string>",
    "newTrialPeriodAmount": "<string>",
    "previousAmount": "<string>",
    "newAmount": "<string>",
    "previousScheduledAmounts": [
      {
        "period": "<string>",
        "amount": "<string>"
      }
    ],
    "newScheduledAmounts": [
      {
        "period": "<string>",
        "amount": "<string>"
      }
    ],
    "nextEffectivePeriod": "<string>"
  }
}

Body

application/json

Provide subscriptionRequest or subscriptionId

subscriptionRequest
string

Merchant subscription request ID (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>"

amount
string

Merchant subscription amount, for example 100. At least one of amount, productInfo.trialPeriodAmount, and productInfo.scheduledAmounts must be provided.

Maximum string length: 24
Example:

100

productInfo
object

Subscription product info

Response

200 - */*

OK

response data

code
string
Example:

0

msg
string
Example:

"success"

data
object