curl --request GET \
--url https://api.unibee.dev/merchant/discount/user_discount_list \
--header 'Authorization: Bearer <token>'{
"code": 123,
"data": {
"total": 123,
"userDiscounts": [
{
"applyAmount": 123,
"code": "<string>",
"createTime": 123,
"currency": "<string>",
"id": 123,
"invoiceId": "<string>",
"merchantId": 123,
"paymentId": "<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>"
}
}
},
"recurring": 123,
"status": 123,
"subscriptionId": "<string>",
"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>"
}
}
]
},
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Get user discountCode list
curl --request GET \
--url https://api.unibee.dev/merchant/discount/user_discount_list \
--header 'Authorization: Bearer <token>'{
"code": 123,
"data": {
"total": 123,
"userDiscounts": [
{
"applyAmount": 123,
"code": "<string>",
"createTime": 123,
"currency": "<string>",
"id": 123,
"invoiceId": "<string>",
"merchantId": 123,
"paymentId": "<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>"
}
}
},
"recurring": 123,
"status": 123,
"subscriptionId": "<string>",
"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>"
}
}
]
},
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The discount's Id
Filter UserIds Default All
Filter Email Default All
Filter PlanIds Default All
Sort Field,gmt_create|gmt_modify,Default gmt_modify
Sort Type,asc|desc,Default desc
Page, Start 0
Count Of Per Page
CreateTimeStart,UTC timestamp,seconds
CreateTimeEnd,UTC timestamp,seconds
Show child attributes
Total
User Discount Object List
Show child attributes
apply_amount
code
create utc time
currency
ID
invoice_id
merchantId
payment_id
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
is recurring apply, 0-no, 1-yes
status, 1-finished, 2-rollback
subscription_id
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