curl --request POST \
--url https://api.unibee.dev/merchant/subscription/create_preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"planId": 123,
"addonParams": [
{
"addonPlanId": 123,
"quantity": 123
}
],
"applyPromoCredit": true,
"applyPromoCreditAmount": 123,
"currency": "<string>",
"discountCode": "<string>",
"email": "<string>",
"externalUserId": "<string>",
"freeInInitialPeriod": true,
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"quantity": 123,
"taxPercentage": 123,
"trialEnd": 123,
"user": {
"email": "<string>",
"address": "<string>",
"city": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"externalUserId": "<string>",
"firstName": "<string>",
"language": "<string>",
"lastName": "<string>",
"phone": "<string>",
"registrationNumber": "<string>",
"state": "<string>",
"type": 123,
"userName": "<string>",
"vatNumber": "<string>",
"zipCode": "<string>"
},
"userId": 123,
"vatCountryCode": "<string>",
"vatNumber": "<string>"
}
'{
"code": 123,
"data": {
"addonParams": [
{
"addonPlanId": 123,
"quantity": 123
}
],
"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
}
],
"applyPromoCredit": true,
"currency": "<string>",
"discount": {
"advance": true,
"billingType": 123,
"code": "<string>",
"createTime": 123,
"currency": "<string>",
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"discountType": 123,
"endTime": 123,
"id": 123,
"isDeleted": 123,
"merchantId": 123,
"metadata": {},
"name": "<string>",
"planApplyGroup": {
"currency": [
"<string>"
],
"groupPlanIntervalSelector": [
{
"intervalCount": 123,
"intervalUnit": "<string>"
}
],
"type": [
123
]
},
"planApplyType": 123,
"planIds": [
123
],
"quantity": 123,
"startTime": 123,
"status": 123,
"upgradeLongerOnly": true,
"upgradeOnly": true,
"userLimit": 123,
"userScope": 123
},
"discountAmount": 123,
"discountMessage": "<string>",
"email": "<string>",
"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>"
},
"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>"
},
"originAmount": 123,
"otherActiveSubscriptionId": "<string>",
"otherPendingCryptoSubscription": {
"addonParams": [
{
"addonPlanId": 123,
"quantity": 123
}
],
"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
}
],
"dayLeft": 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
},
"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>"
},
"latestInvoice": {
"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>"
},
"note": "<string>",
"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>"
}
}
},
"source": "<string>",
"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>",
"link": "<string>",
"merchantId": 123,
"metadata": {},
"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>"
},
"unfinishedSubscriptionPendingUpdate": {
"addonData": "<string>",
"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
}
],
"amount": 123,
"currency": "<string>",
"effectImmediate": 123,
"effectTime": 123,
"gatewayId": 123,
"gmtCreate": "<string>",
"gmtModify": "<string>",
"invoiceId": "<string>",
"link": "<string>",
"merchantId": 123,
"merchantMember": {
"MemberGroupPermission": {},
"MemberRoles": [
{
"createTime": 123,
"id": 123,
"merchantId": 123,
"permissions": [
{
"group": "<string>",
"permissions": [
"<string>"
]
}
],
"role": "<string>"
}
],
"createTime": 123,
"currentDeviceIdentity": "<string>",
"deviceList": [
{
"currentDevice": true,
"identity": "<string>",
"ipAddress": "<string>",
"lastActiveTime": 123,
"lastLoginTime": 123,
"lastTotpVerificationTime": 123,
"name": "<string>",
"status": true
}
],
"email": "<string>",
"firstName": "<string>",
"id": 123,
"isBlankPasswd": true,
"isOwner": true,
"lastName": "<string>",
"merchantId": 123,
"mobile": "<string>",
"oauthAccounts": [
{
"email": "<string>",
"emailVerified": true,
"image": "<string>",
"name": "<string>",
"provider": "<string>",
"providerId": "<string>"
}
],
"status": 123,
"totpType": 123
},
"metadata": {},
"note": "<string>",
"paid": 123,
"pendingUpdateId": "<string>",
"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>"
}
}
},
"planId": 123,
"prorationAmount": 123,
"quantity": 123,
"status": 123,
"subscriptionId": "<string>",
"updateAddonData": "<string>",
"updateAddons": [
{
"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
}
],
"updateAmount": 123,
"updateCurrency": "<string>",
"updatePlan": {
"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>"
}
}
},
"updatePlanId": 123,
"updateQuantity": 123,
"userId": 123
},
"user": {
"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>"
}
},
"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>"
}
}
},
"quantity": 123,
"subscriptionAmountExcludingTax": 123,
"taxAmount": 123,
"taxPercentage": 123,
"totalAmount": 123,
"trialEnd": 123,
"userId": 123,
"vatCountryCode": "<string>",
"vatCountryName": "<string>",
"vatNumber": "<string>",
"vatNumberValidate": {
"companyAddress": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"valid": true,
"validateMessage": "<string>",
"vatNumber": "<string>"
},
"vatNumberValidateMessage": "<string>"
},
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}curl --request POST \
--url https://api.unibee.dev/merchant/subscription/create_preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"planId": 123,
"addonParams": [
{
"addonPlanId": 123,
"quantity": 123
}
],
"applyPromoCredit": true,
"applyPromoCreditAmount": 123,
"currency": "<string>",
"discountCode": "<string>",
"email": "<string>",
"externalUserId": "<string>",
"freeInInitialPeriod": true,
"gatewayId": 123,
"gatewayPaymentType": "<string>",
"quantity": 123,
"taxPercentage": 123,
"trialEnd": 123,
"user": {
"email": "<string>",
"address": "<string>",
"city": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"externalUserId": "<string>",
"firstName": "<string>",
"language": "<string>",
"lastName": "<string>",
"phone": "<string>",
"registrationNumber": "<string>",
"state": "<string>",
"type": 123,
"userName": "<string>",
"vatNumber": "<string>",
"zipCode": "<string>"
},
"userId": 123,
"vatCountryCode": "<string>",
"vatNumber": "<string>"
}
'{
"code": 123,
"data": {
"addonParams": [
{
"addonPlanId": 123,
"quantity": 123
}
],
"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
}
],
"applyPromoCredit": true,
"currency": "<string>",
"discount": {
"advance": true,
"billingType": 123,
"code": "<string>",
"createTime": 123,
"currency": "<string>",
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"discountType": 123,
"endTime": 123,
"id": 123,
"isDeleted": 123,
"merchantId": 123,
"metadata": {},
"name": "<string>",
"planApplyGroup": {
"currency": [
"<string>"
],
"groupPlanIntervalSelector": [
{
"intervalCount": 123,
"intervalUnit": "<string>"
}
],
"type": [
123
]
},
"planApplyType": 123,
"planIds": [
123
],
"quantity": 123,
"startTime": 123,
"status": 123,
"upgradeLongerOnly": true,
"upgradeOnly": true,
"userLimit": 123,
"userScope": 123
},
"discountAmount": 123,
"discountMessage": "<string>",
"email": "<string>",
"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>"
},
"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>"
},
"originAmount": 123,
"otherActiveSubscriptionId": "<string>",
"otherPendingCryptoSubscription": {
"addonParams": [
{
"addonPlanId": 123,
"quantity": 123
}
],
"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
}
],
"dayLeft": 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
},
"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>"
},
"latestInvoice": {
"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>"
},
"note": "<string>",
"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>"
}
}
},
"source": "<string>",
"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>",
"link": "<string>",
"merchantId": 123,
"metadata": {},
"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>"
},
"unfinishedSubscriptionPendingUpdate": {
"addonData": "<string>",
"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
}
],
"amount": 123,
"currency": "<string>",
"effectImmediate": 123,
"effectTime": 123,
"gatewayId": 123,
"gmtCreate": "<string>",
"gmtModify": "<string>",
"invoiceId": "<string>",
"link": "<string>",
"merchantId": 123,
"merchantMember": {
"MemberGroupPermission": {},
"MemberRoles": [
{
"createTime": 123,
"id": 123,
"merchantId": 123,
"permissions": [
{
"group": "<string>",
"permissions": [
"<string>"
]
}
],
"role": "<string>"
}
],
"createTime": 123,
"currentDeviceIdentity": "<string>",
"deviceList": [
{
"currentDevice": true,
"identity": "<string>",
"ipAddress": "<string>",
"lastActiveTime": 123,
"lastLoginTime": 123,
"lastTotpVerificationTime": 123,
"name": "<string>",
"status": true
}
],
"email": "<string>",
"firstName": "<string>",
"id": 123,
"isBlankPasswd": true,
"isOwner": true,
"lastName": "<string>",
"merchantId": 123,
"mobile": "<string>",
"oauthAccounts": [
{
"email": "<string>",
"emailVerified": true,
"image": "<string>",
"name": "<string>",
"provider": "<string>",
"providerId": "<string>"
}
],
"status": 123,
"totpType": 123
},
"metadata": {},
"note": "<string>",
"paid": 123,
"pendingUpdateId": "<string>",
"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>"
}
}
},
"planId": 123,
"prorationAmount": 123,
"quantity": 123,
"status": 123,
"subscriptionId": "<string>",
"updateAddonData": "<string>",
"updateAddons": [
{
"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
}
],
"updateAmount": 123,
"updateCurrency": "<string>",
"updatePlan": {
"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>"
}
}
},
"updatePlanId": 123,
"updateQuantity": 123,
"userId": 123
},
"user": {
"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>"
}
},
"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>"
}
}
},
"quantity": 123,
"subscriptionAmountExcludingTax": 123,
"taxAmount": 123,
"taxPercentage": 123,
"totalAmount": 123,
"trialEnd": 123,
"userId": 123,
"vatCountryCode": "<string>",
"vatCountryName": "<string>",
"vatNumber": "<string>",
"vatNumberValidate": {
"companyAddress": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"valid": true,
"validateMessage": "<string>",
"vatNumber": "<string>"
},
"vatNumberValidateMessage": "<string>"
},
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
PlanId
apply promo credit or not
apply promo credit amount, auto compute if not specified
The currency of payment
DiscountCode
Email, either ExternalUserId&Email or UserId needed
ExternalUserId, unique, either ExternalUserId&Email or UserId needed
Is free or not for the first period, true or false
GatewayId
Gateway Payment Type
Quantity
TaxPercentage,1000 = 10%
trial_end, utc time
Show child attributes
Address
city
company name
CountryCode
ExternalUserId
First Name
User Language, en|ru|cn|vi|bp
Last Name
Phone
RegistrationNumber
State
User type, 1-Individual|2-Business
UserName
vat number
zip_code
UserId
VatCountryCode, CountryName
VatNumber
Show child attributes
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
apply promo credit or not
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
Whether the gateway finished setup process
Show child attributes
The AccountHolder of wire transfer
The address of wire transfer
The ABARoutingNumber of wire transfer
The CNAPS of wire transfer
The Remarks additional content
The Account Number
The Bank Name
The BIC of wire transfer
The BSB Code
The IBAN of wire transfer
The Swift Code
create utc time
The currency of wire transfer
The currency exchange for gateway payment, effect at start of payment creation when currency matched
Show child attributes
the exchange rate of gateway, set to 0 if using https://app.exchangerate-api.com/ instead of fixed exchange rate
the currency of gateway exchange from
the currency of gateway exchange to
whether to enable currency exchange
Show child attributes
The description of gateway
The gateway display name, used at user portal
The gateway display name, used at user portal
The gateway name, stripe|paypal|changelly|unitpay|payssion|cryptadium
gatewayPaymentTypes
Show child attributes
gateway type,1-Bank Card | 2-Crypto | 3 - Wire Transfer
The gateway webhook integration guide link, gateway webhook need setup if not blank
The gateway website link
The minimum amount of wire transfer
The name of gateway
The total list of gateway payment types, used for setup
Show child attributes
The sort value of payment gateway, The higher the value, the lower the ranking
The endpoint url of gateway webhook
The secret of gateway webhook
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
other active or incomplete subscription id
Show child attributes
Addon
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
DayLeft util the period end, only available for webhook
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
Show child attributes
Number Of IntervalUnit,em: day|month|year|week
Plan Interval Unit,em: day|month|year|week
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
Whether the gateway finished setup process
Show child attributes
The AccountHolder of wire transfer
The address of wire transfer
The ABARoutingNumber of wire transfer
The CNAPS of wire transfer
The Remarks additional content
The Account Number
The Bank Name
The BIC of wire transfer
The BSB Code
The IBAN of wire transfer
The Swift Code
Show child attributes
create utc time
The currency of wire transfer
The currency exchange for gateway payment, effect at start of payment creation when currency matched
Show child attributes
the exchange rate of gateway, set to 0 if using https://app.exchangerate-api.com/ instead of fixed exchange rate
the currency of gateway exchange from
the currency of gateway exchange to
whether to enable currency exchange
Show child attributes
The description of gateway
The gateway display name, used at user portal
The gateway display name, used at user portal
The gateway name, stripe|paypal|changelly|unitpay|payssion|cryptadium
gatewayPaymentTypes
Show child attributes
gateway type,1-Bank Card | 2-Crypto | 3 - Wire Transfer
The gateway webhook integration guide link, gateway webhook need setup if not blank
The gateway website link
The minimum amount of wire transfer
The name of gateway
The total list of gateway payment types, used for setup
Show child attributes
The sort value of payment gateway, The higher the value, the lower the ranking
The endpoint url of gateway webhook
The secret of gateway webhook
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
Show child attributes
Number Of IntervalUnit,em: day|month|year|week
Plan Interval Unit,em: day|month|year|week
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 MetricLimit List
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 MetricLimit List
Show child attributes
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 MetricLimit List
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
note
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
Source
Show child attributes
plan addon json data
amount, cent
billing_cycle_anchor
whether cancel at period end,0-false | 1-true
the cancel or expire time, utc time, 0 if subscription not in cancelled or expired status
create utc time
currency
current_period_end, utc time
current period paid or not, 1-paid, other-the utc time to expire
current_period_start, utc time
dunning_time, utc time
external_subscription_id
features
first success payment time
who pay the gas, merchant|user
gateway_id
latest_invoice_id
merchant id
original_period_end, utc time
plan id
product id
quantity
status,1-Pending|2-Active|3-PendingInActive | 4-Cancel | 5-Expire | 6- Suspend| 7-Incomplete | 8-Processing | 9- Failed
subscription id
task_time
TaxPercentage,1000 = 10%
test_clock, simulator clock for subscription, if set , sub will out of cronjob controll
trial_end, utc time
sub type, 0-gateway sub, 1-unibee sub
userId
Show child attributes
plan addon json data
Addons
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 MetricLimit List
Show child attributes
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
CaptureAmount, Cent
Currency
EffectImmediate
effect_immediate=0, EffectTime unit_time
Id
GmtCreate
GmtModify
invoice id
Link
MerchantId
Show child attributes
The member group permission map'
Show child attributes
Show child attributes
The member role list'
Show child attributes
create utc time
id
merchant id
permissions
Show child attributes
role
create utc time
The Current DeviceIdentity'
The devices list'
Show child attributes
Is CurrentDevice
Identity
IP Address
Last Active Time
Last Login Time
Last Totp Verification Time
Name
true-Active, false-Offline
first name
userId
is blank password
Check Member is Owner
last name
merchant id
mobile
List of connected OAuth accounts
Show child attributes
0-Active, 2-Suspend
0-Inactive, 1-General, Google Authenticator | 2-Microsoft Authenticator | 3-Authy | 4-1Password | 5-LastPass | 6-FreeOTP | 7-Other TOTP
Update Note
Paid
PendingUpdateId
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 MetricLimit List
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
PlanId
ProrationAmount,Cents
quantity
Status,1-Pending|2-Finished|3-Cancelled
SubscriptionId
UpdateAddonData
UpdateAddons
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 MetricLimit List
Show child attributes
MetricId
MetricLimit
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
UpdateAmount, Cents
UpdateCurrency
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 MetricLimit List
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
UpdatePlanId
UpdateQuantity
UserId
Show child attributes
address
avator url
1-recurring,2-one-time
brithday
city
company name
country_code
country_name
create utc time
Custom
external_user_id
first name
gateway_id
gender
userId
is risk account (deperated)
is special account(0.no,1.yes)- deperated
User Language, en|ru|cn|vi|bp
last login time, utc time
last name
merchant_id
mobile
phone
total recurring amount, cent
RegistrationNumber
school
State
0-Active, 2-Suspend
subscription id
subscription name
sub status, 1-Pending|2-Active|3-PendingInActive | 4-Cancel | 5-Expire | 6- Suspend| 7-Incomplete | 8-Processing | 9-Failed
taxPercentage,1000 = 10%
telegram
tictok
User type, 1-Individual|2-Business
user name
vat number
version
whats app
zip_code
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
trial_end, utc time
Show child attributes