Member Authentication
Merchant
Credit
Promo Credit
Discount
User Discount
Email Template
Gateway
- POSTPayment Gateway Archive
- GETPayment Gateway
- POSTPayment Gateway
- POSTPayment Gateway Edit
- POSTPayment Gateway Country Config Edit
- POSTEdit Payment Gateway Sort
- GETGet Payment Gateway List
- POSTPayment Gateway Setup
- POSTExchange Rate Api Setup
- GETGet Payment Gateway Setup List
- POSTPayment Gateway Webhook Setup
- POSTWire Transfer Edit
- POSTWire Transfer Setup
- POSTSegment Setup
Invoice
- POSTAdmin Cancel Invoice
- POSTDelete Pending Invoice
- GETInvoice Detail
- POSTInvoice Detail
- POSTInvoice Edit
- POSTFinish Invoice
- GETGet Invoice List
- POSTGet Invoice List
- POSTMark Invoice Refund
- POSTMark Invoice Refund As Success
- POSTMark Wire Transfer Invoice As Success
- POSTNew Invoice
- POSTGenerate Invoice PDF
- POSTUpdate Invoice PDF
- POSTAdmin Reconvert Crypto Data and Send Invoice Email
- POSTCreate InvoiceRefund
- POSTSend Invoice Email
Admin Member
Metric
Metric Event
Payment
- POSTCancel Payment
- POSTCapture Payment
- GETPayment Detail
- GETGet OneTime Payment Item List
- GETGet Payment List
- POSTDelete Payment Method
- GETPayment Method
- GETPayment Method List
- POSTCreate New Payment Method
- POSTNew Payment
- POSTCancel Payment Refund
- GETPayment Refund Detail
- GETGet Payment Refund List
- POSTNew Payment Refund
- GETGet Payment TimeLine List
- POSTGet Payment TimeLine List
Plan
Product
Search
Session
Subscription Update
Subscription
- POSTAppend Subscription TrialEnd
- POSTCancel Subscription Immediately
- POSTCancel Subscription At Period End
- POSTCancel Last Cancel Subscription At Period End
- POSTChange Subscription Gateway
- POSTCreate Subscription Preview
- POSTCreate Subscription
- GETSubscription Detail
- POSTSubscription Detail
- GETGet Subscription List
- POSTGet Subscription List
- GETSubscription Next Invoice Preview
- GETUser Pending Crypto Subscription Detail
- POSTUser Pending Crypto Subscription Detail
- GETUser Subscription Detail
- POSTUser Subscription Detail
Subscription Note
Subscription Config
Subscription Payment
Subscription Timeline
User
- GETGet User Admin Note List
- POSTGet User Admin Note List
- POSTChange User Email
- POSTChange User Default Gateway
- POSTClear AutoCharge Method
- GETUser Count
- GETGet User Profile
- GETUser List
- POSTUser List
- POSTNew User
- POSTNew Admin Note
- POSTResume User
- GETUser Search
- POSTUser Search
- POSTSuspend User
- POSTUpdate User Profile
Vat Gateway
Get Discount Code List
Get discountCode list
curl --request GET \
--url https://api.unibee.top/merchant/discount/list \
--header 'Authorization: Bearer <token>'
{
"code": 123,
"data": {
"discounts": [
{
"advance": true,
"billingType": 123,
"code": "<string>",
"createTime": 123,
"currency": "<string>",
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"discountType": 123,
"endTime": 123,
"id": 123,
"isDeleted": 123,
"liveQuantity": 123,
"merchantId": 123,
"metadata": {},
"name": "<string>",
"planApplyType": 123,
"planIds": [
123
],
"plans": [
{
"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
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123
}
],
"quantity": 123,
"quantityUsed": 123,
"startTime": 123,
"status": 123,
"upgradeLongerOnly": true,
"upgradeOnly": true,
"userLimit": 123,
"userScope": 123
}
],
"total": 123
},
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
discount_type, 1-percentage, 2-fixed_amount
billing_type, 1-one-time, 2-recurring
status, 1-editable, 2-active, 3-deactive, 4-expire, 10-archive
Filter Code
Search Key, code or name
Filter Currency
Sort Field,gmt_create|gmt_modify,Default gmt_modify
Sort Type,asc|desc,Default desc
Page, Start 0
Count Of Per Page
CreateTimeStart
CreateTimeEnd
Response
Discount Object List
AdvanceConfig, 0-false,1-true, will enable all advance config if set 1
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
the live quantity of code
merchantId
name
plan apply type, 0-apply for all, 1-apply for plans specified, 2-exclude for plans specified
Ids of plan which discount code can effect, default effect all plans if not set
plans which discount code can effect, default effect all plans if not set
amount, cent, without tax
binded recurring addon planIds,split with ,
binded onetime addon planIds,split with ,
whether cancel at subscripiton 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
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
MetricId
StandardAmount, used for standard pricing,cent
StandardStartValue, used for standard pricing
Plan's MetricRecurringCharge
ChargeType,0-standard pricing 1-graduated pricing
GraduatedAmounts, used for graduated pricing
MetricId
StandardAmount, used for standard pricing,cent
StandardStartValue, used for standard pricing
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
quantity of code, 0-no limit, will not change
quantity used count of code
start of discount available utc time
status, 1-editable, 2-active, 3-deactive, 4-expire, 10-archive
AdvanceConfig, 0-false,1-true, will forbid for all except upgrade to longer plan if set 1
AdvanceConfig, 0-false,1-true, will forbid for all except upgrade action if set 1
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
Total
curl --request GET \
--url https://api.unibee.top/merchant/discount/list \
--header 'Authorization: Bearer <token>'
{
"code": 123,
"data": {
"discounts": [
{
"advance": true,
"billingType": 123,
"code": "<string>",
"createTime": 123,
"currency": "<string>",
"cycleLimit": 123,
"discountAmount": 123,
"discountPercentage": 123,
"discountType": 123,
"endTime": 123,
"id": 123,
"isDeleted": 123,
"liveQuantity": 123,
"merchantId": 123,
"metadata": {},
"name": "<string>",
"planApplyType": 123,
"planIds": [
123
],
"plans": [
{
"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
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123
}
],
"quantity": 123,
"quantityUsed": 123,
"startTime": 123,
"status": 123,
"upgradeLongerOnly": true,
"upgradeOnly": true,
"userLimit": 123,
"userScope": 123
}
],
"total": 123
},
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}