Invoice Edit
curl --request POST \
--url https://api.unibee.dev/merchant/invoice/edit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"invoiceId": "<string>",
"applyPromoCredit": true,
"applyPromoCreditAmount": 123,
"currency": "<string>",
"finish": true,
"gatewayId": 123,
"lines": [
{
"description": "<string>",
"name": "<string>",
"planId": 123,
"quantity": 123,
"unitAmountExcludingTax": 123
}
],
"name": "<string>",
"taxPercentage": 123
}
'import requests
url = "https://api.unibee.dev/merchant/invoice/edit"
payload = {
"invoiceId": "<string>",
"applyPromoCredit": True,
"applyPromoCreditAmount": 123,
"currency": "<string>",
"finish": True,
"gatewayId": 123,
"lines": [
{
"description": "<string>",
"name": "<string>",
"planId": 123,
"quantity": 123,
"unitAmountExcludingTax": 123
}
],
"name": "<string>",
"taxPercentage": 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({
invoiceId: '<string>',
applyPromoCredit: true,
applyPromoCreditAmount: 123,
currency: '<string>',
finish: true,
gatewayId: 123,
lines: [
{
description: '<string>',
name: '<string>',
planId: 123,
quantity: 123,
unitAmountExcludingTax: 123
}
],
name: '<string>',
taxPercentage: 123
})
};
fetch('https://api.unibee.dev/merchant/invoice/edit', 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/invoice/edit",
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([
'invoiceId' => '<string>',
'applyPromoCredit' => true,
'applyPromoCreditAmount' => 123,
'currency' => '<string>',
'finish' => true,
'gatewayId' => 123,
'lines' => [
[
'description' => '<string>',
'name' => '<string>',
'planId' => 123,
'quantity' => 123,
'unitAmountExcludingTax' => 123
]
],
'name' => '<string>',
'taxPercentage' => 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/invoice/edit"
payload := strings.NewReader("{\n \"invoiceId\": \"<string>\",\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"currency\": \"<string>\",\n \"finish\": true,\n \"gatewayId\": 123,\n \"lines\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"planId\": 123,\n \"quantity\": 123,\n \"unitAmountExcludingTax\": 123\n }\n ],\n \"name\": \"<string>\",\n \"taxPercentage\": 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/invoice/edit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"invoiceId\": \"<string>\",\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"currency\": \"<string>\",\n \"finish\": true,\n \"gatewayId\": 123,\n \"lines\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"planId\": 123,\n \"quantity\": 123,\n \"unitAmountExcludingTax\": 123\n }\n ],\n \"name\": \"<string>\",\n \"taxPercentage\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unibee.dev/merchant/invoice/edit")
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 \"invoiceId\": \"<string>\",\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"currency\": \"<string>\",\n \"finish\": true,\n \"gatewayId\": 123,\n \"lines\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"planId\": 123,\n \"quantity\": 123,\n \"unitAmountExcludingTax\": 123\n }\n ],\n \"name\": \"<string>\",\n \"taxPercentage\": 123\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"data": {
"invoice": {
"PaymentMethodId": "<string>",
"autoCharge": true,
"billingCycleAnchor": 123,
"bizType": 123,
"countryCode": "<string>",
"createFrom": "<string>",
"createTime": 123,
"cryptoAmount": 123,
"cryptoCurrency": "<string>",
"currency": "<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,
"userIds": [
123
],
"userLimit": 123,
"userScope": 123
},
"discountAmount": 123,
"discountCode": "<string>",
"finishTime": 123,
"gateway": {
"IsSetupFinished": true,
"archive": true,
"autoChargeEnabled": true,
"bank": {
"accountHolder": "<string>",
"address": "<string>",
"ABARoutingNumber": "<string>",
"CNAPS": "<string>",
"Remarks": "<string>",
"accountNumber": "<string>",
"bankName": "<string>",
"bic": "<string>",
"bsbCode": "<string>",
"iban": "<string>",
"swiftCode": "<string>"
},
"companyIssuer": {
"issueAddress": "<string>",
"issueCompanyName": "<string>",
"issueLogo": "<string>",
"issueRegNumber": "<string>",
"issueVatNumber": "<string>"
},
"countryConfig": {},
"createTime": 123,
"currency": "<string>",
"currencyExchange": [
{
"exchange_rate": 123,
"from_currency": "<string>",
"to_currency": "<string>"
}
],
"currencyExchangeEnabled": true,
"defaultGatewayPaymentType": {
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<string>",
"supportCurrencies": [
"<string>"
]
},
"description": "<string>",
"displayName": "<string>",
"gatewayIcons": [
"<string>"
],
"gatewayId": 123,
"gatewayKey": "<string>",
"gatewayLogo": "<string>",
"gatewayName": "<string>",
"gatewayPaymentTypes": [
{
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<string>",
"supportCurrencies": [
"<string>"
]
}
],
"gatewaySecret": "<string>",
"gatewayType": 123,
"gatewayWebhookIntegrationLink": "<string>",
"gatewayWebsiteLink": "<string>",
"isDefault": true,
"metadata": {},
"minimumAmount": 123,
"name": "<string>",
"privateSecretName": "<string>",
"publicKeyName": "<string>",
"setupGatewayPaymentTypes": [
{
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<string>",
"supportCurrencies": [
"<string>"
]
}
],
"sort": 123,
"subGateway": "<string>",
"subGatewayName": "<string>",
"webhookEndpointUrl": "<string>",
"webhookSecret": "<string>"
},
"gatewayId": 123,
"gatewayPaymentId": "<string>",
"gatewayPaymentType": "<string>",
"gatewayStatus": "<string>",
"gatewayUserId": "<string>",
"gmtCreate": "<string>",
"gmtModify": "<string>",
"id": 123,
"invoiceId": "<string>",
"invoiceName": "<string>",
"isDeleted": 123,
"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,
"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>"
}
}
},
"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>",
"merchant": {
"companyLogo": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"homeUrl": "<string>",
"id": 123,
"name": "<string>",
"timeZone": "<string>"
},
"merchantId": 123,
"message": "<string>",
"metadata": {},
"originAmount": 123,
"originalPaymentInvoice": {
"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,
"userIds": [
123
],
"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,
"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>"
}
}
},
"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,
"paidTime": 123,
"partialCreditPaidAmount": 123,
"paymentId": "<string>",
"paymentLink": "<string>",
"paymentType": "<string>",
"periodEnd": 123,
"periodStart": 123,
"planSnapshot": {
"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
}
],
"autoCharge": true,
"chargeType": 123,
"multiCurrencySnapshot": {
"chargeCurrency": "<string>",
"rates": [
{
"from": "<string>",
"rate": 123,
"to": "<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>"
}
}
},
"previousAddons": [
{
"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
}
],
"previousPlan": {
"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>"
}
}
}
},
"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>"
},
"paidTime": 123,
"partialCreditPaidAmount": 123,
"payment": {
"action": {},
"authorizeComment": "<string>",
"authorizeReason": "<string>",
"authorizeStatus": 123,
"autoCharge": true,
"automatic": 123,
"balanceAmount": 123,
"billingReason": "<string>",
"cancelTime": 123,
"countryCode": "<string>",
"createTime": 123,
"cryptoAmount": 123,
"cryptoCurrency": "<string>",
"currency": "<string>",
"externalPaymentId": "<string>",
"failureReason": "<string>",
"gasPayer": "<string>",
"gatewayCurrencyExchange": {
"exchange_amount": 123,
"exchange_rate": 123,
"from_currency": "<string>",
"to_currency": "<string>"
},
"gatewayId": 123,
"gatewayPaymentId": "<string>",
"gatewayPaymentType": "<string>",
"invoiceId": "<string>",
"lastError": "<string>",
"link": "<string>",
"merchantId": 123,
"metadata": {},
"paidTime": 123,
"paymentAmount": 123,
"paymentId": "<string>",
"refundAmount": 123,
"returnUrl": "<string>",
"splitSequence": 123,
"status": 123,
"subscriptionId": "<string>",
"totalAmount": 123,
"userId": 123
},
"paymentId": "<string>",
"paymentType": "<string>",
"periodEnd": 123,
"periodStart": 123,
"planSnapshot": {
"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
}
],
"autoCharge": true,
"chargeType": 123,
"multiCurrencySnapshot": {
"chargeCurrency": "<string>",
"rates": [
{
"from": "<string>",
"rate": 123,
"to": "<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>"
}
}
},
"previousAddons": [
{
"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
}
],
"previousPlan": {
"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>"
}
}
}
},
"productName": "<string>",
"promoCreditDiscountAmount": 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,
"refund": {
"adminMemberId": 123,
"countryCode": "<string>",
"createTime": 123,
"currency": "<string>",
"externalRefundId": "<string>",
"gatewayCurrencyExchange": {
"exchange_amount": 123,
"exchange_rate": 123,
"from_currency": "<string>",
"to_currency": "<string>"
},
"gatewayId": 123,
"gatewayRefundId": "<string>",
"invoiceId": "<string>",
"merchantId": 123,
"metadata": {},
"paymentId": "<string>",
"refundAmount": 123,
"refundComment": "<string>",
"refundCommentExplain": "<string>",
"refundId": "<string>",
"refundTime": 123,
"returnUrl": "<string>",
"status": 123,
"subscriptionId": "<string>",
"type": 123,
"userId": 123
},
"refundId": "<string>",
"sendEmail": "<string>",
"sendNote": "<string>",
"sendPdf": "<string>",
"sendStatus": 123,
"status": 123,
"subscription": {
"addonData": "<string>",
"amount": 123,
"billingCycleAnchor": 123,
"cancelAtPeriodEnd": 123,
"cancelOrExpireTime": 123,
"cancelReason": "<string>",
"countryCode": "<string>",
"createTime": 123,
"currency": "<string>",
"currentPeriodEnd": 123,
"currentPeriodPaid": 123,
"currentPeriodStart": 123,
"defaultPaymentMethodId": "<string>",
"dunningTime": 123,
"externalSubscriptionId": "<string>",
"features": "<string>",
"firstPaidTime": 123,
"gasPayer": "<string>",
"gatewayId": 123,
"gatewayStatus": "<string>",
"id": 123,
"lastUpdateTime": 123,
"latestInvoiceId": "<string>",
"merchantId": 123,
"metadata": {},
"multiTrial": {
"currency": "<string>",
"currentIndex": 123,
"finished": true,
"planId": 123,
"regularPrice": 123,
"startedAt": 123,
"trials": [
{
"compareAtPrice": 123,
"duration": 123,
"intervalCount": 123,
"intervalUnit": "<string>",
"metadata": {},
"name": "<string>",
"price": 123
}
],
"version": 123
},
"originalPeriodEnd": 123,
"pendingUpdateId": "<string>",
"planId": 123,
"productId": 123,
"quantity": 123,
"returnUrl": "<string>",
"status": 123,
"subscriptionId": "<string>",
"taskTime": "<string>",
"taxPercentage": 123,
"testClock": 123,
"trialEnd": 123,
"type": 123,
"userId": 123,
"vatNumber": "<string>"
},
"subscriptionAmount": 123,
"subscriptionAmountExcludingTax": 123,
"subscriptionId": "<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
},
"taxAmount": 123,
"taxPercentage": 123,
"totalAmount": 123,
"totalAmountExcludingTax": 123,
"trialEnd": 123,
"uniqueId": "<string>",
"userAccount": {
"address": "<string>",
"avatarUrl": "<string>",
"billingType": 123,
"birthday": "<string>",
"city": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"createTime": 123,
"custom": "<string>",
"email": "<string>",
"externalUserId": "<string>",
"facebook": "<string>",
"firstName": "<string>",
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"gender": "<string>",
"id": 123,
"isRisk": 123,
"isSpecial": 123,
"language": "<string>",
"lastLoginAt": 123,
"lastName": "<string>",
"linkedIn": "<string>",
"merchantId": 123,
"metadata": {},
"mobile": "<string>",
"otherSocialInfo": "<string>",
"paymentMethod": "<string>",
"phone": "<string>",
"recurringAmount": 123,
"registrationNumber": "<string>",
"school": "<string>",
"state": "<string>",
"status": 123,
"subscriptionId": "<string>",
"subscriptionName": "<string>",
"subscriptionStatus": 123,
"taxPercentage": 123,
"telegram": "<string>",
"tikTok": "<string>",
"timeZone": "<string>",
"type": 123,
"userName": "<string>",
"vATNumber": "<string>",
"version": 123,
"weChat": "<string>",
"whatsAPP": "<string>",
"zipCode": "<string>"
},
"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
}
]
},
"userSnapshot": {
"address": "<string>",
"avatarUrl": "<string>",
"billingType": 123,
"birthday": "<string>",
"city": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"createTime": 123,
"custom": "<string>",
"email": "<string>",
"externalUserId": "<string>",
"facebook": "<string>",
"firstName": "<string>",
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"gender": "<string>",
"id": 123,
"isRisk": 123,
"isSpecial": 123,
"language": "<string>",
"lastLoginAt": 123,
"lastName": "<string>",
"linkedIn": "<string>",
"merchantId": 123,
"metadata": {},
"mobile": "<string>",
"otherSocialInfo": "<string>",
"paymentMethod": "<string>",
"phone": "<string>",
"recurringAmount": 123,
"registrationNumber": "<string>",
"school": "<string>",
"state": "<string>",
"status": 123,
"subscriptionId": "<string>",
"subscriptionName": "<string>",
"subscriptionStatus": 123,
"taxPercentage": 123,
"telegram": "<string>",
"tikTok": "<string>",
"timeZone": "<string>",
"type": 123,
"userName": "<string>",
"vATNumber": "<string>",
"version": 123,
"weChat": "<string>",
"whatsAPP": "<string>",
"zipCode": "<string>"
},
"vatNumber": "<string>"
}
},
"merchantId": 123,
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Invoice
Invoice Edit
Edit invoice of pending status
POST
/
merchant
/
invoice
/
edit
Invoice Edit
curl --request POST \
--url https://api.unibee.dev/merchant/invoice/edit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"invoiceId": "<string>",
"applyPromoCredit": true,
"applyPromoCreditAmount": 123,
"currency": "<string>",
"finish": true,
"gatewayId": 123,
"lines": [
{
"description": "<string>",
"name": "<string>",
"planId": 123,
"quantity": 123,
"unitAmountExcludingTax": 123
}
],
"name": "<string>",
"taxPercentage": 123
}
'import requests
url = "https://api.unibee.dev/merchant/invoice/edit"
payload = {
"invoiceId": "<string>",
"applyPromoCredit": True,
"applyPromoCreditAmount": 123,
"currency": "<string>",
"finish": True,
"gatewayId": 123,
"lines": [
{
"description": "<string>",
"name": "<string>",
"planId": 123,
"quantity": 123,
"unitAmountExcludingTax": 123
}
],
"name": "<string>",
"taxPercentage": 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({
invoiceId: '<string>',
applyPromoCredit: true,
applyPromoCreditAmount: 123,
currency: '<string>',
finish: true,
gatewayId: 123,
lines: [
{
description: '<string>',
name: '<string>',
planId: 123,
quantity: 123,
unitAmountExcludingTax: 123
}
],
name: '<string>',
taxPercentage: 123
})
};
fetch('https://api.unibee.dev/merchant/invoice/edit', 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/invoice/edit",
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([
'invoiceId' => '<string>',
'applyPromoCredit' => true,
'applyPromoCreditAmount' => 123,
'currency' => '<string>',
'finish' => true,
'gatewayId' => 123,
'lines' => [
[
'description' => '<string>',
'name' => '<string>',
'planId' => 123,
'quantity' => 123,
'unitAmountExcludingTax' => 123
]
],
'name' => '<string>',
'taxPercentage' => 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/invoice/edit"
payload := strings.NewReader("{\n \"invoiceId\": \"<string>\",\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"currency\": \"<string>\",\n \"finish\": true,\n \"gatewayId\": 123,\n \"lines\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"planId\": 123,\n \"quantity\": 123,\n \"unitAmountExcludingTax\": 123\n }\n ],\n \"name\": \"<string>\",\n \"taxPercentage\": 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/invoice/edit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"invoiceId\": \"<string>\",\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"currency\": \"<string>\",\n \"finish\": true,\n \"gatewayId\": 123,\n \"lines\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"planId\": 123,\n \"quantity\": 123,\n \"unitAmountExcludingTax\": 123\n }\n ],\n \"name\": \"<string>\",\n \"taxPercentage\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unibee.dev/merchant/invoice/edit")
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 \"invoiceId\": \"<string>\",\n \"applyPromoCredit\": true,\n \"applyPromoCreditAmount\": 123,\n \"currency\": \"<string>\",\n \"finish\": true,\n \"gatewayId\": 123,\n \"lines\": [\n {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"planId\": 123,\n \"quantity\": 123,\n \"unitAmountExcludingTax\": 123\n }\n ],\n \"name\": \"<string>\",\n \"taxPercentage\": 123\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"data": {
"invoice": {
"PaymentMethodId": "<string>",
"autoCharge": true,
"billingCycleAnchor": 123,
"bizType": 123,
"countryCode": "<string>",
"createFrom": "<string>",
"createTime": 123,
"cryptoAmount": 123,
"cryptoCurrency": "<string>",
"currency": "<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,
"userIds": [
123
],
"userLimit": 123,
"userScope": 123
},
"discountAmount": 123,
"discountCode": "<string>",
"finishTime": 123,
"gateway": {
"IsSetupFinished": true,
"archive": true,
"autoChargeEnabled": true,
"bank": {
"accountHolder": "<string>",
"address": "<string>",
"ABARoutingNumber": "<string>",
"CNAPS": "<string>",
"Remarks": "<string>",
"accountNumber": "<string>",
"bankName": "<string>",
"bic": "<string>",
"bsbCode": "<string>",
"iban": "<string>",
"swiftCode": "<string>"
},
"companyIssuer": {
"issueAddress": "<string>",
"issueCompanyName": "<string>",
"issueLogo": "<string>",
"issueRegNumber": "<string>",
"issueVatNumber": "<string>"
},
"countryConfig": {},
"createTime": 123,
"currency": "<string>",
"currencyExchange": [
{
"exchange_rate": 123,
"from_currency": "<string>",
"to_currency": "<string>"
}
],
"currencyExchangeEnabled": true,
"defaultGatewayPaymentType": {
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<string>",
"supportCurrencies": [
"<string>"
]
},
"description": "<string>",
"displayName": "<string>",
"gatewayIcons": [
"<string>"
],
"gatewayId": 123,
"gatewayKey": "<string>",
"gatewayLogo": "<string>",
"gatewayName": "<string>",
"gatewayPaymentTypes": [
{
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<string>",
"supportCurrencies": [
"<string>"
]
}
],
"gatewaySecret": "<string>",
"gatewayType": 123,
"gatewayWebhookIntegrationLink": "<string>",
"gatewayWebsiteLink": "<string>",
"isDefault": true,
"metadata": {},
"minimumAmount": 123,
"name": "<string>",
"privateSecretName": "<string>",
"publicKeyName": "<string>",
"setupGatewayPaymentTypes": [
{
"autoCharge": true,
"category": "<string>",
"countryName": "<string>",
"name": "<string>",
"paymentType": "<string>",
"supportCurrencies": [
"<string>"
]
}
],
"sort": 123,
"subGateway": "<string>",
"subGatewayName": "<string>",
"webhookEndpointUrl": "<string>",
"webhookSecret": "<string>"
},
"gatewayId": 123,
"gatewayPaymentId": "<string>",
"gatewayPaymentType": "<string>",
"gatewayStatus": "<string>",
"gatewayUserId": "<string>",
"gmtCreate": "<string>",
"gmtModify": "<string>",
"id": 123,
"invoiceId": "<string>",
"invoiceName": "<string>",
"isDeleted": 123,
"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,
"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>"
}
}
},
"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>",
"merchant": {
"companyLogo": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"homeUrl": "<string>",
"id": 123,
"name": "<string>",
"timeZone": "<string>"
},
"merchantId": 123,
"message": "<string>",
"metadata": {},
"originAmount": 123,
"originalPaymentInvoice": {
"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,
"userIds": [
123
],
"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,
"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>"
}
}
},
"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,
"paidTime": 123,
"partialCreditPaidAmount": 123,
"paymentId": "<string>",
"paymentLink": "<string>",
"paymentType": "<string>",
"periodEnd": 123,
"periodStart": 123,
"planSnapshot": {
"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
}
],
"autoCharge": true,
"chargeType": 123,
"multiCurrencySnapshot": {
"chargeCurrency": "<string>",
"rates": [
{
"from": "<string>",
"rate": 123,
"to": "<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>"
}
}
},
"previousAddons": [
{
"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
}
],
"previousPlan": {
"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>"
}
}
}
},
"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>"
},
"paidTime": 123,
"partialCreditPaidAmount": 123,
"payment": {
"action": {},
"authorizeComment": "<string>",
"authorizeReason": "<string>",
"authorizeStatus": 123,
"autoCharge": true,
"automatic": 123,
"balanceAmount": 123,
"billingReason": "<string>",
"cancelTime": 123,
"countryCode": "<string>",
"createTime": 123,
"cryptoAmount": 123,
"cryptoCurrency": "<string>",
"currency": "<string>",
"externalPaymentId": "<string>",
"failureReason": "<string>",
"gasPayer": "<string>",
"gatewayCurrencyExchange": {
"exchange_amount": 123,
"exchange_rate": 123,
"from_currency": "<string>",
"to_currency": "<string>"
},
"gatewayId": 123,
"gatewayPaymentId": "<string>",
"gatewayPaymentType": "<string>",
"invoiceId": "<string>",
"lastError": "<string>",
"link": "<string>",
"merchantId": 123,
"metadata": {},
"paidTime": 123,
"paymentAmount": 123,
"paymentId": "<string>",
"refundAmount": 123,
"returnUrl": "<string>",
"splitSequence": 123,
"status": 123,
"subscriptionId": "<string>",
"totalAmount": 123,
"userId": 123
},
"paymentId": "<string>",
"paymentType": "<string>",
"periodEnd": 123,
"periodStart": 123,
"planSnapshot": {
"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
}
],
"autoCharge": true,
"chargeType": 123,
"multiCurrencySnapshot": {
"chargeCurrency": "<string>",
"rates": [
{
"from": "<string>",
"rate": 123,
"to": "<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>"
}
}
},
"previousAddons": [
{
"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
}
],
"previousPlan": {
"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>"
}
}
}
},
"productName": "<string>",
"promoCreditDiscountAmount": 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,
"refund": {
"adminMemberId": 123,
"countryCode": "<string>",
"createTime": 123,
"currency": "<string>",
"externalRefundId": "<string>",
"gatewayCurrencyExchange": {
"exchange_amount": 123,
"exchange_rate": 123,
"from_currency": "<string>",
"to_currency": "<string>"
},
"gatewayId": 123,
"gatewayRefundId": "<string>",
"invoiceId": "<string>",
"merchantId": 123,
"metadata": {},
"paymentId": "<string>",
"refundAmount": 123,
"refundComment": "<string>",
"refundCommentExplain": "<string>",
"refundId": "<string>",
"refundTime": 123,
"returnUrl": "<string>",
"status": 123,
"subscriptionId": "<string>",
"type": 123,
"userId": 123
},
"refundId": "<string>",
"sendEmail": "<string>",
"sendNote": "<string>",
"sendPdf": "<string>",
"sendStatus": 123,
"status": 123,
"subscription": {
"addonData": "<string>",
"amount": 123,
"billingCycleAnchor": 123,
"cancelAtPeriodEnd": 123,
"cancelOrExpireTime": 123,
"cancelReason": "<string>",
"countryCode": "<string>",
"createTime": 123,
"currency": "<string>",
"currentPeriodEnd": 123,
"currentPeriodPaid": 123,
"currentPeriodStart": 123,
"defaultPaymentMethodId": "<string>",
"dunningTime": 123,
"externalSubscriptionId": "<string>",
"features": "<string>",
"firstPaidTime": 123,
"gasPayer": "<string>",
"gatewayId": 123,
"gatewayStatus": "<string>",
"id": 123,
"lastUpdateTime": 123,
"latestInvoiceId": "<string>",
"merchantId": 123,
"metadata": {},
"multiTrial": {
"currency": "<string>",
"currentIndex": 123,
"finished": true,
"planId": 123,
"regularPrice": 123,
"startedAt": 123,
"trials": [
{
"compareAtPrice": 123,
"duration": 123,
"intervalCount": 123,
"intervalUnit": "<string>",
"metadata": {},
"name": "<string>",
"price": 123
}
],
"version": 123
},
"originalPeriodEnd": 123,
"pendingUpdateId": "<string>",
"planId": 123,
"productId": 123,
"quantity": 123,
"returnUrl": "<string>",
"status": 123,
"subscriptionId": "<string>",
"taskTime": "<string>",
"taxPercentage": 123,
"testClock": 123,
"trialEnd": 123,
"type": 123,
"userId": 123,
"vatNumber": "<string>"
},
"subscriptionAmount": 123,
"subscriptionAmountExcludingTax": 123,
"subscriptionId": "<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
},
"taxAmount": 123,
"taxPercentage": 123,
"totalAmount": 123,
"totalAmountExcludingTax": 123,
"trialEnd": 123,
"uniqueId": "<string>",
"userAccount": {
"address": "<string>",
"avatarUrl": "<string>",
"billingType": 123,
"birthday": "<string>",
"city": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"createTime": 123,
"custom": "<string>",
"email": "<string>",
"externalUserId": "<string>",
"facebook": "<string>",
"firstName": "<string>",
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"gender": "<string>",
"id": 123,
"isRisk": 123,
"isSpecial": 123,
"language": "<string>",
"lastLoginAt": 123,
"lastName": "<string>",
"linkedIn": "<string>",
"merchantId": 123,
"metadata": {},
"mobile": "<string>",
"otherSocialInfo": "<string>",
"paymentMethod": "<string>",
"phone": "<string>",
"recurringAmount": 123,
"registrationNumber": "<string>",
"school": "<string>",
"state": "<string>",
"status": 123,
"subscriptionId": "<string>",
"subscriptionName": "<string>",
"subscriptionStatus": 123,
"taxPercentage": 123,
"telegram": "<string>",
"tikTok": "<string>",
"timeZone": "<string>",
"type": 123,
"userName": "<string>",
"vATNumber": "<string>",
"version": 123,
"weChat": "<string>",
"whatsAPP": "<string>",
"zipCode": "<string>"
},
"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
}
]
},
"userSnapshot": {
"address": "<string>",
"avatarUrl": "<string>",
"billingType": 123,
"birthday": "<string>",
"city": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"createTime": 123,
"custom": "<string>",
"email": "<string>",
"externalUserId": "<string>",
"facebook": "<string>",
"firstName": "<string>",
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"gender": "<string>",
"id": 123,
"isRisk": 123,
"isSpecial": 123,
"language": "<string>",
"lastLoginAt": 123,
"lastName": "<string>",
"linkedIn": "<string>",
"merchantId": 123,
"metadata": {},
"mobile": "<string>",
"otherSocialInfo": "<string>",
"paymentMethod": "<string>",
"phone": "<string>",
"recurringAmount": 123,
"registrationNumber": "<string>",
"school": "<string>",
"state": "<string>",
"status": 123,
"subscriptionId": "<string>",
"subscriptionName": "<string>",
"subscriptionStatus": 123,
"taxPercentage": 123,
"telegram": "<string>",
"tikTok": "<string>",
"timeZone": "<string>",
"type": 123,
"userName": "<string>",
"vATNumber": "<string>",
"version": 123,
"weChat": "<string>",
"whatsAPP": "<string>",
"zipCode": "<string>"
},
"vatNumber": "<string>"
}
},
"merchantId": 123,
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Endpoint Overview
POSThttps://api.unibee.dev/merchant/invoice/edit
Edit invoice of pending status
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 |
|---|---|---|---|
applyPromoCredit | boolean | No | Whether to apply promo credit |
applyPromoCreditAmount | integer | No | Specific promo credit amount to apply (optional) |
currency | string | No | The currency of invoice |
finish | boolean | No | |
gatewayId | integer | No | The gateway id of invoice |
invoiceId | string | Yes | The unique id of invoice |
lines | array | No | |
name | string | No | The name of invoice |
taxPercentage | integer | No | The tax percentage of invoice，1000=10% |
Request examples
cURL
curl -X POST "https://api.unibee.dev/merchant/invoice/edit" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"applyPromoCredit": false,
"applyPromoCreditAmount": 0,
"currency": "",
"finish": false,
"gatewayId": 0,
"invoiceId": "id_example",
"lines": [],
"name": "",
"taxPercentage": 0
}'
Sandbox
curl -X POST "https://api-sandbox.unibee.top/merchant/invoice/edit" \
-H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"applyPromoCredit": false,
"applyPromoCreditAmount": 0,
"currency": "",
"finish": false,
"gatewayId": 0,
"invoiceId": "id_example",
"lines": [],
"name": "",
"taxPercentage": 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.invoice | 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
Edit invoice of pending status
The unique id of invoice
Whether to apply promo credit
Specific promo credit amount to apply (optional)
The currency of invoice
The gateway id of invoice
Show child attributes
Show child attributes
The name of invoice
The tax percentage of invoice，1000=10%
⌘I