Skip to main content

UniBee Documentation home page

About
Contact

Documentation

API Reference

API Reference

Member Authentication

POST
Session Login
POST
Admin Member Clear Member 2FA Key With ResumeCode
POST
Password Login
POST
OTP Login
POST
OTP Login Code Verification
GET
Get Oauth Github
GET
Get Oauth Google
POST
OAuth Login
GET
Get Oauth Members
POST
Register OAuth
POST
OAuth Setup
POST
OTP Password Forget
POST
OTP Password Forget Code Verification
POST
2FA Password Forget Code Verification
POST
Password Setup
POST
Register
POST
Register Verify

Checkout Setup

POST
Archive Merchant Checkout
GET
Get Merchant Checkout Detail
POST
Get Merchant Checkout Detail
POST
Edit Merchant Checkout
GET
Get Merchant Checkout Link
POST
Get Merchant Checkout Link
GET
Get Merchant Checkout list
POST
Get Merchant Checkout list
POST
New Merchant Checkout

Merchant

POST
Edit Country Config
POST
Get Country Config List
POST
Admin Edit 2FA Config
GET
Get Profile
GET
Get License
GET
Get License Update Url
POST
Get License Update Url
POST
Generate New APIKey
POST
Update Profile

Credit

GET
Get Credit Config list
POST
Get Credit Config list
GET
Get Credit Account List
GET
Get Credit Transaction List
POST
Get Credit Transaction List
GET
Credit Account Detail
POST
Credit Account Detail
POST
Edit Credit Config
POST
Edit User Credit Account Config
POST
Setup Credit Config
POST
New Credit Recharge

Promo Credit

POST
Edit Promo Credit Config
GET
Get Promo Credit Config
POST
Get Promo Credit Config
GET
Get Promo Credit Config Statistics
POST
Get Promo Credit Config Statistics
POST
Promo Credit Decrement
POST
Promo Credit Increment

Discount

POST
Activate Discount Code
POST
Deactivate Discount Code
POST
Quantity Decrement
POST
Delete Discount Code
GET
Get Merchant Discount Detail
POST
Get Merchant Discount Detail
POST
Edit Discount Code
GET
Get Discount Code List
POST
New Discount Code
POST
Quantity Increment

User Discount

POST
Plan Apply Preview
GET
Get User Discount Code List

Email Template

POST
Customize Localization Template Sync
POST
Activate Email Template Localization Version
POST
Add Email Template Localization Version
POST
Delete Email Template Localization Version
POST
Edit Email Template Localization Version
GET
Get Email Template List
POST
Test Email Template Localization Version

Email

POST
Email Sender Setup
POST
Email Gateway Setup
GET
Get Email History List
POST
Send Template Email To User

Gateway

POST
Payment Gateway Archive
GET
Payment Gateway
POST
Payment Gateway
POST
Payment Gateway Edit
POST
Payment Gateway Country Config Edit
POST
Edit Payment Gateway Sort
GET
Get Payment Gateway List
POST
Payment Gateway Setup
POST
Exchange Rate Api Setup
GET
Get Payment Gateway Setup List
POST
Payment Gateway Webhook Setup
POST
Wire Transfer Edit
POST
Wire Transfer Setup
POST
Segment Setup

Integrations

GET
Disconnection Quickbooks
GET
Get Quickbooks Authorization Connection URL

Invoice

POST
Admin Cancel Invoice
POST
Admin Clear Invoice Current Pending Payment
POST
Delete Pending Invoice
GET
Invoice Detail
POST
Invoice Detail
POST
Invoice Edit
POST
Finish Invoice
GET
Get Invoice List
POST
Get Invoice List
POST
Mark Invoice Refund
POST
Mark Invoice Refund As Success
POST
Mark Wire Transfer Invoice As Success
POST
New Invoice
POST
Generate Invoice PDF
POST
Update Invoice PDF
POST
Admin Reconvert Crypto Data and Send Invoice Email
POST
Create InvoiceRefund
POST
Send Invoice Email

Admin Member

POST
Admin Owner Clear Member 2FA Key
POST
Clear Member OAuth Account
POST
Admin Member Confirm 2FA Key
POST
Admin Owner Or Admin Delete Own's' 2FA Device
POST
Admin Member Get 2FA Key
GET
Get Member List
POST
Get Member List
POST
Logout
POST
Invite member
GET
Get Member Operation Log List
POST
Member Reset Password
GET
Get Member Profile
POST
Admin Member Reset Member 2FA Key
POST
Resume Member
POST
Suspend Member
POST
Update Member Profile
POST
Update Member Role
POST
Update Member OAuth Account

