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 License
curl --request GET \
--url https://api.unibee.top/merchant/get_license \
--header 'Authorization: Bearer <token>'
{
"code": 123,
"data": {
"APIRateLimit": 123,
"license": {
"isPaid": true,
"license": "<string>",
"ownerEmail": "<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
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123
},
"subscription": {
"addonData": "<string>",
"amount": 123,
"billingCycleAnchor": 123,
"cancelAtPeriodEnd": 123,
"cancelOrExpireTime": 123,
"cancelReason": "<string>",
"countryCode": "<string>",
"createTime": 123,
"currency": "<string>",
"currentPeriodEnd": 123,
"currentPeriodPaid": 123,
"currentPeriodStart": 123,
"defaultPaymentMethodId": "<string>",
"dunningTime": 123,
"externalSubscriptionId": "<string>",
"features": "<string>",
"firstPaidTime": 123,
"gasPayer": "<string>",
"gatewayId": 123,
"gatewayStatus": "<string>",
"id": 123,
"lastUpdateTime": 123,
"latestInvoiceId": "<string>",
"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>"
},
"version": {
"endTime": 123,
"expired": true,
"isPaid": true,
"name": "<string>",
"plan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123
},
"startTime": 123
}
},
"merchant": {
"address": "<string>",
"businessNum": "<string>",
"companyLogo": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"createTime": 123,
"email": "<string>",
"homeUrl": "<string>",
"host": "<string>",
"id": 123,
"idcard": "<string>",
"location": "<string>",
"name": "<string>",
"phone": "<string>",
"timeZone": "<string>",
"type": 123,
"userId": 123
}
},
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
APIRateLimit
License, Premium Version will contain License
OwnerEmail
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
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
EndTime,UTC, The End Time Of Plan,0 for free
Expired
IsPaid
Name
StartTime,UTC, The Start Time Of Plan,0 for free
address
business_num
company_logo
company_name
Country Code
Country Name
create utc time
merchant user portal host
merchant_id
idcard
location
name
phone
merchant default time zone
type
create_user_id
curl --request GET \
--url https://api.unibee.top/merchant/get_license \
--header 'Authorization: Bearer <token>'
{
"code": 123,
"data": {
"APIRateLimit": 123,
"license": {
"isPaid": true,
"license": "<string>",
"ownerEmail": "<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
}
],
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123
},
"subscription": {
"addonData": "<string>",
"amount": 123,
"billingCycleAnchor": 123,
"cancelAtPeriodEnd": 123,
"cancelOrExpireTime": 123,
"cancelReason": "<string>",
"countryCode": "<string>",
"createTime": 123,
"currency": "<string>",
"currentPeriodEnd": 123,
"currentPeriodPaid": 123,
"currentPeriodStart": 123,
"defaultPaymentMethodId": "<string>",
"dunningTime": 123,
"externalSubscriptionId": "<string>",
"features": "<string>",
"firstPaidTime": 123,
"gasPayer": "<string>",
"gatewayId": 123,
"gatewayStatus": "<string>",
"id": 123,
"lastUpdateTime": 123,
"latestInvoiceId": "<string>",
"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>"
},
"version": {
"endTime": 123,
"expired": true,
"isPaid": true,
"name": "<string>",
"plan": {
"amount": 123,
"bindingAddonIds": "<string>",
"bindingOnetimeAddonIds": "<string>",
"cancelAtTrialEnd": 123,
"createTime": 123,
"currency": "<string>",
"description": "<string>",
"externalPlanId": "<string>",
"extraMetricData": "<string>",
"gasPayer": "<string>",
"homeUrl": "<string>",
"id": 123,
"imageUrl": "<string>",
"intervalCount": 123,
"intervalUnit": "<string>",
"merchantId": 123,
"metadata": {},
"planName": "<string>",
"productId": 123,
"publishStatus": 123,
"status": 123,
"taxPercentage": 123,
"trialAmount": 123,
"trialDemand": "<string>",
"trialDurationTime": 123,
"type": 123
},
"startTime": 123
}
},
"merchant": {
"address": "<string>",
"businessNum": "<string>",
"companyLogo": "<string>",
"companyName": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"createTime": 123,
"email": "<string>",
"homeUrl": "<string>",
"host": "<string>",
"id": 123,
"idcard": "<string>",
"location": "<string>",
"name": "<string>",
"phone": "<string>",
"timeZone": "<string>",
"type": 123,
"userId": 123
}
},
"message": "<string>",
"redirect": "<string>",
"requestId": "<string>"
}