New Subscription Onetime Addon Preview
curl --request POST \
--url https://api.unibee.dev/merchant/subscription/new_onetime_addon_preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"addonId": 123,
"quantity": 123,
"applyPromoCredit": true,
"applyPromoCreditAmount": 123,
"currency": "<string>",
"discountAmount": 123,
"discountCode": "<string>",
"discountPercentage": 123,
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"metadata": {},
"subscriptionId": "<string>",
"taxPercentage": 123,
"userId": 123
}
'import requests
url = "https://api.unibee.dev/merchant/subscription/new_onetime_addon_preview"
payload = {
"addonId": 123,
"quantity": 123,
"applyPromoCredit": True,
"applyPromoCreditAmount": 123,
"currency": "<string>",
"discountAmount": 123,
"discountCode": "<string>",
"discountPercentage": 123,
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"metadata": {},
"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({
addonId: 123,
quantity: 123,
applyPromoCredit: true,
applyPromoCreditAmount: 123,
currency: '<string>',
discountAmount: 123,
discountCode: '<string>',
discountPercentage: 123,
gatewayId: 123,
gatewayPaymentType: '<string>',
metadata: {},
subscriptionId: '<string>',
taxPercentage: 123,
userId: 123
})
};
fetch('https://api.unibee.dev/merchant/subscription/new_onetime_addon_preview', 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/new_onetime_addon_preview",
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([
'addonId' => 123,
'quantity' => 123,
'applyPromoCredit' => true,
'applyPromoCreditAmount' => 123,
'currency' => '<string>',
'discountAmount' => 123,
'discountCode' => '<string>',
'discountPercentage' => 123,
'gatewayId' => 123,
'gatewayPaymentType' => '<string>',
'metadata' => [
],
'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/new_onetime_addon_preview"
payload := strings.NewReader("{\n \"addonId\": 123,\n \"quantity\": 123,\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"currency\": \"<string>\",\n \"discountAmount\": 123,\n \"discountCode\": \"<string>\",\n \"discountPercentage\": 123,\n \"gatewayId\": 123,\n \"gatewayPaymentType\": \"<string>\",\n \"metadata\": {},\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/new_onetime_addon_preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"addonId\": 123,\n \"quantity\": 123,\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"currency\": \"<string>\",\n \"discountAmount\": 123,\n \"discountCode\": \"<string>\",\n \"discountPercentage\": 123,\n \"gatewayId\": 123,\n \"gatewayPaymentType\": \"<string>\",\n \"metadata\": {},\n \"subscriptionId\": \"<string>\",\n \"taxPercentage\": 123,\n \"userId\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unibee.dev/merchant/subscription/new_onetime_addon_preview")
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 \"addonId\": 123,\n \"quantity\": 123,\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"currency\": \"<string>\",\n \"discountAmount\": 123,\n \"discountCode\": \"<string>\",\n \"discountPercentage\": 123,\n \"gatewayId\": 123,\n \"gatewayPaymentType\": \"<string>\",\n \"metadata\": {},\n \"subscriptionId\": \"<string>\",\n \"taxPercentage\": 123,\n \"userId\": 123\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"data": {
"addon": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"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
}
],
"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>"
}
}
},
"applyPromoCredit": true,
"currency": "<string>",
"discount": {
"advance": true,
"billingType": 123,
"code": "<string>",
"createTime": 123,
"currency": "<string>",
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"discountType": 123,
"endTime": 123,
"id": 123,
"isDeleted": 123,
"merchantId": 123,
"metadata": {},
"name": "<string>",
"planApplyGroup": {
"currency": [
"<string>"
],
"groupPlanIntervalSelector": [
{
"intervalCount": 123,
"intervalUnit": "<string>"
}
],
"type": [
123
]
},
"planApplyType": 123,
"planIds": [
123
],
"quantity": 123,
"startTime": 123,
"status": 123,
"upgradeLongerOnly": true,
"upgradeOnly": true,
"userLimit": 123,
"userScope": 123
},
"discountAmount": 123,
"discountMessage": "<string>",
"email": "<string>",
"invoice": {
"PaymentMethodId": "<string>",
"autoCharge": true,
"billingCycleAnchor": 123,
"bizType": 123,
"countryCode": "<string>",
"createFrom": "<string>",
"creditAccount": {
"amount": 123,
"createTime": 123,
"currency": "<string>",
"currencyAmount": 123,
"exchangeRate": 123,
"id": 123,
"payoutEnable": 123,
"rechargeEnable": 123,
"totalDecrementAmount": 123,
"totalIncrementAmount": 123,
"type": 123,
"userId": 123
},
"creditPayout": {
"creditAmount": 123,
"currencyAmount": 123,
"exchangeRate": 123
},
"cryptoAmount": 123,
"cryptoCurrency": "<string>",
"currency": "<string>",
"data": "<string>",
"dayUtilDue": 123,
"discount": {
"advance": true,
"billingType": 123,
"code": "<string>",
"createTime": 123,
"currency": "<string>",
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"discountType": 123,
"endTime": 123,
"id": 123,
"isDeleted": 123,
"merchantId": 123,
"metadata": {},
"name": "<string>",
"planApplyGroup": {
"currency": [
"<string>"
],
"groupPlanIntervalSelector": [
{
"intervalCount": 123,
"intervalUnit": "<string>"
}
],
"type": [
123
]
},
"planApplyType": 123,
"planIds": [
123
],
"quantity": 123,
"startTime": 123,
"status": 123,
"upgradeLongerOnly": true,
"upgradeOnly": true,
"userLimit": 123,
"userScope": 123
},
"discountAmount": 123,
"discountCode": "<string>",
"finishTime": 123,
"gatewayId": 123,
"id": 123,
"invoiceId": "<string>",
"invoiceName": "<string>",
"lines": [
{
"amount": 123,
"amountExcludingTax": 123,
"currency": "<string>",
"description": "<string>",
"discountAmount": 123,
"discountCode": "<string>",
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"lineId": "<string>",
"metricCharge": {
"metricId": 123,
"CurrentUsedValue": 123,
"chargePricing": {
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
},
"description": "<string>",
"lines": [
{
"amount": 123,
"flatAmount": 123,
"quantity": 123,
"step": "<string>",
"unitAmount": 123
}
],
"maxEventId": 123,
"minEventId": 123,
"name": "<string>",
"totalChargeAmount": 123
},
"name": "<string>",
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"originAmount": 123,
"originUnitAmountExcludeTax": 123,
"pdfDescription": "<string>",
"periodEnd": 123,
"periodStart": 123,
"plan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"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
}
],
"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>"
}
}
},
"planMetricChargeConfigs": [
{
"chargeType": 123,
"metricCode": "<string>",
"metricId": 123,
"metricName": "<string>",
"metricType": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"planMetricLimitConfigs": [
{
"metricCode": "<string>",
"metricId": 123,
"metricLimit": 123,
"metricName": "<string>",
"metricType": 123
}
],
"proration": true,
"prorationDate": 123,
"prorationScale": 123,
"quantity": 123,
"tax": 123,
"taxCode": "<string>",
"taxPercentage": 123,
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"unitAmountExcludingTax": 123,
"ustaxAlert": "<string>"
}
],
"link": "<string>",
"metadata": {},
"originAmount": 123,
"partialCreditPaidAmount": 123,
"paymentId": "<string>",
"paymentLink": "<string>",
"paymentType": "<string>",
"periodEnd": 123,
"periodStart": 123,
"planSnapshot": {
"addons": [
{
"addonPlan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"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
}
],
"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
}
],
"autoCharge": true,
"chargeType": 123,
"plan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"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
}
],
"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>"
}
}
},
"previousAddons": [
{
"addonPlan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"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
}
],
"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
}
],
"previousPlan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"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
}
],
"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>"
}
}
}
},
"productName": "<string>",
"promoCreditAccount": {
"amount": 123,
"createTime": 123,
"currency": "<string>",
"currencyAmount": 123,
"exchangeRate": 123,
"id": 123,
"payoutEnable": 123,
"rechargeEnable": 123,
"totalDecrementAmount": 123,
"totalIncrementAmount": 123,
"type": 123,
"userId": 123
},
"promoCreditDiscountAmount": 123,
"promoCreditPayout": {
"creditAmount": 123,
"currencyAmount": 123,
"exchangeRate": 123
},
"promoCreditTransaction": {
"accountType": 123,
"bizId": "<string>",
"by": "<string>",
"createTime": 123,
"creditAmountAfter": 123,
"creditAmountBefore": 123,
"creditId": 123,
"currency": "<string>",
"deltaAmount": 123,
"deltaCurrencyAmount": 123,
"description": "<string>",
"exchangeRate": 123,
"id": 123,
"invoiceId": "<string>",
"merchantId": 123,
"name": "<string>",
"transactionId": "<string>",
"transactionType": 123,
"userId": 123
},
"prorationDate": 123,
"prorationScale": 123,
"refundId": "<string>",
"sendNote": "<string>",
"sendStatus": 123,
"status": 123,
"subscriptionAmount": 123,
"subscriptionAmountExcludingTax": 123,
"subscriptionId": "<string>",
"taxAmount": 123,
"taxPercentage": 123,
"totalAmount": 123,
"totalAmountExcludingTax": 123,
"trialEnd": 123,
"userId": 123,
"userMetricChargeForInvoice": {
"meteredChargeStats": [
{
"metricId": 123,
"CurrentUsedValue": 123,
"chargePricing": {
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
},
"description": "<string>",
"lines": [
{
"amount": 123,
"flatAmount": 123,
"quantity": 123,
"step": "<string>",
"unitAmount": 123
}
],
"maxEventId": 123,
"minEventId": 123,
"name": "<string>",
"totalChargeAmount": 123
}
],
"recurringChargeStats": [
{
"metricId": 123,
"CurrentUsedValue": 123,
"chargePricing": {
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
},
"description": "<string>",
"lines": [
{
"amount": 123,
"flatAmount": 123,
"quantity": 123,
"step": "<string>",
"unitAmount": 123
}
],
"maxEventId": 123,
"minEventId": 123,
"name": "<string>",
"totalChargeAmount": 123
}
]
},
"vatNumber": "<string>"
},
"originAmount": 123,
"quantity": 123,
"taxAmount": 123,
"taxPercentage": 123,
"totalAmount": 123,
"userId": 123,
"vatNumber": "<string>"
},
"merchantId": 123,
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Subscription Payment
New Subscription Onetime Addon Preview
Preview for subscription onetime addon purchase
POST
/
merchant
/
subscription
/
new_onetime_addon_preview
New Subscription Onetime Addon Preview
curl --request POST \
--url https://api.unibee.dev/merchant/subscription/new_onetime_addon_preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"addonId": 123,
"quantity": 123,
"applyPromoCredit": true,
"applyPromoCreditAmount": 123,
"currency": "<string>",
"discountAmount": 123,
"discountCode": "<string>",
"discountPercentage": 123,
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"metadata": {},
"subscriptionId": "<string>",
"taxPercentage": 123,
"userId": 123
}
'import requests
url = "https://api.unibee.dev/merchant/subscription/new_onetime_addon_preview"
payload = {
"addonId": 123,
"quantity": 123,
"applyPromoCredit": True,
"applyPromoCreditAmount": 123,
"currency": "<string>",
"discountAmount": 123,
"discountCode": "<string>",
"discountPercentage": 123,
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"metadata": {},
"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({
addonId: 123,
quantity: 123,
applyPromoCredit: true,
applyPromoCreditAmount: 123,
currency: '<string>',
discountAmount: 123,
discountCode: '<string>',
discountPercentage: 123,
gatewayId: 123,
gatewayPaymentType: '<string>',
metadata: {},
subscriptionId: '<string>',
taxPercentage: 123,
userId: 123
})
};
fetch('https://api.unibee.dev/merchant/subscription/new_onetime_addon_preview', 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/new_onetime_addon_preview",
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([
'addonId' => 123,
'quantity' => 123,
'applyPromoCredit' => true,
'applyPromoCreditAmount' => 123,
'currency' => '<string>',
'discountAmount' => 123,
'discountCode' => '<string>',
'discountPercentage' => 123,
'gatewayId' => 123,
'gatewayPaymentType' => '<string>',
'metadata' => [
],
'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/new_onetime_addon_preview"
payload := strings.NewReader("{\n \"addonId\": 123,\n \"quantity\": 123,\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"currency\": \"<string>\",\n \"discountAmount\": 123,\n \"discountCode\": \"<string>\",\n \"discountPercentage\": 123,\n \"gatewayId\": 123,\n \"gatewayPaymentType\": \"<string>\",\n \"metadata\": {},\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/new_onetime_addon_preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"addonId\": 123,\n \"quantity\": 123,\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"currency\": \"<string>\",\n \"discountAmount\": 123,\n \"discountCode\": \"<string>\",\n \"discountPercentage\": 123,\n \"gatewayId\": 123,\n \"gatewayPaymentType\": \"<string>\",\n \"metadata\": {},\n \"subscriptionId\": \"<string>\",\n \"taxPercentage\": 123,\n \"userId\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unibee.dev/merchant/subscription/new_onetime_addon_preview")
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 \"addonId\": 123,\n \"quantity\": 123,\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"currency\": \"<string>\",\n \"discountAmount\": 123,\n \"discountCode\": \"<string>\",\n \"discountPercentage\": 123,\n \"gatewayId\": 123,\n \"gatewayPaymentType\": \"<string>\",\n \"metadata\": {},\n \"subscriptionId\": \"<string>\",\n \"taxPercentage\": 123,\n \"userId\": 123\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"data": {
"addon": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"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
}
],
"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>"
}
}
},
"applyPromoCredit": true,
"currency": "<string>",
"discount": {
"advance": true,
"billingType": 123,
"code": "<string>",
"createTime": 123,
"currency": "<string>",
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"discountType": 123,
"endTime": 123,
"id": 123,
"isDeleted": 123,
"merchantId": 123,
"metadata": {},
"name": "<string>",
"planApplyGroup": {
"currency": [
"<string>"
],
"groupPlanIntervalSelector": [
{
"intervalCount": 123,
"intervalUnit": "<string>"
}
],
"type": [
123
]
},
"planApplyType": 123,
"planIds": [
123
],
"quantity": 123,
"startTime": 123,
"status": 123,
"upgradeLongerOnly": true,
"upgradeOnly": true,
"userLimit": 123,
"userScope": 123
},
"discountAmount": 123,
"discountMessage": "<string>",
"email": "<string>",
"invoice": {
"PaymentMethodId": "<string>",
"autoCharge": true,
"billingCycleAnchor": 123,
"bizType": 123,
"countryCode": "<string>",
"createFrom": "<string>",
"creditAccount": {
"amount": 123,
"createTime": 123,
"currency": "<string>",
"currencyAmount": 123,
"exchangeRate": 123,
"id": 123,
"payoutEnable": 123,
"rechargeEnable": 123,
"totalDecrementAmount": 123,
"totalIncrementAmount": 123,
"type": 123,
"userId": 123
},
"creditPayout": {
"creditAmount": 123,
"currencyAmount": 123,
"exchangeRate": 123
},
"cryptoAmount": 123,
"cryptoCurrency": "<string>",
"currency": "<string>",
"data": "<string>",
"dayUtilDue": 123,
"discount": {
"advance": true,
"billingType": 123,
"code": "<string>",
"createTime": 123,
"currency": "<string>",
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"discountType": 123,
"endTime": 123,
"id": 123,
"isDeleted": 123,
"merchantId": 123,
"metadata": {},
"name": "<string>",
"planApplyGroup": {
"currency": [
"<string>"
],
"groupPlanIntervalSelector": [
{
"intervalCount": 123,
"intervalUnit": "<string>"
}
],
"type": [
123
]
},
"planApplyType": 123,
"planIds": [
123
],
"quantity": 123,
"startTime": 123,
"status": 123,
"upgradeLongerOnly": true,
"upgradeOnly": true,
"userLimit": 123,
"userScope": 123
},
"discountAmount": 123,
"discountCode": "<string>",
"finishTime": 123,
"gatewayId": 123,
"id": 123,
"invoiceId": "<string>",
"invoiceName": "<string>",
"lines": [
{
"amount": 123,
"amountExcludingTax": 123,
"currency": "<string>",
"description": "<string>",
"discountAmount": 123,
"discountCode": "<string>",
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"lineId": "<string>",
"metricCharge": {
"metricId": 123,
"CurrentUsedValue": 123,
"chargePricing": {
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
},
"description": "<string>",
"lines": [
{
"amount": 123,
"flatAmount": 123,
"quantity": 123,
"step": "<string>",
"unitAmount": 123
}
],
"maxEventId": 123,
"minEventId": 123,
"name": "<string>",
"totalChargeAmount": 123
},
"name": "<string>",
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"originAmount": 123,
"originUnitAmountExcludeTax": 123,
"pdfDescription": "<string>",
"periodEnd": 123,
"periodStart": 123,
"plan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"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
}
],
"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>"
}
}
},
"planMetricChargeConfigs": [
{
"chargeType": 123,
"metricCode": "<string>",
"metricId": 123,
"metricName": "<string>",
"metricType": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"planMetricLimitConfigs": [
{
"metricCode": "<string>",
"metricId": 123,
"metricLimit": 123,
"metricName": "<string>",
"metricType": 123
}
],
"proration": true,
"prorationDate": 123,
"prorationScale": 123,
"quantity": 123,
"tax": 123,
"taxCode": "<string>",
"taxPercentage": 123,
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"unitAmountExcludingTax": 123,
"ustaxAlert": "<string>"
}
],
"link": "<string>",
"metadata": {},
"originAmount": 123,
"partialCreditPaidAmount": 123,
"paymentId": "<string>",
"paymentLink": "<string>",
"paymentType": "<string>",
"periodEnd": 123,
"periodStart": 123,
"planSnapshot": {
"addons": [
{
"addonPlan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"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
}
],
"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
}
],
"autoCharge": true,
"chargeType": 123,
"plan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"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
}
],
"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>"
}
}
},
"previousAddons": [
{
"addonPlan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"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
}
],
"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
}
],
"previousPlan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"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
}
],
"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>"
}
}
}
},
"productName": "<string>",
"promoCreditAccount": {
"amount": 123,
"createTime": 123,
"currency": "<string>",
"currencyAmount": 123,
"exchangeRate": 123,
"id": 123,
"payoutEnable": 123,
"rechargeEnable": 123,
"totalDecrementAmount": 123,
"totalIncrementAmount": 123,
"type": 123,
"userId": 123
},
"promoCreditDiscountAmount": 123,
"promoCreditPayout": {
"creditAmount": 123,
"currencyAmount": 123,
"exchangeRate": 123
},
"promoCreditTransaction": {
"accountType": 123,
"bizId": "<string>",
"by": "<string>",
"createTime": 123,
"creditAmountAfter": 123,
"creditAmountBefore": 123,
"creditId": 123,
"currency": "<string>",
"deltaAmount": 123,
"deltaCurrencyAmount": 123,
"description": "<string>",
"exchangeRate": 123,
"id": 123,
"invoiceId": "<string>",
"merchantId": 123,
"name": "<string>",
"transactionId": "<string>",
"transactionType": 123,
"userId": 123
},
"prorationDate": 123,
"prorationScale": 123,
"refundId": "<string>",
"sendNote": "<string>",
"sendStatus": 123,
"status": 123,
"subscriptionAmount": 123,
"subscriptionAmountExcludingTax": 123,
"subscriptionId": "<string>",
"taxAmount": 123,
"taxPercentage": 123,
"totalAmount": 123,
"totalAmountExcludingTax": 123,
"trialEnd": 123,
"userId": 123,
"userMetricChargeForInvoice": {
"meteredChargeStats": [
{
"metricId": 123,
"CurrentUsedValue": 123,
"chargePricing": {
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
},
"description": "<string>",
"lines": [
{
"amount": 123,
"flatAmount": 123,
"quantity": 123,
"step": "<string>",
"unitAmount": 123
}
],
"maxEventId": 123,
"minEventId": 123,
"name": "<string>",
"totalChargeAmount": 123
}
],
"recurringChargeStats": [
{
"metricId": 123,
"CurrentUsedValue": 123,
"chargePricing": {
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
},
"description": "<string>",
"lines": [
{
"amount": 123,
"flatAmount": 123,
"quantity": 123,
"step": "<string>",
"unitAmount": 123
}
],
"maxEventId": 123,
"minEventId": 123,
"name": "<string>",
"totalChargeAmount": 123
}
]
},
"vatNumber": "<string>"
},
"originAmount": 123,
"quantity": 123,
"taxAmount": 123,
"taxPercentage": 123,
"totalAmount": 123,
"userId": 123,
"vatNumber": "<string>"
},
"merchantId": 123,
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Endpoint Overview
POSThttps://api.unibee.dev/merchant/subscription/new_onetime_addon_preview
Preview for subscription onetime addon purchase
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 |
|---|---|---|---|
addonId | integer | Yes | AddonId, id of one-time addon, the new payment will created base on the addon’s amount’ |
applyPromoCredit | boolean | No | apply promo credit or not |
applyPromoCreditAmount | integer | No | apply promo credit amount, auto compute if not specified |
currency | string | No | The currency of payment |
discountAmount | integer | No | Amount of discount |
discountCode | string | No | DiscountCode |
discountPercentage | integer | No | Percentage of discount, 100=1%, ignore if discountAmount specified |
gatewayId | integer | No | GatewayId, use user’s gateway if not provide |
gatewayPaymentType | string | No | Gateway Payment Type |
metadata | object | No | Metadata，custom data |
quantity | integer | Yes | Quantity, quantity of the new payment which one-time addon purchased |
subscriptionId | string | No | SubscriptionId, id of subscription which addon will attached, either SubscriptionId or UserId needed, The only one active subscription of userId will attach the addon |
taxPercentage | integer | No | TaxPercentage，1000 = 10%, default user’s taxPercentage if not specified |
userId | integer | No | UserId, either SubscriptionId or UserId needed, The only one active subscription will update if userId provide instead of subscriptionId |
Request examples
cURL
curl -X POST "https://api.unibee.dev/merchant/subscription/new_onetime_addon_preview" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"addonId": 0,
"applyPromoCredit": false,
"applyPromoCreditAmount": 0,
"currency": "",
"discountAmount": 0,
"discountCode": "",
"discountPercentage": 0,
"gatewayId": 0,
"gatewayPaymentType": "",
"metadata": {},
"quantity": 0,
"subscriptionId": "id_example",
"taxPercentage": 0,
"userId": 0
}'
Sandbox
curl -X POST "https://api-sandbox.unibee.top/merchant/subscription/new_onetime_addon_preview" \
-H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"addonId": 0,
"applyPromoCredit": false,
"applyPromoCreditAmount": 0,
"currency": "",
"discountAmount": 0,
"discountCode": "",
"discountPercentage": 0,
"gatewayId": 0,
"gatewayPaymentType": "",
"metadata": {},
"quantity": 0,
"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.addon | object | |
data.applyPromoCredit | boolean | apply promo credit or not |
data.currency | string | |
data.discount | object | |
data.discountAmount | integer | |
data.discountMessage | string | |
data.email | string | |
data.invoice | object | |
data.originAmount | integer | |
data.quantity | integer | |
data.taxAmount | integer | |
data.taxPercentage | integer | |
data.totalAmount | integer | |
data.userId | integer | |
data.vatNumber | string | |
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
Preview for subscription onetime addon purchase
AddonId, id of one-time addon, the new payment will created base on the addon's amount'
Quantity, quantity of the new payment which one-time addon purchased
apply promo credit or not
apply promo credit amount, auto compute if not specified
The currency of payment
Amount of discount
DiscountCode
Percentage of discount, 100=1%, ignore if discountAmount specified
GatewayId, use user's gateway if not provide
Gateway Payment Type
Metadata，custom data
Show child attributes
Show child attributes
SubscriptionId, id of subscription which addon will attached, either SubscriptionId or UserId needed, The only one active subscription of userId will attach the addon
TaxPercentage，1000 = 10%, default user's taxPercentage if not specified
UserId, either SubscriptionId or UserId needed, The only one active subscription will update if userId provide instead of subscriptionId
⌘I