Metric

POST
Delete Merchant Metric
POST
Merchant Metric Detail
POST
Edit Merchant Metric
GET
Get Merchant Metric list
POST
Get Merchant Metric list
POST
New Merchant Metric
POST
Delete Merchant Metric Plan TotalLimit
POST
Edit Merchant Metric Plan TotalLimit
POST
New Merchant Metric Plan TotalLimit

Metric Event

POST
Del Merchant Metric Event
POST
New Merchant Metric Event
GET
Metric Event List
POST
Metric Event List

User Metric

GET
Query User Metric
GET
Query User Metric By Subscription

Payment

POST
Cancel Payment
POST
Capture Payment
GET
Payment Detail
GET
Get OneTime Payment Item List
GET
Get Payment List
POST
Delete Payment Method
GET
Payment Method
GET
Payment Method List
POST
Create New Payment Method
POST
New Payment
POST
Cancel Payment Refund
GET
Payment Refund Detail
GET
Get Payment Refund List
POST
New Payment Refund
GET
Get Payment TimeLine List
POST
Get Payment TimeLine List

Plan

POST
Activate Plan
POST
Addon Binding
POST
Archive Plan
POST
Copy Plan
POST
Delete Plan
GET
Plan Detail
POST
Plan Detail
POST
Edit Plan
GET
Get Plan List
POST
Get Plan List
POST
Create Plan
POST
Publish Plan
POST
UnPublish Plan

Product

POST
Activate Product
POST
Copy Product
POST
Delete Product
GET
Product Detail
POST
Product Detail
POST
Edit Product
POST
Inactivate Product
GET
Get Product List
POST
Get Product List
POST
Create Product

Admin Role

POST
Delete Role
POST
Edit Role
GET
Get Role List
POST
New Role

Search

GET
Search
POST
Search

Session

POST
New Checkout Session
GET
Get User Subscription Update Page Url
POST
Get User Subscription Update Page Url

Subscription Import

POST
Active Subscription Import(allows repetition imports)
POST
History Subscription Import(Allows repetition imports)

Subscription Update

POST
Subscription Active Temporarily
GET
Subscription Pending Update Detail
GET
Get Subscription Pending Update List
POST
Get Subscription Pending Update List
POST
Renew Subscription
POST
Update Subscription Preview
POST
Update Subscription

Subscription

POST
Append Subscription TrialEnd
POST
Apply Discount Or Premo Credit To Next Invoice
POST
Cancel Subscription Immediately
POST
Cancel Subscription At Period End
POST
Cancel Last Cancel Subscription At Period End
POST
Change Subscription Gateway
POST
Create Subscription Preview
POST
Create Subscription
GET
Subscription Detail
POST
Subscription Detail
GET
Get Subscription List
POST
Get Subscription List
GET
Subscription Next Invoice Preview
GET
User Pending Crypto Subscription Detail
POST
User Pending Crypto Subscription Detail
GET
User Subscription Detail
POST
User Subscription Detail

Subscription Note

GET
Get Subscription Note List
POST
Get Subscription Note List
POST
New Subscription Note

Subscription Config

GET
Subscription Config
POST
Update Merchant Subscription Config

Subscription Payment

POST
New Subscription Onetime Addon Payment
POST
New Subscription Onetime Addon Preview
GET
Get Subscription Onetime Addon Purchase History List
POST
New Subscription Payment

Subscription Timeline

GET
Get Subscription TimeLine List
POST
Get Subscription TimeLine List

User

GET
Get User Admin Note List
POST
Get User Admin Note List
POST
Change User Email
POST
Change User Default Gateway
POST
Clear AutoCharge Method
GET
User Count
GET
Get User Profile
GET
User List
POST
User List
POST
New User
POST
New Admin Note
POST
Resume User
GET
User Search
POST
User Search
POST
Suspend User
POST
Update User Profile

Vat Gateway

GET
Get Vat Country List
POST
Get Vat Country List
POST
Init Default Vat Gateway
POST
Vat Gateway Setup
POST
Vat Number Validation

Webhook

POST
Delete Webhook Endpoint
GET
Get Webhook Endpoint list
GET
Get Webhook Endpoint Log List
GET
Webhook Event List
GET
Get Webhook Secret
POST
New Webhook Endpoint
POST
Resent Webhook
POST
Update Webhook Endpoint

Discount

Quantity Decrement

Decrease discount code quantity, the quantity after decreased should greater than 0, the action may disable quantity control if quantity decrease to 0 or lower than quantityUsed after decreased

Deactivate Discount Code Delete Discount Code

⌘I

website github linkedin

Powered by Mintlify