Update Subscription
curl --request POST \
--url https://api.unibee.dev/merchant/subscription/update_submit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"newPlanId": 123,
"quantity": 123,
"addonParams": [
{
"addonPlanId": 123,
"quantity": 123
}
],
"applyPromoCredit": true,
"applyPromoCreditAmount": 123,
"cancelUrl": "<string>",
"confirmCurrency": "<string>",
"confirmTotalAmount": 123,
"currency": "<string>",
"discount": {
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"endTime": 123,
"metadata": {},
"recurring": true
},
"discountCode": "<string>",
"effectImmediate": 123,
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"manualPayment": true,
"metadata": {},
"paymentUIMode": "<string>",
"productData": {
"description": "<string>",
"name": "<string>"
},
"prorationDate": 123,
"returnUrl": "<string>",
"subscriptionId": "<string>",
"taxPercentage": 123,
"userId": 123
}
'import requests
url = "https://api.unibee.dev/merchant/subscription/update_submit"
payload = {
"newPlanId": 123,
"quantity": 123,
"addonParams": [
{
"addonPlanId": 123,
"quantity": 123
}
],
"applyPromoCredit": True,
"applyPromoCreditAmount": 123,
"cancelUrl": "<string>",
"confirmCurrency": "<string>",
"confirmTotalAmount": 123,
"currency": "<string>",
"discount": {
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"endTime": 123,
"metadata": {},
"recurring": True
},
"discountCode": "<string>",
"effectImmediate": 123,
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"manualPayment": True,
"metadata": {},
"paymentUIMode": "<string>",
"productData": {
"description": "<string>",
"name": "<string>"
},
"prorationDate": 123,
"returnUrl": "<string>",
"subscriptionId": "<string>",
"taxPercentage": 123,
"userId": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
newPlanId: 123,
quantity: 123,
addonParams: [{addonPlanId: 123, quantity: 123}],
applyPromoCredit: true,
applyPromoCreditAmount: 123,
cancelUrl: '<string>',
confirmCurrency: '<string>',
confirmTotalAmount: 123,
currency: '<string>',
discount: {
cycleLimit: 123,
discountAmount: 123,
discountPercentage: 123,
endTime: 123,
metadata: {},
recurring: true
},
discountCode: '<string>',
effectImmediate: 123,
gatewayId: 123,
gatewayPaymentType: '<string>',
manualPayment: true,
metadata: {},
paymentUIMode: '<string>',
productData: {description: '<string>', name: '<string>'},
prorationDate: 123,
returnUrl: '<string>',
subscriptionId: '<string>',
taxPercentage: 123,
userId: 123
})
};
fetch('https://api.unibee.dev/merchant/subscription/update_submit', 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.unibee.dev/merchant/subscription/update_submit",
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([
'newPlanId' => 123,
'quantity' => 123,
'addonParams' => [
[
'addonPlanId' => 123,
'quantity' => 123
]
],
'applyPromoCredit' => true,
'applyPromoCreditAmount' => 123,
'cancelUrl' => '<string>',
'confirmCurrency' => '<string>',
'confirmTotalAmount' => 123,
'currency' => '<string>',
'discount' => [
'cycleLimit' => 123,
'discountAmount' => 123,
'discountPercentage' => 123,
'endTime' => 123,
'metadata' => [
],
'recurring' => true
],
'discountCode' => '<string>',
'effectImmediate' => 123,
'gatewayId' => 123,
'gatewayPaymentType' => '<string>',
'manualPayment' => true,
'metadata' => [
],
'paymentUIMode' => '<string>',
'productData' => [
'description' => '<string>',
'name' => '<string>'
],
'prorationDate' => 123,
'returnUrl' => '<string>',
'subscriptionId' => '<string>',
'taxPercentage' => 123,
'userId' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.unibee.dev/merchant/subscription/update_submit"
payload := strings.NewReader("{\n \"newPlanId\": 123,\n \"quantity\": 123,\n \"addonParams\": [\n {\n \"addonPlanId\": 123,\n \"quantity\": 123\n }\n ],\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"cancelUrl\": \"<string>\",\n \"confirmCurrency\": \"<string>\",\n \"confirmTotalAmount\": 123,\n \"currency\": \"<string>\",\n \"discount\": {\n \"cycleLimit\": 123,\n \"discountAmount\": 123,\n \"discountPercentage\": 123,\n \"endTime\": 123,\n \"metadata\": {},\n \"recurring\": true\n },\n \"discountCode\": \"<string>\",\n \"effectImmediate\": 123,\n \"gatewayId\": 123,\n \"gatewayPaymentType\": \"<string>\",\n \"manualPayment\": true,\n \"metadata\": {},\n \"paymentUIMode\": \"<string>\",\n \"productData\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"prorationDate\": 123,\n \"returnUrl\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"taxPercentage\": 123,\n \"userId\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.unibee.dev/merchant/subscription/update_submit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"newPlanId\": 123,\n \"quantity\": 123,\n \"addonParams\": [\n {\n \"addonPlanId\": 123,\n \"quantity\": 123\n }\n ],\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"cancelUrl\": \"<string>\",\n \"confirmCurrency\": \"<string>\",\n \"confirmTotalAmount\": 123,\n \"currency\": \"<string>\",\n \"discount\": {\n \"cycleLimit\": 123,\n \"discountAmount\": 123,\n \"discountPercentage\": 123,\n \"endTime\": 123,\n \"metadata\": {},\n \"recurring\": true\n },\n \"discountCode\": \"<string>\",\n \"effectImmediate\": 123,\n \"gatewayId\": 123,\n \"gatewayPaymentType\": \"<string>\",\n \"manualPayment\": true,\n \"metadata\": {},\n \"paymentUIMode\": \"<string>\",\n \"productData\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"prorationDate\": 123,\n \"returnUrl\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"taxPercentage\": 123,\n \"userId\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unibee.dev/merchant/subscription/update_submit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"newPlanId\": 123,\n \"quantity\": 123,\n \"addonParams\": [\n {\n \"addonPlanId\": 123,\n \"quantity\": 123\n }\n ],\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"cancelUrl\": \"<string>\",\n \"confirmCurrency\": \"<string>\",\n \"confirmTotalAmount\": 123,\n \"currency\": \"<string>\",\n \"discount\": {\n \"cycleLimit\": 123,\n \"discountAmount\": 123,\n \"discountPercentage\": 123,\n \"endTime\": 123,\n \"metadata\": {},\n \"recurring\": true\n },\n \"discountCode\": \"<string>\",\n \"effectImmediate\": 123,\n \"gatewayId\": 123,\n \"gatewayPaymentType\": \"<string>\",\n \"manualPayment\": true,\n \"metadata\": {},\n \"paymentUIMode\": \"<string>\",\n \"productData\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"prorationDate\": 123,\n \"returnUrl\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"taxPercentage\": 123,\n \"userId\": 123\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"data": {
"action": {},
"invoiceId": "<string>",
"link": "<string>",
"note": "<string>",
"paid": true,
"paymentId": "<string>",
"subscriptionPendingUpdate": {
"addonData": "<string>",
"addons": [
{
"addonPlan": {
"amount": 123,
"autoChargeConfig": {
"autoChargeLeadTime": 123,
"autoChargeMaxRetryCount": 123,
"autoChargeRetryInterval": 123,
"incompleteExpireTime": 123
},
"autoUpgradePlanId": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutTemplateId": 123,
"checkoutUrl": "<string>",
"compareAtAmount": 123,
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123,
"fixedAmount": 123
}
],
"multiTrials": [
{
"intervalCount": 123,
"intervalUnit": "<string>",
"metadata": {},
"name": "<string>",
"trialCompareAtPrice": 123,
"trialDuration": 123,
"trialPrice": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"quantity": 123
}
],
"amount": 123,
"currency": "<string>",
"effectImmediate": 123,
"effectTime": 123,
"gatewayId": 123,
"gmtCreate": "<string>",
"gmtModify": "<string>",
"invoiceId": "<string>",
"link": "<string>",
"merchantId": 123,
"merchantMember": {
"createTime": 123,
"email": "<string>",
"firstName": "<string>",
"id": 123,
"isOwner": true,
"lastName": "<string>",
"merchantId": 123
},
"metadata": {},
"name": "<string>",
"note": "<string>",
"paid": 123,
"pendingUpdateId": "<string>",
"plan": {
"amount": 123,
"autoChargeConfig": {
"autoChargeLeadTime": 123,
"autoChargeMaxRetryCount": 123,
"autoChargeRetryInterval": 123,
"incompleteExpireTime": 123
},
"autoUpgradePlanId": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutTemplateId": 123,
"checkoutUrl": "<string>",
"compareAtAmount": 123,
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123,
"fixedAmount": 123
}
],
"multiTrials": [
{
"intervalCount": 123,
"intervalUnit": "<string>",
"metadata": {},
"name": "<string>",
"trialCompareAtPrice": 123,
"trialDuration": 123,
"trialPrice": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"planId": 123,
"prorationAmount": 123,
"quantity": 123,
"status": 123,
"subscriptionId": "<string>",
"updateAddonData": "<string>",
"updateAddons": [
{
"addonPlan": {
"amount": 123,
"autoChargeConfig": {
"autoChargeLeadTime": 123,
"autoChargeMaxRetryCount": 123,
"autoChargeRetryInterval": 123,
"incompleteExpireTime": 123
},
"autoUpgradePlanId": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutTemplateId": 123,
"checkoutUrl": "<string>",
"compareAtAmount": 123,
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123,
"fixedAmount": 123
}
],
"multiTrials": [
{
"intervalCount": 123,
"intervalUnit": "<string>",
"metadata": {},
"name": "<string>",
"trialCompareAtPrice": 123,
"trialDuration": 123,
"trialPrice": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"quantity": 123
}
],
"updateAmount": 123,
"updateCurrency": "<string>",
"updatePlan": {
"amount": 123,
"autoChargeConfig": {
"autoChargeLeadTime": 123,
"autoChargeMaxRetryCount": 123,
"autoChargeRetryInterval": 123,
"incompleteExpireTime": 123
},
"autoUpgradePlanId": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutTemplateId": 123,
"checkoutUrl": "<string>",
"compareAtAmount": 123,
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123,
"fixedAmount": 123
}
],
"multiTrials": [
{
"intervalCount": 123,
"intervalUnit": "<string>",
"metadata": {},
"name": "<string>",
"trialCompareAtPrice": 123,
"trialDuration": 123,
"trialPrice": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"updatePlanId": 123,
"updateQuantity": 123,
"userId": 123
}
},
"merchantId": 123,
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Subscription Update
Update Subscription
POST
/
merchant
/
subscription
/
update_submit
Update Subscription
curl --request POST \
--url https://api.unibee.dev/merchant/subscription/update_submit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"newPlanId": 123,
"quantity": 123,
"addonParams": [
{
"addonPlanId": 123,
"quantity": 123
}
],
"applyPromoCredit": true,
"applyPromoCreditAmount": 123,
"cancelUrl": "<string>",
"confirmCurrency": "<string>",
"confirmTotalAmount": 123,
"currency": "<string>",
"discount": {
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"endTime": 123,
"metadata": {},
"recurring": true
},
"discountCode": "<string>",
"effectImmediate": 123,
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"manualPayment": true,
"metadata": {},
"paymentUIMode": "<string>",
"productData": {
"description": "<string>",
"name": "<string>"
},
"prorationDate": 123,
"returnUrl": "<string>",
"subscriptionId": "<string>",
"taxPercentage": 123,
"userId": 123
}
'import requests
url = "https://api.unibee.dev/merchant/subscription/update_submit"
payload = {
"newPlanId": 123,
"quantity": 123,
"addonParams": [
{
"addonPlanId": 123,
"quantity": 123
}
],
"applyPromoCredit": True,
"applyPromoCreditAmount": 123,
"cancelUrl": "<string>",
"confirmCurrency": "<string>",
"confirmTotalAmount": 123,
"currency": "<string>",
"discount": {
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"endTime": 123,
"metadata": {},
"recurring": True
},
"discountCode": "<string>",
"effectImmediate": 123,
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"manualPayment": True,
"metadata": {},
"paymentUIMode": "<string>",
"productData": {
"description": "<string>",
"name": "<string>"
},
"prorationDate": 123,
"returnUrl": "<string>",
"subscriptionId": "<string>",
"taxPercentage": 123,
"userId": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
newPlanId: 123,
quantity: 123,
addonParams: [{addonPlanId: 123, quantity: 123}],
applyPromoCredit: true,
applyPromoCreditAmount: 123,
cancelUrl: '<string>',
confirmCurrency: '<string>',
confirmTotalAmount: 123,
currency: '<string>',
discount: {
cycleLimit: 123,
discountAmount: 123,
discountPercentage: 123,
endTime: 123,
metadata: {},
recurring: true
},
discountCode: '<string>',
effectImmediate: 123,
gatewayId: 123,
gatewayPaymentType: '<string>',
manualPayment: true,
metadata: {},
paymentUIMode: '<string>',
productData: {description: '<string>', name: '<string>'},
prorationDate: 123,
returnUrl: '<string>',
subscriptionId: '<string>',
taxPercentage: 123,
userId: 123
})
};
fetch('https://api.unibee.dev/merchant/subscription/update_submit', 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.unibee.dev/merchant/subscription/update_submit",
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([
'newPlanId' => 123,
'quantity' => 123,
'addonParams' => [
[
'addonPlanId' => 123,
'quantity' => 123
]
],
'applyPromoCredit' => true,
'applyPromoCreditAmount' => 123,
'cancelUrl' => '<string>',
'confirmCurrency' => '<string>',
'confirmTotalAmount' => 123,
'currency' => '<string>',
'discount' => [
'cycleLimit' => 123,
'discountAmount' => 123,
'discountPercentage' => 123,
'endTime' => 123,
'metadata' => [
],
'recurring' => true
],
'discountCode' => '<string>',
'effectImmediate' => 123,
'gatewayId' => 123,
'gatewayPaymentType' => '<string>',
'manualPayment' => true,
'metadata' => [
],
'paymentUIMode' => '<string>',
'productData' => [
'description' => '<string>',
'name' => '<string>'
],
'prorationDate' => 123,
'returnUrl' => '<string>',
'subscriptionId' => '<string>',
'taxPercentage' => 123,
'userId' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.unibee.dev/merchant/subscription/update_submit"
payload := strings.NewReader("{\n \"newPlanId\": 123,\n \"quantity\": 123,\n \"addonParams\": [\n {\n \"addonPlanId\": 123,\n \"quantity\": 123\n }\n ],\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"cancelUrl\": \"<string>\",\n \"confirmCurrency\": \"<string>\",\n \"confirmTotalAmount\": 123,\n \"currency\": \"<string>\",\n \"discount\": {\n \"cycleLimit\": 123,\n \"discountAmount\": 123,\n \"discountPercentage\": 123,\n \"endTime\": 123,\n \"metadata\": {},\n \"recurring\": true\n },\n \"discountCode\": \"<string>\",\n \"effectImmediate\": 123,\n \"gatewayId\": 123,\n \"gatewayPaymentType\": \"<string>\",\n \"manualPayment\": true,\n \"metadata\": {},\n \"paymentUIMode\": \"<string>\",\n \"productData\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"prorationDate\": 123,\n \"returnUrl\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"taxPercentage\": 123,\n \"userId\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.unibee.dev/merchant/subscription/update_submit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"newPlanId\": 123,\n \"quantity\": 123,\n \"addonParams\": [\n {\n \"addonPlanId\": 123,\n \"quantity\": 123\n }\n ],\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"cancelUrl\": \"<string>\",\n \"confirmCurrency\": \"<string>\",\n \"confirmTotalAmount\": 123,\n \"currency\": \"<string>\",\n \"discount\": {\n \"cycleLimit\": 123,\n \"discountAmount\": 123,\n \"discountPercentage\": 123,\n \"endTime\": 123,\n \"metadata\": {},\n \"recurring\": true\n },\n \"discountCode\": \"<string>\",\n \"effectImmediate\": 123,\n \"gatewayId\": 123,\n \"gatewayPaymentType\": \"<string>\",\n \"manualPayment\": true,\n \"metadata\": {},\n \"paymentUIMode\": \"<string>\",\n \"productData\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"prorationDate\": 123,\n \"returnUrl\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"taxPercentage\": 123,\n \"userId\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unibee.dev/merchant/subscription/update_submit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"newPlanId\": 123,\n \"quantity\": 123,\n \"addonParams\": [\n {\n \"addonPlanId\": 123,\n \"quantity\": 123\n }\n ],\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"cancelUrl\": \"<string>\",\n \"confirmCurrency\": \"<string>\",\n \"confirmTotalAmount\": 123,\n \"currency\": \"<string>\",\n \"discount\": {\n \"cycleLimit\": 123,\n \"discountAmount\": 123,\n \"discountPercentage\": 123,\n \"endTime\": 123,\n \"metadata\": {},\n \"recurring\": true\n },\n \"discountCode\": \"<string>\",\n \"effectImmediate\": 123,\n \"gatewayId\": 123,\n \"gatewayPaymentType\": \"<string>\",\n \"manualPayment\": true,\n \"metadata\": {},\n \"paymentUIMode\": \"<string>\",\n \"productData\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"prorationDate\": 123,\n \"returnUrl\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"taxPercentage\": 123,\n \"userId\": 123\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"data": {
"action": {},
"invoiceId": "<string>",
"link": "<string>",
"note": "<string>",
"paid": true,
"paymentId": "<string>",
"subscriptionPendingUpdate": {
"addonData": "<string>",
"addons": [
{
"addonPlan": {
"amount": 123,
"autoChargeConfig": {
"autoChargeLeadTime": 123,
"autoChargeMaxRetryCount": 123,
"autoChargeRetryInterval": 123,
"incompleteExpireTime": 123
},
"autoUpgradePlanId": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutTemplateId": 123,
"checkoutUrl": "<string>",
"compareAtAmount": 123,
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123,
"fixedAmount": 123
}
],
"multiTrials": [
{
"intervalCount": 123,
"intervalUnit": "<string>",
"metadata": {},
"name": "<string>",
"trialCompareAtPrice": 123,
"trialDuration": 123,
"trialPrice": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"quantity": 123
}
],
"amount": 123,
"currency": "<string>",
"effectImmediate": 123,
"effectTime": 123,
"gatewayId": 123,
"gmtCreate": "<string>",
"gmtModify": "<string>",
"invoiceId": "<string>",
"link": "<string>",
"merchantId": 123,
"merchantMember": {
"createTime": 123,
"email": "<string>",
"firstName": "<string>",
"id": 123,
"isOwner": true,
"lastName": "<string>",
"merchantId": 123
},
"metadata": {},
"name": "<string>",
"note": "<string>",
"paid": 123,
"pendingUpdateId": "<string>",
"plan": {
"amount": 123,
"autoChargeConfig": {
"autoChargeLeadTime": 123,
"autoChargeMaxRetryCount": 123,
"autoChargeRetryInterval": 123,
"incompleteExpireTime": 123
},
"autoUpgradePlanId": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutTemplateId": 123,
"checkoutUrl": "<string>",
"compareAtAmount": 123,
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123,
"fixedAmount": 123
}
],
"multiTrials": [
{
"intervalCount": 123,
"intervalUnit": "<string>",
"metadata": {},
"name": "<string>",
"trialCompareAtPrice": 123,
"trialDuration": 123,
"trialPrice": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"planId": 123,
"prorationAmount": 123,
"quantity": 123,
"status": 123,
"subscriptionId": "<string>",
"updateAddonData": "<string>",
"updateAddons": [
{
"addonPlan": {
"amount": 123,
"autoChargeConfig": {
"autoChargeLeadTime": 123,
"autoChargeMaxRetryCount": 123,
"autoChargeRetryInterval": 123,
"incompleteExpireTime": 123
},
"autoUpgradePlanId": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutTemplateId": 123,
"checkoutUrl": "<string>",
"compareAtAmount": 123,
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123,
"fixedAmount": 123
}
],
"multiTrials": [
{
"intervalCount": 123,
"intervalUnit": "<string>",
"metadata": {},
"name": "<string>",
"trialCompareAtPrice": 123,
"trialDuration": 123,
"trialPrice": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"quantity": 123
}
],
"updateAmount": 123,
"updateCurrency": "<string>",
"updatePlan": {
"amount": 123,
"autoChargeConfig": {
"autoChargeLeadTime": 123,
"autoChargeMaxRetryCount": 123,
"autoChargeRetryInterval": 123,
"incompleteExpireTime": 123
},
"autoUpgradePlanId": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutTemplateId": 123,
"checkoutUrl": "<string>",
"compareAtAmount": 123,
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123,
"fixedAmount": 123
}
],
"multiTrials": [
{
"intervalCount": 123,
"intervalUnit": "<string>",
"metadata": {},
"name": "<string>",
"trialCompareAtPrice": 123,
"trialDuration": 123,
"trialPrice": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"updatePlanId": 123,
"updateQuantity": 123,
"userId": 123
}
},
"merchantId": 123,
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Endpoint Overview
POSThttps://api.unibee.dev/merchant/subscription/update_submit
Update Subscription
Authorization
All UniBee Merchant API requests require authentication via API key.| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <your_api_key> |
Content-Type | Yes | application/json (for request body) |
Parameters
Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.Request body
| Name | Type | Required | Description |
|---|---|---|---|
addonParams | array | No | Optional. Target addon configuration after the update. |
applyPromoCredit | boolean | No | Optional. Whether to apply available promo credit when creating the update invoice. |
applyPromoCreditAmount | integer | No | Optional. Maximum promo credit amount to apply. If omitted and applyPromoCredit is true, the system auto-computes the usable amount. |
cancelUrl | string | No | Optional. URL to redirect the customer to when the customer cancels or the update payment fails. |
confirmCurrency | string | No | Optional. When provided, represents the expected currency code for the update invoice and must match the value returned from update_preview, otherwise the request is rejected. |
confirmTotalAmount | integer | No | Optional. When provided, represents the expected total amount (in minor units) for the update invoice and must match the value returned from update_preview, otherwise the request is rejected. |
currency | string | No | Optional. Target currency for the updated subscription. If not provided, use current subscription currency. Currency change is not allowed when a proration invoice is required. |
discount | string | No | |
discountCode | string | No | Optional. Discount or coupon code applied to this update. Overrides the subscription’s recurring discount for this invoice. |
effectImmediate | integer | No | Optional. Override for when to apply the plan change: 1 = immediate (current period, proration will be computed if needed), 2 = at next period (no proration in current period). If 0 or omitted, the system uses default rules (immediate for upgrades, merchant configuration for downgrades, and immediate for non-active subscriptions). |
gatewayId | integer | No | Optional. Gateway ID to be used for the invoice generated by this update. If omitted, the subscription’s current gateway is used. |
gatewayPaymentType | string | No | Optional. Payment type for the selected gateway, such as card, wallet, etc. |
manualPayment | boolean | No | Optional. If true, do not create an automatic payment for the update invoice; the invoice will be created in open status for manual collection. |
metadata | object | No | Optional. Custom metadata map that will be stored on the update invoice and subscription pending update record. |
newPlanId | integer | Yes | Required. Target plan ID to switch the subscription to. |
paymentUIMode | string | No | Optional. Checkout UI mode: hosted | embedded | custom. Default is hosted. |
productData | string | No | |
prorationDate | integer | No | Optional. UTC timestamp at which proration should start when effectImmediate = 1. Defaults to current time if not provided. |
quantity | integer | Yes | Required. Target quantity for the subscription after update. |
returnUrl | string | No | Optional. URL to redirect the customer to after the update is completed or payment succeeds. |
subscriptionId | string | No | Optional. SubscriptionId to be upgraded or downgraded. Either subscriptionId or userId must be provided. When userId is used instead of subscriptionId, the only active subscription of that user will be updated. |
taxPercentage | integer | No | Optional. External tax percentage override for the update invoice, in basis points (e.g. 1000 = 10%%). Overrides the subscription taxPercentage when provided. |
userId | integer | No | Optional. UserId associated with the subscription to update. Either subscriptionId or userId must be provided. When subscriptionId is omitted, the system uses this userId to locate the active subscription. |
Request examples
cURL
curl -X POST "https://api.unibee.dev/merchant/subscription/update_submit" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"addonParams": [],
"applyPromoCredit": false,
"applyPromoCreditAmount": 0,
"cancelUrl": "https://example.com",
"confirmCurrency": "",
"confirmTotalAmount": 0,
"currency": "",
"discount": "",
"discountCode": "",
"effectImmediate": 0,
"gatewayId": 0,
"gatewayPaymentType": "",
"manualPayment": false,
"metadata": {},
"newPlanId": 0,
"paymentUIMode": "",
"productData": "",
"prorationDate": 0,
"quantity": 0,
"returnUrl": "https://example.com",
"subscriptionId": "id_example",
"taxPercentage": 0,
"userId": 0
}'
Sandbox
curl -X POST "https://api-sandbox.unibee.top/merchant/subscription/update_submit" \
-H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"addonParams": [],
"applyPromoCredit": false,
"applyPromoCreditAmount": 0,
"cancelUrl": "https://example.com",
"confirmCurrency": "",
"confirmTotalAmount": 0,
"currency": "",
"discount": "",
"discountCode": "",
"effectImmediate": 0,
"gatewayId": 0,
"gatewayPaymentType": "",
"manualPayment": false,
"metadata": {},
"newPlanId": 0,
"paymentUIMode": "",
"productData": "",
"prorationDate": 0,
"quantity": 0,
"returnUrl": "https://example.com",
"subscriptionId": "id_example",
"taxPercentage": 0,
"userId": 0
}'
Response
Success responses return a JSON envelope withcode, data, message, redirect, and requestId. code 0 indicates success.
| Field | Type | Description |
|---|---|---|
code | integer | Response code. 0 = success |
data | object | Response payload |
data.action | object | |
data.invoiceId | string | ID of the invoice generated by this update (proration or next-period invoice, depending on effectImmediate). |
data.link | string | Hosted payment or invoice link. When paid=false and an invoice exists, redirect the customer to this link to complete payment. |
data.note | string | Additional message describing the update result, used for internal or merchant-facing explanations. |
data.paid | boolean | Whether the update invoice has been successfully paid at the time of response. |
data.paymentId | string | ID of the payment created for the update invoice, if any. |
data.subscriptionPendingUpdate | object | |
message | string | Human-readable message |
requestId | string | Request ID for support |
Error handling
| HTTP status | Meaning |
|---|---|
| 400 | Bad request — invalid or missing parameters. Check message in the body. |
| 401 | Unauthorized — missing or invalid API key. |
| 404 | Not found — invalid path or resource. |
| 500 | Server error — retry with backoff. |
code in the response body is non-zero, check message for details. Use requestId when contacting support.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Required. Target plan ID to switch the subscription to.
Required. Target quantity for the subscription after update.
Optional. Target addon configuration after the update.
Show child attributes
Show child attributes
Optional. Whether to apply available promo credit when creating the update invoice.
Optional. Maximum promo credit amount to apply. If omitted and applyPromoCredit is true, the system auto-computes the usable amount.
Optional. URL to redirect the customer to when the customer cancels or the update payment fails.
Optional. When provided, represents the expected currency code for the update invoice and must match the value returned from update_preview, otherwise the request is rejected.
Optional. When provided, represents the expected total amount (in minor units) for the update invoice and must match the value returned from update_preview, otherwise the request is rejected.
Optional. Target currency for the updated subscription. If not provided, use current subscription currency. Currency change is not allowed when a proration invoice is required.
Show child attributes
Show child attributes
Optional. Discount or coupon code applied to this update. Overrides the subscription's recurring discount for this invoice.
Optional. Override for when to apply the plan change: 1 = immediate (current period, proration will be computed if needed), 2 = at next period (no proration in current period). If 0 or omitted, the system uses default rules (immediate for upgrades, merchant configuration for downgrades, and immediate for non-active subscriptions).
Optional. Gateway ID to be used for the invoice generated by this update. If omitted, the subscription's current gateway is used.
Optional. Payment type for the selected gateway, such as card, wallet, etc.
Optional. Defaults to true. If true, do not create an automatic payment for the update invoice; the invoice will be created in open status for manual collection.
Optional. Custom metadata map that will be stored on the update invoice and subscription pending update record.
Show child attributes
Show child attributes
Optional. Checkout UI mode: hosted | embedded | custom. Default is hosted.
Show child attributes
Show child attributes
Optional. UTC timestamp at which proration should start when effectImmediate = 1. Defaults to current time if not provided.
Optional. URL to redirect the customer to after the update is completed or payment succeeds.
Optional. SubscriptionId to be upgraded or downgraded. Either subscriptionId or userId must be provided. When userId is used instead of subscriptionId, the only active subscription of that user will be updated.
Optional. External tax percentage override for the update invoice, in basis points (e.g. 1000 = 10%%). Overrides the subscription taxPercentage when provided.
Optional. UserId associated with the subscription to update. Either subscriptionId or userId must be provided. When subscriptionId is omitted, the system uses this userId to locate the active subscription.