curl --request POST \
--url https://api.unibee.dev/merchant/subscription/new_onetime_addon_payment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"addonId": 123,
"quantity": 123,
"applyPromoCredit": true,
"applyPromoCreditAmount": 123,
"cancelUrl": "<string>",
"currency": "<string>",
"discountAmount": 123,
"discountCode": "<string>",
"discountPercentage": 123,
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"metadata": {},
"returnUrl": "<string>",
"subscriptionId": "<string>",
"taxPercentage": 123,
"userId": 123
}
'{
"code": 123,
"data": {
"invoice": {
"PaymentMethodId": "<string>",
"autoCharge": true,
"billingCycleAnchor": 123,
"bizType": 123,
"countryCode": "<string>",
"createFrom": "<string>",
"creditAccount": {
"amount": 123,
"createTime": 123,
"currency": "<string>",
"currencyAmount": 123,
"exchangeRate": 123,
"id": 123,
"payoutEnable": 123,
"rechargeEnable": 123,
"totalDecrementAmount": 123,
"totalIncrementAmount": 123,
"type": 123,
"userId": 123
},
"creditPayout": {
"creditAmount": 123,
"currencyAmount": 123,
"exchangeRate": 123
},
"cryptoAmount": 123,
"cryptoCurrency": "<string>",
"currency": "<string>",
"data": "<string>",
"dayUtilDue": 123,
"discount": {
"advance": true,
"billingType": 123,
"code": "<string>",
"createTime": 123,
"currency": "<string>",
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"discountType": 123,
"endTime": 123,
"id": 123,
"isDeleted": 123,
"merchantId": 123,
"metadata": {},
"name": "<string>",
"planApplyGroup": {
"currency": [
"<string>"
],
"groupPlanIntervalSelector": [
{
"intervalCount": 123,
"intervalUnit": "<string>"
}
],
"type": [
123
]
},
"planApplyType": 123,
"planIds": [
123
],
"quantity": 123,
"startTime": 123,
"status": 123,
"upgradeLongerOnly": true,
"upgradeOnly": true,
"userLimit": 123,
"userScope": 123
},
"discountAmount": 123,
"discountCode": "<string>",
"finishTime": 123,
"gatewayId": 123,
"id": 123,
"invoiceId": "<string>",
"invoiceName": "<string>",
"lines": [
{
"amount": 123,
"amountExcludingTax": 123,
"currency": "<string>",
"description": "<string>",
"discountAmount": 123,
"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>",
"originAmount": 123,
"originUnitAmountExcludeTax": 123,
"pdfDescription": "<string>",
"periodEnd": 123,
"periodStart": 123,
"plan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"promoCreditDiscountAmount": 123,
"proration": true,
"quantity": 123,
"tax": 123,
"taxCode": "<string>",
"taxPercentage": 123,
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"unitAmountExcludingTax": 123
}
],
"link": "<string>",
"metadata": {},
"originAmount": 123,
"partialCreditPaidAmount": 123,
"paymentId": "<string>",
"paymentLink": "<string>",
"paymentType": "<string>",
"periodEnd": 123,
"periodStart": 123,
"planSnapshot": {
"addons": [
{
"addonPlan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"quantity": 123
}
],
"autoCharge": true,
"chargeType": 123,
"plan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"previousAddons": [
{
"addonPlan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"quantity": 123
}
],
"previousPlan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
}
},
"productName": "<string>",
"promoCreditAccount": {
"amount": 123,
"createTime": 123,
"currency": "<string>",
"currencyAmount": 123,
"exchangeRate": 123,
"id": 123,
"payoutEnable": 123,
"rechargeEnable": 123,
"totalDecrementAmount": 123,
"totalIncrementAmount": 123,
"type": 123,
"userId": 123
},
"promoCreditDiscountAmount": 123,
"promoCreditPayout": {
"creditAmount": 123,
"currencyAmount": 123,
"exchangeRate": 123
},
"promoCreditTransaction": {
"accountType": 123,
"bizId": "<string>",
"by": "<string>",
"createTime": 123,
"creditAmountAfter": 123,
"creditAmountBefore": 123,
"creditId": 123,
"currency": "<string>",
"deltaAmount": 123,
"deltaCurrencyAmount": 123,
"description": "<string>",
"exchangeRate": 123,
"id": 123,
"invoiceId": "<string>",
"merchantId": 123,
"name": "<string>",
"transactionId": "<string>",
"transactionType": 123,
"userId": 123
},
"prorationDate": 123,
"prorationScale": 123,
"refundId": "<string>",
"sendNote": "<string>",
"sendStatus": 123,
"status": 123,
"subscriptionAmount": 123,
"subscriptionAmountExcludingTax": 123,
"subscriptionId": "<string>",
"taxAmount": 123,
"taxPercentage": 123,
"totalAmount": 123,
"totalAmountExcludingTax": 123,
"trialEnd": 123,
"userId": 123,
"userMetricChargeForInvoice": {
"meteredChargeStats": [
{
"metricId": 123,
"CurrentUsedValue": 123,
"chargePricing": {
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
},
"description": "<string>",
"lines": [
{
"amount": 123,
"flatAmount": 123,
"quantity": 123,
"step": "<string>",
"unitAmount": 123
}
],
"maxEventId": 123,
"minEventId": 123,
"name": "<string>",
"totalChargeAmount": 123
}
],
"recurringChargeStats": [
{
"metricId": 123,
"CurrentUsedValue": 123,
"chargePricing": {
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
},
"description": "<string>",
"lines": [
{
"amount": 123,
"flatAmount": 123,
"quantity": 123,
"step": "<string>",
"unitAmount": 123
}
],
"maxEventId": 123,
"minEventId": 123,
"name": "<string>",
"totalChargeAmount": 123
}
]
},
"vatNumber": "<string>"
},
"link": "<string>",
"paid": true,
"subscriptionOnetimeAddon": {
"addonId": 123,
"createTime": 123,
"id": 123,
"invoiceId": "<string>",
"isDeleted": 123,
"metadata": {},
"paymentId": "<string>",
"paymentLink": "<string>",
"quantity": 123,
"status": 123,
"subscriptionId": "<string>"
}
},
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Create payment for subscription onetime addon purchase
curl --request POST \
--url https://api.unibee.dev/merchant/subscription/new_onetime_addon_payment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"addonId": 123,
"quantity": 123,
"applyPromoCredit": true,
"applyPromoCreditAmount": 123,
"cancelUrl": "<string>",
"currency": "<string>",
"discountAmount": 123,
"discountCode": "<string>",
"discountPercentage": 123,
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"metadata": {},
"returnUrl": "<string>",
"subscriptionId": "<string>",
"taxPercentage": 123,
"userId": 123
}
'{
"code": 123,
"data": {
"invoice": {
"PaymentMethodId": "<string>",
"autoCharge": true,
"billingCycleAnchor": 123,
"bizType": 123,
"countryCode": "<string>",
"createFrom": "<string>",
"creditAccount": {
"amount": 123,
"createTime": 123,
"currency": "<string>",
"currencyAmount": 123,
"exchangeRate": 123,
"id": 123,
"payoutEnable": 123,
"rechargeEnable": 123,
"totalDecrementAmount": 123,
"totalIncrementAmount": 123,
"type": 123,
"userId": 123
},
"creditPayout": {
"creditAmount": 123,
"currencyAmount": 123,
"exchangeRate": 123
},
"cryptoAmount": 123,
"cryptoCurrency": "<string>",
"currency": "<string>",
"data": "<string>",
"dayUtilDue": 123,
"discount": {
"advance": true,
"billingType": 123,
"code": "<string>",
"createTime": 123,
"currency": "<string>",
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"discountType": 123,
"endTime": 123,
"id": 123,
"isDeleted": 123,
"merchantId": 123,
"metadata": {},
"name": "<string>",
"planApplyGroup": {
"currency": [
"<string>"
],
"groupPlanIntervalSelector": [
{
"intervalCount": 123,
"intervalUnit": "<string>"
}
],
"type": [
123
]
},
"planApplyType": 123,
"planIds": [
123
],
"quantity": 123,
"startTime": 123,
"status": 123,
"upgradeLongerOnly": true,
"upgradeOnly": true,
"userLimit": 123,
"userScope": 123
},
"discountAmount": 123,
"discountCode": "<string>",
"finishTime": 123,
"gatewayId": 123,
"id": 123,
"invoiceId": "<string>",
"invoiceName": "<string>",
"lines": [
{
"amount": 123,
"amountExcludingTax": 123,
"currency": "<string>",
"description": "<string>",
"discountAmount": 123,
"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>",
"originAmount": 123,
"originUnitAmountExcludeTax": 123,
"pdfDescription": "<string>",
"periodEnd": 123,
"periodStart": 123,
"plan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"promoCreditDiscountAmount": 123,
"proration": true,
"quantity": 123,
"tax": 123,
"taxCode": "<string>",
"taxPercentage": 123,
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"unitAmountExcludingTax": 123
}
],
"link": "<string>",
"metadata": {},
"originAmount": 123,
"partialCreditPaidAmount": 123,
"paymentId": "<string>",
"paymentLink": "<string>",
"paymentType": "<string>",
"periodEnd": 123,
"periodStart": 123,
"planSnapshot": {
"addons": [
{
"addonPlan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"quantity": 123
}
],
"autoCharge": true,
"chargeType": 123,
"plan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"previousAddons": [
{
"addonPlan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
},
"quantity": 123
}
],
"previousPlan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"checkoutUrl": "<string>",
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"disableAutoCharge": 123,
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"internalName": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"metricLimits": [
{
"metricId": 123,
"metricLimit": 123
}
],
"metricMeteredCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"metricRecurringCharge": [
{
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
}
],
"multiCurrencies": [
{
"amount": 123,
"autoExchange": true,
"currency": "<string>",
"disable": true,
"exchangeRate": 123
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123,
"usVATConfig": {
"active": true,
"fromAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
},
"nexusAddresses": [
{
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
],
"sellOnUSOnly": true,
"taxCode": "<string>",
"toAddress": {
"address": "<string>",
"city": "<string>",
"countryCode": "<string>",
"state": "<string>",
"verified": true,
"zipCode": "<string>"
}
}
}
},
"productName": "<string>",
"promoCreditAccount": {
"amount": 123,
"createTime": 123,
"currency": "<string>",
"currencyAmount": 123,
"exchangeRate": 123,
"id": 123,
"payoutEnable": 123,
"rechargeEnable": 123,
"totalDecrementAmount": 123,
"totalIncrementAmount": 123,
"type": 123,
"userId": 123
},
"promoCreditDiscountAmount": 123,
"promoCreditPayout": {
"creditAmount": 123,
"currencyAmount": 123,
"exchangeRate": 123
},
"promoCreditTransaction": {
"accountType": 123,
"bizId": "<string>",
"by": "<string>",
"createTime": 123,
"creditAmountAfter": 123,
"creditAmountBefore": 123,
"creditId": 123,
"currency": "<string>",
"deltaAmount": 123,
"deltaCurrencyAmount": 123,
"description": "<string>",
"exchangeRate": 123,
"id": 123,
"invoiceId": "<string>",
"merchantId": 123,
"name": "<string>",
"transactionId": "<string>",
"transactionType": 123,
"userId": 123
},
"prorationDate": 123,
"prorationScale": 123,
"refundId": "<string>",
"sendNote": "<string>",
"sendStatus": 123,
"status": 123,
"subscriptionAmount": 123,
"subscriptionAmountExcludingTax": 123,
"subscriptionId": "<string>",
"taxAmount": 123,
"taxPercentage": 123,
"totalAmount": 123,
"totalAmountExcludingTax": 123,
"trialEnd": 123,
"userId": 123,
"userMetricChargeForInvoice": {
"meteredChargeStats": [
{
"metricId": 123,
"CurrentUsedValue": 123,
"chargePricing": {
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
},
"description": "<string>",
"lines": [
{
"amount": 123,
"flatAmount": 123,
"quantity": 123,
"step": "<string>",
"unitAmount": 123
}
],
"maxEventId": 123,
"minEventId": 123,
"name": "<string>",
"totalChargeAmount": 123
}
],
"recurringChargeStats": [
{
"metricId": 123,
"CurrentUsedValue": 123,
"chargePricing": {
"chargeType": 123,
"graduatedAmounts": [
{
"endValue": 123,
"flatAmount": 123,
"perAmount": 123,
"startValue": 123
}
],
"metricId": 123,
"standardAmount": 123,
"standardStartValue": 123
},
"description": "<string>",
"lines": [
{
"amount": 123,
"flatAmount": 123,
"quantity": 123,
"step": "<string>",
"unitAmount": 123
}
],
"maxEventId": 123,
"minEventId": 123,
"name": "<string>",
"totalChargeAmount": 123
}
]
},
"vatNumber": "<string>"
},
"link": "<string>",
"paid": true,
"subscriptionOnetimeAddon": {
"addonId": 123,
"createTime": 123,
"id": 123,
"invoiceId": "<string>",
"isDeleted": 123,
"metadata": {},
"paymentId": "<string>",
"paymentLink": "<string>",
"quantity": 123,
"status": 123,
"subscriptionId": "<string>"
}
},
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Create payment for subscription onetime addon purchase
AddonId, id of one-time addon, the new payment will created base on the addon's amount'
Quantity, quantity of the new payment which one-time addon purchased
apply promo credit or not
apply promo credit amount, auto compute if not specified
CancelUrl, back to cancelUrl if user cancel the payment
The currency of payment
Amount of discount
DiscountCode
Percentage of discount, 100=1%, ignore if discountAmount specified
GatewayId, use user's gateway if not provide
Gateway Payment Type
ReturnUrl, the addon's payment will redirect based on the returnUrl provided when it's back from gateway side
SubscriptionId, id of subscription which addon will attached, either SubscriptionId or UserId needed, The only one active subscription of userId will attach the addon
TaxPercentage,1000 = 10%, default user's taxPercentage if not specified
UserId, either SubscriptionId or UserId needed, The only one active subscription will update if userId provide instead of subscriptionId
Show child attributes
Show child attributes
billing_cycle_anchor
biz type from payment 1-onetime payment, 3-subscription
create from
Show child attributes
credit amount, in cent if type is main
create utc time
currency
currency amount, in cent
keep two decimal places,multiply by 100 saved, 1 currency = 1 credit * (exchange_rate/100), main account fixed rate to 100
Id
0-no, 1-yes
0-no, 1-yes
the total decrement amount
the total increment amount
type of credit account, 1-main account, 2-gift account
user_id
Show child attributes
credit amount, scale = 100
currency amount,cent
exchange rate, keep two decimal places,scale = 100, 1 currency = 1 credit * (exchange_rate/100), main account fixed rate to 100
crypto_amount, cent
crypto_currency
day util due after finish
Show child attributes
AdvanceConfig, 0-false,1-true, will enable all advance config if set true
billing_type, 1-one-time, 2-recurring
code
create utc time
currency of discount, available when discount_type is fixed_amount
the count limitation of subscription cycle , 0-no limit
amount of discount, available when discount_type is fixed_amount
percentage of discount, 100=1%, available when discount_type is percentage
discount_type, 1-percentage, 2-fixed_amount
end of discount available utc time, 0-invalid
Id
0-UnDeleted,> 0, Deleted, the deleted utc time
merchantId
name
Show child attributes
1-main plan,2-addon plan,3-onetime
plan apply type, 0-apply for all, 1-apply for plans specified, 2-exclude for plans specified, 3-Apply to Plans by Groups(Billing Period Included), 4-Apply to Plans except by Groups(Billing Period Included)
Ids of plan which discount code can effect, default effect all plans if not set
quantity of code, 0-no limit
start of discount available utc time
status, 1-editable, 2-active, 3-deactivate, 4-expire, 10-archive
AdvanceConfig, 0-false,1-true, will forbid for all except upgrade to longer plan if set true
AdvanceConfig, 0-false,1-true, will forbid for all except same interval upgrade action if set true
AdvanceConfig, The limit of every customer can apply, the recurring apply not involved, 0-unlimited
AdvanceConfig, Apply user scope,0-for all, 1-for only new user, 2-for only renewals, renewals is upgrade&downgrade&renew
Show child attributes
Show child attributes
Show child attributes
MetricId
CurrentUsedValue
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Description
Lines
Show child attributes
Amount,cent
FlatAmount,cent
Quantity
Step
UnitAmount,cent
Name
TotalChargeAmount
Show child attributes
amount, cent, without tax
binded recurring addon planIds,split with ,
binded onetime addon planIds,split with ,
whether cancel at subscription first trial end,0-false | 1-true, will pass to cancelAtPeriodEnd of subscription
CheckoutUrl
create utc time
currency
description
disable auto-charge, 0-false,1-true
external_user_id
who pay the gas, merchant|user
home_url
image_url
PlanInternalName
period unit count
period unit,day|month|year|week
merchant id
Plan's MetricMeteredCharge
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Plan's MetricRecurringCharge
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Plan's MultiCurrencies
Show child attributes
the amount of exchange rate
using https://app.exchangerate-api.com/ to update exchange rate if true, the exchange APIKey need setup first
target currency
disable currency exchange
exchange rate, no setup required if AutoExchange is true
PlanName
product id
1-UnPublish,2-Publish, Use For Display Plan At UserPortal
status,1-editing,2-active,3-inactive,4-soft archive, 5-hard archive
TaxPercentage 1000 = 10%
price of trial period
duration of trial
type,1-main plan,2-addon plan
Show child attributes
Show child attributes
Show child attributes
Show child attributes
promo credit discount amount
Tax Percentage,1000 = 10%
Show child attributes
invoice link
partial credit paid amount
paymentId
invoice payment link
Show child attributes
Addons associated with the current plan.
Show child attributes
Show child attributes
amount, cent, without tax
binded recurring addon planIds,split with ,
binded onetime addon planIds,split with ,
whether cancel at subscription first trial end,0-false | 1-true, will pass to cancelAtPeriodEnd of subscription
CheckoutUrl
create utc time
currency
description
disable auto-charge, 0-false,1-true
external_user_id
who pay the gas, merchant|user
home_url
image_url
PlanInternalName
period unit count
period unit,day|month|year|week
merchant id
Plan's MetricMeteredCharge
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Plan's MetricRecurringCharge
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Plan's MultiCurrencies
Show child attributes
the amount of exchange rate
using https://app.exchangerate-api.com/ to update exchange rate if true, the exchange APIKey need setup first
target currency
disable currency exchange
exchange rate, no setup required if AutoExchange is true
PlanName
product id
1-UnPublish,2-Publish, Use For Display Plan At UserPortal
status,1-editing,2-active,3-inactive,4-soft archive, 5-hard archive
TaxPercentage 1000 = 10%
price of trial period
duration of trial
type,1-main plan,2-addon plan
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Quantity
Billing charge
Billing charge type. 0: One-time, 1: New Subscription, 2: Upgrade, 3: Downgrade, 4: Renewal, 5: Billing Cycle Charge.
Show child attributes
amount, cent, without tax
binded recurring addon planIds,split with ,
binded onetime addon planIds,split with ,
whether cancel at subscription first trial end,0-false | 1-true, will pass to cancelAtPeriodEnd of subscription
CheckoutUrl
create utc time
currency
description
disable auto-charge, 0-false,1-true
external_user_id
who pay the gas, merchant|user
home_url
image_url
PlanInternalName
period unit count
period unit,day|month|year|week
merchant id
Plan's MetricMeteredCharge
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Plan's MetricRecurringCharge
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Plan's MultiCurrencies
Show child attributes
the amount of exchange rate
using https://app.exchangerate-api.com/ to update exchange rate if true, the exchange APIKey need setup first
target currency
disable currency exchange
exchange rate, no setup required if AutoExchange is true
PlanName
product id
1-UnPublish,2-Publish, Use For Display Plan At UserPortal
status,1-editing,2-active,3-inactive,4-soft archive, 5-hard archive
TaxPercentage 1000 = 10%
price of trial period
duration of trial
type,1-main plan,2-addon plan
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Addons from the previous plan, relevant for upgrade or downgrade (paidType = 2 or 3).
Show child attributes
Show child attributes
amount, cent, without tax
binded recurring addon planIds,split with ,
binded onetime addon planIds,split with ,
whether cancel at subscription first trial end,0-false | 1-true, will pass to cancelAtPeriodEnd of subscription
CheckoutUrl
create utc time
currency
description
disable auto-charge, 0-false,1-true
external_user_id
who pay the gas, merchant|user
home_url
image_url
PlanInternalName
period unit count
period unit,day|month|year|week
merchant id
Plan's MetricMeteredCharge
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Plan's MetricRecurringCharge
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Plan's MultiCurrencies
Show child attributes
the amount of exchange rate
using https://app.exchangerate-api.com/ to update exchange rate if true, the exchange APIKey need setup first
target currency
disable currency exchange
exchange rate, no setup required if AutoExchange is true
PlanName
product id
1-UnPublish,2-Publish, Use For Display Plan At UserPortal
status,1-editing,2-active,3-inactive,4-soft archive, 5-hard archive
TaxPercentage 1000 = 10%
price of trial period
duration of trial
type,1-main plan,2-addon plan
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Quantity
Show child attributes
amount, cent, without tax
binded recurring addon planIds,split with ,
binded onetime addon planIds,split with ,
whether cancel at subscription first trial end,0-false | 1-true, will pass to cancelAtPeriodEnd of subscription
CheckoutUrl
create utc time
currency
description
disable auto-charge, 0-false,1-true
external_user_id
who pay the gas, merchant|user
home_url
image_url
PlanInternalName
period unit count
period unit,day|month|year|week
merchant id
Plan's MetricMeteredCharge
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Plan's MetricRecurringCharge
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Plan's MultiCurrencies
Show child attributes
the amount of exchange rate
using https://app.exchangerate-api.com/ to update exchange rate if true, the exchange APIKey need setup first
target currency
disable currency exchange
exchange rate, no setup required if AutoExchange is true
PlanName
product id
1-UnPublish,2-Publish, Use For Display Plan At UserPortal
status,1-editing,2-active,3-inactive,4-soft archive, 5-hard archive
TaxPercentage 1000 = 10%
price of trial period
duration of trial
type,1-main plan,2-addon plan
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
credit amount, in cent if type is main
create utc time
currency
currency amount, in cent
keep two decimal places,multiply by 100 saved, 1 currency = 1 credit * (exchange_rate/100), main account fixed rate to 100
Id
0-no, 1-yes
0-no, 1-yes
the total decrement amount
the total increment amount
type of credit account, 1-main account, 2-gift account
user_id
promo credit discount amount
Show child attributes
credit amount, scale = 100
currency amount,cent
exchange rate, keep two decimal places,scale = 100, 1 currency = 1 credit * (exchange_rate/100), main account fixed rate to 100
Show child attributes
type of credit account, 1-main recharge account, 2-promo credit account
business id
create utc time
the credit amount after transaction,cent
the credit amount before transaction,cent
id of credit account
currency
delta amount,cent
delta currency amount, in cent
recharge transaction description
ExchangeRate for transaction, keep two decimal places,multiply by 100 saved, 1 currency = 1 credit * (exchange_rate/100), main account fixed rate to 100
Id
invoice_id
merchant id
recharge transaction title
unique id for timeline
transaction type。1-recharge income,2-payment out,3-refund income,4-withdraw out,5-withdraw failed income, 6-admin change,7-recharge refund out
user_id
refundId
send_note
email send status,0-No | 1- YES| 2-Unnecessary
status,1-pending|2-processing|3-paid | 4-failed | 5-cancelled
subscription_id
TaxPercentage,1000 = 10%
trial_end, utc time
UserId
Show child attributes
MeteredChargeStats
Show child attributes
MetricId
CurrentUsedValue
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Description
Lines
Show child attributes
Amount,cent
FlatAmount,cent
Quantity
Step
UnitAmount,cent
Name
TotalChargeAmount
RecurringChargeStats
Show child attributes
MetricId
CurrentUsedValue
Show child attributes
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
Show child attributes
EndValue, -1 = infinity value(∞)
FlatAmount,cent
PerAmount,cent
StartValue
MetricId
StandardAmount, cent, used for standard pricing,cent
StandardStartValue, used for standard pricing
Description
Lines
Show child attributes
Amount,cent
FlatAmount,cent
Quantity
Step
UnitAmount,cent
Name
TotalChargeAmount
if automatic payment is false, Gateway Link will provided that manual payment needed
true|false,automatic payment is default behavior for one-time addon purchased, payment will create attach to the purchase, when payment is success, return false, otherwise false
Show child attributes
onetime addonId
create utc time
id
invoice id
0-UnDeleted,1-Deleted
PaymentId
PaymentLink
quantity
status, 1-create, 2-paid, 3-cancel, 4-expired
subscription_id