# UniBee Documentation ## Docs - [Introduction](https://docs.unibee.dev/documentation/overview/introduction.md) - [Integration Workflow Guide](https://docs.unibee.dev/documentation/business-integration/integration-workflow.md): A comprehensive guide for integrating UniBee checkout and subscription management into your business system - [Checkout Purchases (Hosted Mode)](https://docs.unibee.dev/documentation/business-integration/checkout-purchases.md): Checkout Purchase can help you build the ability to receive subscriptions on your website or application - [Supported Payment Gateways and Payment Types](https://docs.unibee.dev/documentation/business-integration/supported-payment-gateways.md): A comprehensive guide to all payment gateways and payment types supported by UniBee - [Testing Cards (Sandbox)](https://docs.unibee.dev/documentation/business-integration/testing-cards.md): Learn how to work with testing cards in a sandbox. - [Simulate Subscriptions (Sandbox)](https://docs.unibee.dev/documentation/business-integration/simulate-subscriptions.md): Learn how to simulate subscriptions in a sandbox. - [What is product and plan](https://docs.unibee.dev/documentation/product-and-plan/what-is-product-and-plan.md) - [Subscription plan](https://docs.unibee.dev/documentation/product-and-plan/subscription-plan.md) - [Recurring addon](https://docs.unibee.dev/documentation/product-and-plan/recurring-addon.md) - [Onetime payment](https://docs.unibee.dev/documentation/product-and-plan/onetime-payment.md) - [Trial plan](https://docs.unibee.dev/documentation/product-and-plan/trial-plan.md) - [Subscription auto-charge workflow](https://docs.unibee.dev/documentation/subscription/subscription-auto-charge-workflow.md) - [The subscription billing renewal date](https://docs.unibee.dev/documentation/subscription/billing-cycle-anchor.md): Learn how the billing date for subscriptions work (billing cycle anchor) - [Status](https://docs.unibee.dev/documentation/subscription/status.md) - [Understanding Subscription Incomplete Status](https://docs.unibee.dev/documentation/subscription/incomplete-status.md): Learn about the Incomplete status, its configuration, and how it affects your subscriptions - [Status and workflow](https://docs.unibee.dev/documentation/invoices/status-and-workflow.md) - [Invoice computation](https://docs.unibee.dev/documentation/invoices/invoice-computation.md) - [Transaction type and status](https://docs.unibee.dev/documentation/transaction/transaction-type-and-status.md) - [What is billable metric](https://docs.unibee.dev/documentation/billable-metric/what-is-billable-metric.md): UniBee Billable Metrics is an innovative billing solution designed to cater to various business needs, providing flexible and precise usage tracking and billing methods. Whether your business operates on fixed-price plans or dynamic usage-based pricing, UniBee Billable Metrics can meet your requirem… - [Work with Limited-Type Metric (Limit Metered)](https://docs.unibee.dev/documentation/billable-metric/limited-metric.md): Ideal for fixed-price plans, this metric type ensures that customers do not incur unexpected charges. When the predefined usage limit is reached, the system automatically rejects any further requests, keeping usage within budget. - [Work with Limit Recurring Metric](https://docs.unibee.dev/documentation/billable-metric/limit-recurring-metric.md): Limit Recurring metrics carry over unused quota from previous billing cycles, ideal for prepaid credits and allowances. - [Work with charged-type metric](https://docs.unibee.dev/documentation/billable-metric/charged-metric.md): Suitable for usage-based plans, It allows you to charge additional amounts based on actual usage, ensuring that your revenue matches customer engagement. - [Discount Codes](https://docs.unibee.dev/documentation/discount-code/discount-code-introduction.md): Create and manage discount codes for promotions, customer acquisition, and retention. - [Promo Credit](https://docs.unibee.dev/documentation/promo-credits/promo-credits.md) - [Introduction](https://docs.unibee.dev/documentation/promo-credits/Introduction.md) - [UniBee webhooks](https://docs.unibee.dev/documentation/webhooks/webhooks.md): Receive outbound billing events from UniBee at your HTTPS endpoint, verify deliveries, and acknowledge with a success response. - [UniBee webhook events](https://docs.unibee.dev/documentation/webhooks/webhook-events.md): Outbound billing events UniBee can deliver to your webhook endpoints, with trigger notes and payload samples. - [Custom Checkout Page](https://docs.unibee.dev/documentation/business-integration/custom-checkout-page.md): How to create and manage custom checkout pages in UniBee - [Hosted page custom domain](https://docs.unibee.dev/documentation/business-integration/hosted-page-custom-domain.md) - [Custom Domain (CNAME) Configuration](https://docs.unibee.dev/documentation/business-integration/custom-domain-CNAME-configuration.md): Configure a custom branded domain for UniBee hosted checkout and billing pages - [Change Subscription After Purchases (Hosted Mode)](https://docs.unibee.dev/documentation/business-integration/change-subscription-hosted-page-after-purchases.md): UniBee Hosted Update Page can help you build the ability to change subscriptions on your website or application - [Customer Portal After Purchases (Hosted Mode)](https://docs.unibee.dev/documentation/business-integration/customer-portal-after-purchases.md): Use UniBee Hosted Customer Portal to let your customers manage subscriptions, invoices, and billing information after purchases with minimal integration. - [Portal settings](https://docs.unibee.dev/documentation/business-integration/portal-settings.md) - [Payment iframe integration (Embedded)](https://docs.unibee.dev/documentation/business-integration/payment-iframe-integration.md): Embed UniBee payments into your app using iframe with embedded UI mode - [External Gateway Integration Guide](https://docs.unibee.dev/documentation/business-integration/external-gateway-integration.md): Integrate your own payment system or third‑party checkout with UniBee using External Gateway Invoices, while UniBee manages subscriptions and invoicing. - [Make Billing API calls](https://docs.unibee.dev/documentation/business-integration/billing-api-call.md): Integrate UniBee into your business by making direct API calls - [Export data with an API key](https://docs.unibee.dev/documentation/business-integration/api-key-export-tasks.md): Create asynchronous export tasks, poll their status, and download CSV or XLSX files with a UniBee merchant API key. - [OpenAPI MCP Server](https://docs.unibee.dev/documentation/business-integration/openapi-mcp.md): Connect to UniBee’s public MCP endpoint to search OpenAPI definitions, generate example requests, and read integration playbooks—documentation only, no business API proxy. - [Collect taxes](https://docs.unibee.dev/documentation/business-integration/collect-tax.md): Learn how to collect taxes with UniBee using VAT gateways and automatic tax calculation - [US VAT & TaxJar Setup](https://docs.unibee.dev/documentation/business-integration/us-vat-and-taxjar.md): Learn how to set up US sales tax collection with TaxJar integration in UniBee - [UniBee Multi-Currencies Module](https://docs.unibee.dev/documentation/business-integration/multi-currencies-module.md): Support global billing in multiple currencies with flexible rule sets and exchange logic - [Zapier Integration Guide](https://docs.unibee.dev/documentation/business-integration/zapier-integration.md): Connect UniBee to over 6,000+ other web services. Automated connections called Zaps can automate your day-to-day tasks and build workflows between apps. - [How To Create A UniBee Billable Metric](https://docs.unibee.dev/documentation/billable-metric/how-to-create-billable-metric.md) - [Setting Billable Metric Pricing](https://docs.unibee.dev/documentation/billable-metric/setting-billable-metric-pricing.md) - [Viewing User Usage Billing](https://docs.unibee.dev/documentation/billable-metric/viewing-user-usage-billing.md) - [How to add a new product](https://docs.unibee.dev/documentation/product-and-plan/how-to-add-a-new-product.md) - [Add a plan and archive a plan in product tab](https://docs.unibee.dev/documentation/product-and-plan/add-a-plan-and-archive-a-plan-in-product-tab.md) - [How to Sync UniBee Plans to an External Pricing Catalog](https://docs.unibee.dev/documentation/product-and-plan/sync-plans-to-external-pricing-catalog.md): Use the Plan List API, Plan Tags, external plan IDs, and multi-currency prices to power an external pricing page or product catalog - [Understanding multi phase subscriptions](https://docs.unibee.dev/documentation/multi-phase/understanding-multi-phase-subscriptions.md) - [Creating multi phase plans](https://docs.unibee.dev/documentation/multi-phase/creating-multi-phase-plans.md) - [Customer experience](https://docs.unibee.dev/documentation/multi-phase/customer-experience.md) - [Set Up a Discount Code](https://docs.unibee.dev/documentation/discount-code/setup-discount-code.md): A quick-start overview of UniBee discount codes: the available types, the create-to-activate workflow, and the key concepts to get right before you launch a campaign. - [Create, edit, copy and archive](https://docs.unibee.dev/documentation/discount-code/create-edit-copy-and-archive.md) - [Batch Discount Codes](https://docs.unibee.dev/documentation/discount-code/batch-discount-codes.md): Create a template with unified discount rules and generate thousands of unique, single-use codes for large-scale, trackable campaigns. - [External Discount Codes](https://docs.unibee.dev/documentation/discount-code/external-discount-codes.md): Learn how to create discounts programmatically via API using external discount codes - [View the usage of a discount code](https://docs.unibee.dev/documentation/discount-code/view-the-usage-of-a-discount-code.md) - [Inquiry and Export](https://docs.unibee.dev/documentation/discount-code/inquiry-and-export.md): Search, filter, sort, and export discount code data and usage details from the admin portal. - [Change subscription plan](https://docs.unibee.dev/documentation/subscription/change-subscription-plan.md) - [Assign Subscription to user](https://docs.unibee.dev/documentation/subscription/assign-plan-to-user.md): Learn how to assign a subscription to a user. The Assign Subscription feature allows administrators to help customers initiate subscriptions via the admin portal. Each customer can have only one subscription with a status of Active or Incomplete per product at any given time. - [Subscription Configuration Guide](https://docs.unibee.dev/documentation/subscription/subscription_configs.md) - [Advanced invoice management](https://docs.unibee.dev/documentation/invoices/advanced-invoice-management.md) - [Offline Refund Process](https://docs.unibee.dev/documentation/invoices/offline-refund-process.md): How to handle offline refunds for crypto and wire transfer payments - [Customized Invoice PDF Issued by](https://docs.unibee.dev/documentation/invoices/customize-invoice-pdf-issued-by.md): This feature allows you to personalize your invoice PDFs by configuring key business details such as your Company Name, Company Logo, Company Email, Company Phone, and more. Create professional, branded invoices that reflect your company's identity and ensure clear communication with your customers. - [Configure invoice entities for payment gateways](https://docs.unibee.dev/documentation/invoices/payment-gateway-invoice-entity-configuration.md): Use gateway-level invoice configuration when invoices generated through different payment gateways must display different legal entity details. - [Split Payment on Invoice Hosted Page](https://docs.unibee.dev/documentation/invoices/split-payment.md): Use split payment to handle invoices that exceed a single payment method's maximum amount, by creating multiple smaller payments on the hosted invoice page. - [External Gateway Invoices](https://docs.unibee.dev/documentation/invoices/external-gateway-invoices.md): Use external gateways to process payments outside of UniBee while keeping invoices and revenue records consistent in UniBee. - [Transaction list download](https://docs.unibee.dev/documentation/transaction/transaction-list-download.md) - [View, edit user information](https://docs.unibee.dev/documentation/user-management/view-edit-user-info.md) - [Assign a subscription plan to a user](https://docs.unibee.dev/documentation/user-management/assign-sub-to-user.md) - [Export and import user data](https://docs.unibee.dev/documentation/user-management/export-import-user-data.md) - [Activity logs](https://docs.unibee.dev/documentation/admin-management/activity-logs.md) - [Invite more billing admins](https://docs.unibee.dev/documentation/admin-management/invite-more-billing-admins.md) - [ Define roles and permissions for billing admins](https://docs.unibee.dev/documentation/admin-management/define-roles-permissions.md) - [Email Settings Configuration](https://docs.unibee.dev/documentation/email-settings/email-settings-configuration.md): Configure how the system sends automated emails to your users. Connect your own email provider (via SMTP or SendGrid), customize email templates, and monitor delivery status. - [Enabling the Promo Credit System](https://docs.unibee.dev/documentation/promo-credits/Enabling-the-Promo-Credit-System.md) - [Adding or Modifying a User's Promo Credit](https://docs.unibee.dev/documentation/promo-credits/Adding-or-Modifying-a-User's-Promo-Credit.md) - [Viewing and Exporting the Promo Credit List](https://docs.unibee.dev/documentation/promo-credits/Viewing-and-Exporting-the-Promo-Credit-List.md) - [How to Integrate Promo Credit for Customers via OpenAPI](https://docs.unibee.dev/documentation/promo-credits/promo_credit_integration.md) - [Analytics Overview](https://docs.unibee.dev/documentation/analytics/analytics-overview.md): Unified subscription analytics for revenue, customer value, retention, and configuration. - [Configurable Settings](https://docs.unibee.dev/documentation/analytics/configurable-settings.md): General, MRR metrics configuration, data scope, visibility, and recalculation in Analytics. - [Customer Metrics](https://docs.unibee.dev/documentation/analytics/customer-metrics.md): Customer LTV, quick cards, trend, breakdown, formulas, and notes in UniBee Analytics. - [Revenue Metrics](https://docs.unibee.dev/documentation/analytics/revenue-metrics.md): MRR, ARR, Net Revenue, and NRR in UniBee Analytics. - [Define and export customizable reports](https://docs.unibee.dev/documentation/reports-and-export-reports/reports-and-export-reports.md) - [Amount Multi Currencies Exchange](https://docs.unibee.dev/api-reference/merchant/amount-multi-currencies-exchange.md) - [Edit Country Config](https://docs.unibee.dev/api-reference/merchant/edit-country-config.md) - [Get Country Config List](https://docs.unibee.dev/api-reference/merchant/get-country-config-list.md) - [Admin Edit 2FA Config](https://docs.unibee.dev/api-reference/merchant/admin-edit-2fa-config.md) - [Get Profile](https://docs.unibee.dev/api-reference/merchant/get-profile.md) - [Get License](https://docs.unibee.dev/api-reference/merchant/get-license.md) - [Get License Update Url](https://docs.unibee.dev/api-reference/merchant/get-license-update-url.md) - [Get License Update Url](https://docs.unibee.dev/api-reference/merchant/get-license-update-url-1.md) - [Generate New APIKey](https://docs.unibee.dev/api-reference/merchant/generate-new-apikey.md): Generate new apikey, The old one expired in one hour - [Get Merchant Overview Statistics](https://docs.unibee.dev/api-reference/merchant/get-merchant-overview-statistics.md) - [Multi Currencies Setup](https://docs.unibee.dev/api-reference/merchant/multi-currencies-setup.md) - [Update Profile](https://docs.unibee.dev/api-reference/merchant/update-profile.md) - [Update Merchant CNAME Domain](https://docs.unibee.dev/api-reference/merchant/update-merchant-cname-domain.md) - [Update Profile Portal Host Domain](https://docs.unibee.dev/api-reference/merchant/update-profile-portal-host-domain.md) - [Session Login](https://docs.unibee.dev/api-reference/member-authentication/session-login.md): Session login - [Admin Member Clear Member 2FA Key With ResumeCode](https://docs.unibee.dev/api-reference/member-authentication/admin-member-clear-member-2fa-key-with-resumecode.md) - [Merchant Password Login](https://docs.unibee.dev/api-reference/member-authentication/merchant-password-login.md): Merchant Password login - [OTP Login](https://docs.unibee.dev/api-reference/member-authentication/otp-login.md): Send email to member with OTP code - [OTP Login Code Verification](https://docs.unibee.dev/api-reference/member-authentication/otp-login-code-verification.md): OTP login for member, verify OTP code - [Get Oauth Github](https://docs.unibee.dev/api-reference/member-authentication/get-oauth-github.md): Merchant Oauth Github - [Get Oauth Google](https://docs.unibee.dev/api-reference/member-authentication/get-oauth-google.md): Merchant Oauth Google - [OAuth Login](https://docs.unibee.dev/api-reference/member-authentication/oauth-login.md): OAuth login. Pass OAuth token in request header (Auth.js JWT). Headers: X-Auth-JS-Token | X-Auth-Token | X-OAuth-Token - [Get Oauth Members](https://docs.unibee.dev/api-reference/member-authentication/get-oauth-members.md): Merchant Get Oauth Connected Members. Pass OAuth token in request header (Auth.js JWT). Headers: X-Auth-JS-Token | X-Auth-Token | X-OAuth-Token - [Register OAuth](https://docs.unibee.dev/api-reference/member-authentication/register-oauth.md): Merchant OAuth Register. Pass OAuth token in request header (Auth.js JWT). Headers: X-Auth-JS-Token | X-Auth-Token | X-OAuth-Token - [OAuth Setup](https://docs.unibee.dev/api-reference/member-authentication/oauth-setup.md): Member OAuth Setup. Pass OAuth token in request header (Auth.js JWT). Headers: X-Auth-JS-Token | X-Auth-Token | X-OAuth-Token - [OTP Password Forget](https://docs.unibee.dev/api-reference/member-authentication/otp-password-forget.md): Send email to member with OTP code - [OTP Password Forget Code Verification](https://docs.unibee.dev/api-reference/member-authentication/otp-password-forget-code-verification.md): Password forget OTP process, verify OTP code - [2FA Password Forget Code Verification](https://docs.unibee.dev/api-reference/member-authentication/2fa-password-forget-code-verification.md): Password forget 2FA process, verify 2FA code - [Password Setup](https://docs.unibee.dev/api-reference/member-authentication/password-setup.md): Member Password Setup - [Register](https://docs.unibee.dev/api-reference/member-authentication/register.md): Register with owner permission, send email with OTP code - [Register Email Check](https://docs.unibee.dev/api-reference/member-authentication/register-email-check.md): Check Register Email - [RegisterWithoutCode](https://docs.unibee.dev/api-reference/member-authentication/registerwithoutcode.md): Register with owner permission without code verification - [Register Verify](https://docs.unibee.dev/api-reference/member-authentication/register-verify.md): Merchant Register, verify OTP code - [Archive Merchant Checkout](https://docs.unibee.dev/api-reference/checkout-setup/archive-merchant-checkout.md) - [Get Merchant Checkout Detail](https://docs.unibee.dev/api-reference/checkout-setup/get-merchant-checkout-detail.md) - [Get Merchant Checkout Detail](https://docs.unibee.dev/api-reference/checkout-setup/get-merchant-checkout-detail-1.md) - [Edit Merchant Checkout](https://docs.unibee.dev/api-reference/checkout-setup/edit-merchant-checkout.md) - [Get Merchant Checkout Link](https://docs.unibee.dev/api-reference/checkout-setup/get-merchant-checkout-link.md) - [Get Merchant Checkout Link](https://docs.unibee.dev/api-reference/checkout-setup/get-merchant-checkout-link-1.md) - [Get Merchant Checkout list](https://docs.unibee.dev/api-reference/checkout-setup/get-merchant-checkout-list.md) - [Get Merchant Checkout list](https://docs.unibee.dev/api-reference/checkout-setup/get-merchant-checkout-list-1.md) - [New Merchant Checkout](https://docs.unibee.dev/api-reference/checkout-setup/new-merchant-checkout.md) - [Get Credit Config list](https://docs.unibee.dev/api-reference/credit/get-credit-config-list.md) - [Get Credit Config list](https://docs.unibee.dev/api-reference/credit/get-credit-config-list-1.md) - [Get Credit Account List](https://docs.unibee.dev/api-reference/credit/get-credit-account-list.md): Get Credit Account list - [Get Credit Transaction List](https://docs.unibee.dev/api-reference/credit/get-credit-transaction-list.md): Get Credit Transaction list - [Get Credit Transaction List](https://docs.unibee.dev/api-reference/credit/get-credit-transaction-list-1.md): Get Credit Transaction list - [Credit Account Detail](https://docs.unibee.dev/api-reference/credit/credit-account-detail.md) - [Credit Account Detail](https://docs.unibee.dev/api-reference/credit/credit-account-detail-1.md) - [Edit Credit Config](https://docs.unibee.dev/api-reference/credit/edit-credit-config.md) - [Edit User Credit Account Config](https://docs.unibee.dev/api-reference/credit/edit-user-credit-account-config.md): Edit User Credit Account Config - [Setup Credit Config](https://docs.unibee.dev/api-reference/credit/setup-credit-config.md) - [New Credit Recharge](https://docs.unibee.dev/api-reference/credit/new-credit-recharge.md): New Credit Recharge - [Edit Promo Credit Config](https://docs.unibee.dev/api-reference/promo-credit/edit-promo-credit-config.md) - [Get Promo Credit Config](https://docs.unibee.dev/api-reference/promo-credit/get-promo-credit-config.md) - [Get Promo Credit Config](https://docs.unibee.dev/api-reference/promo-credit/get-promo-credit-config-1.md) - [Get Promo Credit Config Statistics](https://docs.unibee.dev/api-reference/promo-credit/get-promo-credit-config-statistics.md) - [Get Promo Credit Config Statistics](https://docs.unibee.dev/api-reference/promo-credit/get-promo-credit-config-statistics-1.md) - [Promo Credit Decrement](https://docs.unibee.dev/api-reference/promo-credit/promo-credit-decrement.md): Decrease user promo credit amount, the amount after decreased should greater than 0 - [Promo Credit Increment](https://docs.unibee.dev/api-reference/promo-credit/promo-credit-increment.md): Increase user promo credit amount - [Promo Credit Refund](https://docs.unibee.dev/api-reference/promo-credit/promo-credit-refund.md): Refund user promo credit amount from refund invoice - [Activate Discount Code](https://docs.unibee.dev/api-reference/discount/activate-discount-code.md): Activate discount code, the discount code can only effect to payment or subscription after activated - [Deactivate Discount Code](https://docs.unibee.dev/api-reference/discount/deactivate-discount-code.md): Deactivate discount code - [Quantity Decrement](https://docs.unibee.dev/api-reference/discount/quantity-decrement.md): 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 - [Delete Discount Code](https://docs.unibee.dev/api-reference/discount/delete-discount-code.md): Delete discount code before activate - [Get Merchant Discount Detail](https://docs.unibee.dev/api-reference/discount/get-merchant-discount-detail.md) - [Get Merchant Discount Detail](https://docs.unibee.dev/api-reference/discount/get-merchant-discount-detail-1.md) - [Edit Discount Code](https://docs.unibee.dev/api-reference/discount/edit-discount-code.md): Edit the discount code before activate - [Get Discount Code List](https://docs.unibee.dev/api-reference/discount/get-discount-code-list.md): Get discountCode list - [New Discount Code](https://docs.unibee.dev/api-reference/discount/new-discount-code.md): Create a new discount code, code can used in onetime or subscription purchase to make discount - [Quantity Increment](https://docs.unibee.dev/api-reference/discount/quantity-increment.md): Increase discount code quantity, if original quantity is 0, increase greater than 0 will enable quantity control - [Get Batch Child Code Detail](https://docs.unibee.dev/api-reference/batch-discount/get-batch-child-code-detail.md): Get detail of a specific batch child code - [Get Batch Child Code Detail](https://docs.unibee.dev/api-reference/batch-discount/get-batch-child-code-detail-1.md): Get detail of a specific batch child code - [Generate Batch Child Codes](https://docs.unibee.dev/api-reference/batch-discount/generate-batch-child-codes.md): Generate child codes for a batch template. Template must be in active status. Supports initial generation, retry on failure, and incremental expansion. Either templateId or templateCode must be provided. If quantity > 1000, isAsync must be set to true. Default is synchronous execution. - [Get Batch Child Codes List](https://docs.unibee.dev/api-reference/batch-discount/get-batch-child-codes-list.md): Get list of child codes for a specific batch template - [Get Batch Template Detail](https://docs.unibee.dev/api-reference/batch-discount/get-batch-template-detail.md): Get batch discount template detail - [Get Batch Template Detail](https://docs.unibee.dev/api-reference/batch-discount/get-batch-template-detail-1.md): Get batch discount template detail - [Edit Batch Discount Template](https://docs.unibee.dev/api-reference/batch-discount/edit-batch-discount-template.md): Edit batch discount template. CodePrefix cannot be modified. Quantity can only be increased after activation. - [Get Batch Template List](https://docs.unibee.dev/api-reference/batch-discount/get-batch-template-list.md): Get batch discount template list - [Create Batch Discount Template](https://docs.unibee.dev/api-reference/batch-discount/create-batch-discount-template.md): Create a batch discount code template. Template must be activated before generating child codes. - [Increment Template Quantity](https://docs.unibee.dev/api-reference/batch-discount/increment-template-quantity.md): Increment batch template quantity. Template must be activated. Total quantity after increment must not exceed 10000. - [Plan Apply Preview](https://docs.unibee.dev/api-reference/user-discount/plan-apply-preview.md): Check discount can apply to plan, Only check rules about plan,the actual usage is subject to the subscription interface - [Get User Discount Code List](https://docs.unibee.dev/api-reference/user-discount/get-user-discount-code-list.md): Get user discountCode list - [Customize Localization Template Sync](https://docs.unibee.dev/api-reference/email-template/customize-localization-template-sync.md): Sync the custom localization email template to gateway (sendgrid) - [Activate Email Template Localization Version](https://docs.unibee.dev/api-reference/email-template/activate-email-template-localization-version.md) - [Add Email Template Localization Version](https://docs.unibee.dev/api-reference/email-template/add-email-template-localization-version.md) - [Delete Email Template Localization Version](https://docs.unibee.dev/api-reference/email-template/delete-email-template-localization-version.md) - [Edit Email Template Localization Version](https://docs.unibee.dev/api-reference/email-template/edit-email-template-localization-version.md) - [Get Email Template List](https://docs.unibee.dev/api-reference/email-template/get-email-template-list.md) - [Test Email Template Localization Version](https://docs.unibee.dev/api-reference/email-template/test-email-template-localization-version.md) - [Email Sender Setup](https://docs.unibee.dev/api-reference/email/email-sender-setup.md) - [Email Gateway Set Default](https://docs.unibee.dev/api-reference/email/email-gateway-set-default.md) - [Email Gateway Setup(Sendgrid)](https://docs.unibee.dev/api-reference/email/email-gateway-setupsendgrid.md) - [Email Gateway Setup V2(Sendgrid|smtp)](https://docs.unibee.dev/api-reference/email/email-gateway-setup-v2sendgrid|smtp.md) - [Get Email History List](https://docs.unibee.dev/api-reference/email/get-email-history-list.md): Get email send history list - [Send Email To User](https://docs.unibee.dev/api-reference/email/send-email-to-user.md) - [Send Email Via API Credential](https://docs.unibee.dev/api-reference/email/send-email-via-api-credential.md) - [Send Template Email To User](https://docs.unibee.dev/api-reference/email/send-template-email-to-user.md) - [Payment Gateway Archive](https://docs.unibee.dev/api-reference/gateway/payment-gateway-archive.md): Archive the exist payment gateway,available for setup new one, the old user continue using the old gateway - [Payment Gateway](https://docs.unibee.dev/api-reference/gateway/payment-gateway.md): Get Payment Gateway Detail - [Payment Gateway](https://docs.unibee.dev/api-reference/gateway/payment-gateway-1.md): Get Payment Gateway Detail - [Payment Gateway Edit](https://docs.unibee.dev/api-reference/gateway/payment-gateway-edit.md): Edit the exist payment gateway - [Payment Gateway Country Config Edit](https://docs.unibee.dev/api-reference/gateway/payment-gateway-country-config-edit.md): Edit country config for payment gateway, to enable or disable the payment for countryCode, default is enable - [Edit Payment Gateway Sort](https://docs.unibee.dev/api-reference/gateway/edit-payment-gateway-sort.md) - [Get Payment Gateway List](https://docs.unibee.dev/api-reference/gateway/get-payment-gateway-list.md) - [Payment Gateway Restore](https://docs.unibee.dev/api-reference/gateway/payment-gateway-restore.md): Restore the exist payment gateway - [Payment Gateway Set Default](https://docs.unibee.dev/api-reference/gateway/payment-gateway-set-default.md): Set default the exist payment gateway - [Payment Gateway Setup](https://docs.unibee.dev/api-reference/gateway/payment-gateway-setup.md): Setup Payment gateway - [Exchange Rate Api Setup](https://docs.unibee.dev/api-reference/gateway/exchange-rate-api-setup.md) - [Get Payment Gateway Setup List](https://docs.unibee.dev/api-reference/gateway/get-payment-gateway-setup-list.md) - [Payment Gateway Webhook Setup](https://docs.unibee.dev/api-reference/gateway/payment-gateway-webhook-setup.md) - [Wire Transfer Edit](https://docs.unibee.dev/api-reference/gateway/wire-transfer-edit.md): Edit the wire transfer - [Wire Transfer Setup](https://docs.unibee.dev/api-reference/gateway/wire-transfer-setup.md): Setup the wire transfer - [Segment Setup](https://docs.unibee.dev/api-reference/gateway/segment-setup.md) - [Disconnection Quickbooks](https://docs.unibee.dev/api-reference/integrations/disconnection-quickbooks.md) - [Get Quickbooks Authorization Connection URL](https://docs.unibee.dev/api-reference/integrations/get-quickbooks-authorization-connection-url.md) - [Admin Cancel Invoice](https://docs.unibee.dev/api-reference/invoice/admin-cancel-invoice.md) - [Admin Clear Invoice Current Pending Payment](https://docs.unibee.dev/api-reference/invoice/admin-clear-invoice-current-pending-payment.md) - [Create And Mark Manual Refund (Crypto/WireTransfer/External)](https://docs.unibee.dev/api-reference/invoice/create-and-mark-manual-refund-cryptowiretransferexternal.md): Create a manual refund record for a paid invoice when refund has been processed offline via crypto, wire transfer or External gateway, and mark it as requested. Supports crypto, wire transfer and external invoices. - [Bulk CreditNote(Refund Invoice) Invoice List](https://docs.unibee.dev/api-reference/invoice/bulk-creditnoterefund-invoice-invoice-list.md): Bulk credit note invoice list - [Delete Pending Invoice](https://docs.unibee.dev/api-reference/invoice/delete-pending-invoice.md): Delete invoice of pending status - [Invoice Detail](https://docs.unibee.dev/api-reference/invoice/invoice-detail.md): Get detail of invoice - [Invoice Detail](https://docs.unibee.dev/api-reference/invoice/invoice-detail-1.md): Get detail of invoice - [Invoice Edit](https://docs.unibee.dev/api-reference/invoice/invoice-edit.md): Edit invoice of pending status - [[Deprecated] Mark External Gateway Invoice As Paid](https://docs.unibee.dev/api-reference/invoice/[deprecated]-mark-external-gateway-invoice-as-paid.md): Deprecated. Please use payment-level external gateway APIs: /merchant/payment/external_gateway_payment/mark_paid. This invoice-level API is kept for compatibility only. - [[Deprecated] Mark External Gateway Invoice As Refunded](https://docs.unibee.dev/api-reference/invoice/[deprecated]-mark-external-gateway-invoice-as-refunded.md): Deprecated placeholder. External refund flow will be redesigned. Do not use this invoice-level API for new integrations. - [[Deprecated] Update External Gateway Invoice Payment Link](https://docs.unibee.dev/api-reference/invoice/[deprecated]-update-external-gateway-invoice-payment-link.md): Deprecated. Please use payment-level external gateway APIs: /merchant/payment/external_gateway_payment/update_link. This invoice-level API is kept for compatibility only. - [Finish Invoice](https://docs.unibee.dev/api-reference/invoice/finish-invoice.md): Finish invoice, generate invoice link - [Get Invoice List](https://docs.unibee.dev/api-reference/invoice/get-invoice-list.md): Get invoice list - [Get Invoice List](https://docs.unibee.dev/api-reference/invoice/get-invoice-list-1.md): Get invoice list - [Mark Manual Invoice Refund As Success](https://docs.unibee.dev/api-reference/invoice/mark-manual-invoice-refund-as-success.md): Mark existing manual refund of an invoice as success, only supports Changelly (crypto) and Wire Transfer refunds. - [Mark Wire Transfer Invoice As Paid (Manual)](https://docs.unibee.dev/api-reference/invoice/mark-wire-transfer-invoice-as-paid-manual.md): Manually mark a pending wire transfer invoice as paid and trigger invoice paid flow. Only supports wire transfer invoices that have been paid offline. - [New Invoice](https://docs.unibee.dev/api-reference/invoice/new-invoice.md) - [Generate Invoice PDF](https://docs.unibee.dev/api-reference/invoice/generate-invoice-pdf.md) - [Update Invoice PDF](https://docs.unibee.dev/api-reference/invoice/update-invoice-pdf.md) - [Admin Reconvert Crypto Data and Send Invoice Email](https://docs.unibee.dev/api-reference/invoice/admin-reconvert-crypto-data-and-send-invoice-email.md) - [Create InvoiceRefund](https://docs.unibee.dev/api-reference/invoice/create-invoicerefund.md): Create payment refund for paid invoice - [Send Invoice Email](https://docs.unibee.dev/api-reference/invoice/send-invoice-email.md) - [Get Split Payments](https://docs.unibee.dev/api-reference/invoice/get-split-payments.md): Get all split payments for an invoice with payment statistics - [Get Split Payments](https://docs.unibee.dev/api-reference/invoice/get-split-payments-1.md): Get all split payments for an invoice with payment statistics - [Sync Invoice User Snapshot With Latest User Info](https://docs.unibee.dev/api-reference/invoice/sync-invoice-user-snapshot-with-latest-user-info.md): Sync user snapshot in invoice with latest user profile - [Admin Owner Clear Member 2FA Key](https://docs.unibee.dev/api-reference/admin-member/admin-owner-clear-member-2fa-key.md) - [Clear Member OAuth Account](https://docs.unibee.dev/api-reference/admin-member/clear-member-oauth-account.md) - [Admin Member Confirm 2FA Key](https://docs.unibee.dev/api-reference/admin-member/admin-member-confirm-2fa-key.md) - [Admin Owner Or Admin Delete Own's' 2FA Device](https://docs.unibee.dev/api-reference/admin-member/admin-owner-or-admin-delete-owns-2fa-device.md) - [Admin Member Get 2FA Key](https://docs.unibee.dev/api-reference/admin-member/admin-member-get-2fa-key.md) - [Get Member List](https://docs.unibee.dev/api-reference/admin-member/get-member-list.md) - [Get Member List](https://docs.unibee.dev/api-reference/admin-member/get-member-list-1.md) - [Logout](https://docs.unibee.dev/api-reference/admin-member/logout.md) - [Invite member](https://docs.unibee.dev/api-reference/admin-member/invite-member.md): Will send email to member email provided, member can enter admin portal by email otp login - [Get Member Operation Log List](https://docs.unibee.dev/api-reference/admin-member/get-member-operation-log-list.md) - [Member Reset Password](https://docs.unibee.dev/api-reference/admin-member/member-reset-password.md) - [Get Member Profile](https://docs.unibee.dev/api-reference/admin-member/get-member-profile.md) - [Admin Member Reset Member 2FA Key](https://docs.unibee.dev/api-reference/admin-member/admin-member-reset-member-2fa-key.md) - [Resume Member](https://docs.unibee.dev/api-reference/admin-member/resume-member.md) - [Suspend Member](https://docs.unibee.dev/api-reference/admin-member/suspend-member.md) - [Update Member Profile](https://docs.unibee.dev/api-reference/admin-member/update-member-profile.md) - [Update Member Role](https://docs.unibee.dev/api-reference/admin-member/update-member-role.md) - [Update Member OAuth Account](https://docs.unibee.dev/api-reference/admin-member/update-member-oauth-account.md): Pass OAuth token in request header (Auth.js JWT). Headers: X-Auth-JS-Token | X-Auth-Token | X-OAuth-Token - [Reprocess Metric Carry Over (Admin Tool)](https://docs.unibee.dev/api-reference/metric-limit-quota/reprocess-metric-carry-over-admin-tool.md) - [Manual Adjust Metric Limit](https://docs.unibee.dev/api-reference/metric-limit-quota/manual-adjust-metric-limit.md) - [Delete Merchant Metric](https://docs.unibee.dev/api-reference/metric/delete-merchant-metric.md) - [Merchant Metric Detail](https://docs.unibee.dev/api-reference/metric/merchant-metric-detail.md) - [Edit Merchant Metric](https://docs.unibee.dev/api-reference/metric/edit-merchant-metric.md) - [Get Merchant Metric list](https://docs.unibee.dev/api-reference/metric/get-merchant-metric-list.md) - [Get Merchant Metric list](https://docs.unibee.dev/api-reference/metric/get-merchant-metric-list-1.md) - [New Merchant Metric](https://docs.unibee.dev/api-reference/metric/new-merchant-metric.md) - [Delete Merchant Metric Plan TotalLimit](https://docs.unibee.dev/api-reference/metric/delete-merchant-metric-plan-totallimit.md) - [Edit Merchant Metric Plan TotalLimit](https://docs.unibee.dev/api-reference/metric/edit-merchant-metric-plan-totallimit.md) - [New Merchant Metric Plan TotalLimit](https://docs.unibee.dev/api-reference/metric/new-merchant-metric-plan-totallimit.md) - [Get Merchant Metric Event Current Value](https://docs.unibee.dev/api-reference/metric-event/get-merchant-metric-event-current-value.md) - [Del Merchant Metric Event](https://docs.unibee.dev/api-reference/metric-event/del-merchant-metric-event.md) - [New Merchant Metric Event](https://docs.unibee.dev/api-reference/metric-event/new-merchant-metric-event.md) - [Metric Event List](https://docs.unibee.dev/api-reference/metric-event/metric-event-list.md) - [Metric Event List](https://docs.unibee.dev/api-reference/metric-event/metric-event-list-1.md) - [List invoices that can be used for metric_by_invoice (paid, subscription cycle only)](https://docs.unibee.dev/api-reference/user-metric/list-invoices-that-can-be-used-for-metric_by_invoice-paid-subscription-cycle-only.md) - [Query User History Limit Metric By Invoice (History Query Mode, limit_metered and limit_recurring only)](https://docs.unibee.dev/api-reference/user-metric/query-user-history-limit-metric-by-invoice-history-query-mode-limit_metered-and-limit_recurring-only.md) - [Query User History Limit Metric By Subscription (History Query Mode, limit_metered and limit_recurring only, non-active subscription only)](https://docs.unibee.dev/api-reference/user-metric/query-user-history-limit-metric-by-subscription-history-query-mode-limit_metered-and-limit_recurring-only-non-active-subscription-only.md) - [Query User Metric](https://docs.unibee.dev/api-reference/user-metric/query-user-metric.md) - [Query User Metric By Subscription](https://docs.unibee.dev/api-reference/user-metric/query-user-metric-by-subscription.md) - [Cancel Payment](https://docs.unibee.dev/api-reference/payment/cancel-payment.md) - [Capture Payment](https://docs.unibee.dev/api-reference/payment/capture-payment.md) - [Payment Detail](https://docs.unibee.dev/api-reference/payment/payment-detail.md) - [Mark External Gateway Payment As Failed](https://docs.unibee.dev/api-reference/payment/mark-external-gateway-payment-as-failed.md): Mark payment as failed using external gateway result. Auth: OpenAPI + signature (HMAC-SHA256, hex). - [Mark External Gateway Payment As Paid](https://docs.unibee.dev/api-reference/payment/mark-external-gateway-payment-as-paid.md): Mark payment as paid using external gateway result. Auth: OpenAPI + signature (HMAC-SHA256, hex). - [Update External Gateway Payment Link](https://docs.unibee.dev/api-reference/payment/update-external-gateway-payment-link.md): Update external checkout link for a payment. Auth: OpenAPI + signature (HMAC-SHA256, hex). - [Mark External Gateway Refund As Failed](https://docs.unibee.dev/api-reference/payment/mark-external-gateway-refund-as-failed.md): Mark refund as failed using external gateway result. Auth: OpenAPI + signature (HMAC-SHA256, hex). - [Mark External Gateway Refund As Success](https://docs.unibee.dev/api-reference/payment/mark-external-gateway-refund-as-success.md): Mark refund as success using external gateway result. Auth: OpenAPI + signature (HMAC-SHA256, hex). - [Get OneTime Payment Item List](https://docs.unibee.dev/api-reference/payment/get-onetime-payment-item-list.md) - [Get Payment List](https://docs.unibee.dev/api-reference/payment/get-payment-list.md) - [Delete Payment Method](https://docs.unibee.dev/api-reference/payment/delete-payment-method.md) - [Payment Method](https://docs.unibee.dev/api-reference/payment/payment-method.md): The method of payment gateway - [Payment Method List](https://docs.unibee.dev/api-reference/payment/payment-method-list.md): The method list of payment gateway - [Create New Payment Method](https://docs.unibee.dev/api-reference/payment/create-new-payment-method.md) - [New Payment](https://docs.unibee.dev/api-reference/payment/new-payment.md) - [Cancel Payment Refund](https://docs.unibee.dev/api-reference/payment/cancel-payment-refund.md) - [Payment Refund Detail](https://docs.unibee.dev/api-reference/payment/payment-refund-detail.md) - [Get Payment Refund List](https://docs.unibee.dev/api-reference/payment/get-payment-refund-list.md) - [New Payment Refund](https://docs.unibee.dev/api-reference/payment/new-payment-refund.md) - [Get Payment TimeLine List](https://docs.unibee.dev/api-reference/payment/get-payment-timeline-list.md) - [Get Payment TimeLine List](https://docs.unibee.dev/api-reference/payment/get-payment-timeline-list-1.md) - [Activate Plan](https://docs.unibee.dev/api-reference/plan/activate-plan.md) - [Confirm Active Plan Price Change](https://docs.unibee.dev/api-reference/plan/confirm-active-plan-price-change.md): Confirm and apply price change for an active plan. - [Preview Active Plan Price Change](https://docs.unibee.dev/api-reference/plan/preview-active-plan-price-change.md): Preview how many subscriptions will be affected if we change price of an active plan. - [Addon Binding](https://docs.unibee.dev/api-reference/plan/addon-binding.md) - [Archive Plan](https://docs.unibee.dev/api-reference/plan/archive-plan.md) - [Copy Plan](https://docs.unibee.dev/api-reference/plan/copy-plan.md) - [Delete Plan](https://docs.unibee.dev/api-reference/plan/delete-plan.md) - [Plan Detail](https://docs.unibee.dev/api-reference/plan/plan-detail.md) - [Plan Detail](https://docs.unibee.dev/api-reference/plan/plan-detail-1.md) - [Edit Plan](https://docs.unibee.dev/api-reference/plan/edit-plan.md): Edit exist plan, amount|currency|intervalUnit|intervalCount is not editable when plan is active - [Get Plan List](https://docs.unibee.dev/api-reference/plan/get-plan-list.md) - [Get Plan List](https://docs.unibee.dev/api-reference/plan/get-plan-list-1.md) - [Override Metric Limits Of Plan](https://docs.unibee.dev/api-reference/plan/override-metric-limits-of-plan.md): Insert or override metric limit items of a plan - [Create Plan](https://docs.unibee.dev/api-reference/plan/create-plan.md) - [Publish Plan](https://docs.unibee.dev/api-reference/plan/publish-plan.md): Publish plan,a plan will display at user portal when its published - [UnPublish Plan](https://docs.unibee.dev/api-reference/plan/unpublish-plan.md) - [Activate Product](https://docs.unibee.dev/api-reference/product/activate-product.md) - [Copy Product](https://docs.unibee.dev/api-reference/product/copy-product.md) - [Delete Product](https://docs.unibee.dev/api-reference/product/delete-product.md): Product can being deleted when has no plan linked - [Product Detail](https://docs.unibee.dev/api-reference/product/product-detail.md) - [Product Detail](https://docs.unibee.dev/api-reference/product/product-detail-1.md) - [Edit Product](https://docs.unibee.dev/api-reference/product/edit-product.md): Edit exist product, product is editable for both active and inactive status - [Inactivate Product](https://docs.unibee.dev/api-reference/product/inactivate-product.md) - [Get Product List](https://docs.unibee.dev/api-reference/product/get-product-list.md) - [Get Product List](https://docs.unibee.dev/api-reference/product/get-product-list-1.md) - [Create Product](https://docs.unibee.dev/api-reference/product/create-product.md) - [Delete Role](https://docs.unibee.dev/api-reference/admin-role/delete-role.md) - [Edit Role](https://docs.unibee.dev/api-reference/admin-role/edit-role.md) - [Get Role List](https://docs.unibee.dev/api-reference/admin-role/get-role-list.md) - [New Role](https://docs.unibee.dev/api-reference/admin-role/new-role.md) - [Search](https://docs.unibee.dev/api-reference/search/search.md) - [Search](https://docs.unibee.dev/api-reference/search/search-1.md) - [Get Customer Portal Url](https://docs.unibee.dev/api-reference/session/get-customer-portal-url.md) - [Get Customer Portal Url](https://docs.unibee.dev/api-reference/session/get-customer-portal-url-1.md) - [New Checkout Session](https://docs.unibee.dev/api-reference/session/new-checkout-session.md): New session for hosted checkout or client portal. You can create user and get ClientSession from here, then append it to the checkout link (copied from Admin Portal Plan) as a query parameter, e.g. https://cs.unibee.dev/hosted/checkout?planId=253&env=prod&session=${clientSession} - [Get User Subscription Update Page Url](https://docs.unibee.dev/api-reference/session/get-user-subscription-update-page-url.md) - [Get User Subscription Update Page Url](https://docs.unibee.dev/api-reference/session/get-user-subscription-update-page-url-1.md) - [Subscription Active Temporarily](https://docs.unibee.dev/api-reference/subscription-update/subscription-active-temporarily.md): Subscription active temporarily, status will transmit from pending to incomplete - [Update Subscription Metadata](https://docs.unibee.dev/api-reference/subscription-update/update-subscription-metadata.md) - [Subscription Pending Update Detail](https://docs.unibee.dev/api-reference/subscription-update/subscription-pending-update-detail.md) - [Get Subscription Pending Update List](https://docs.unibee.dev/api-reference/subscription-update/get-subscription-pending-update-list.md) - [Get Subscription Pending Update List](https://docs.unibee.dev/api-reference/subscription-update/get-subscription-pending-update-list-1.md) - [Renew Subscription](https://docs.unibee.dev/api-reference/subscription-update/renew-subscription.md): Manually renew an existing subscription by generating a new recurring invoice and payment. - [Renew Subscription Preview](https://docs.unibee.dev/api-reference/subscription-update/renew-subscription-preview.md): Preview renew invoice of an existing subscription. - [Update Subscription Preview](https://docs.unibee.dev/api-reference/subscription-update/update-subscription-preview.md) - [Update Subscription](https://docs.unibee.dev/api-reference/subscription-update/update-subscription.md) - [Append Subscription TrialEnd](https://docs.unibee.dev/api-reference/subscription/append-subscription-trialend.md) - [Apply Discount Or Premo Credit To Next Invoice](https://docs.unibee.dev/api-reference/subscription/apply-discount-or-premo-credit-to-next-invoice.md) - [Cancel Subscription Immediately](https://docs.unibee.dev/api-reference/subscription/cancel-subscription-immediately.md): Cancel subscription immediately, no proration invoice will generate - [Cancel Subscription At Period End](https://docs.unibee.dev/api-reference/subscription/cancel-subscription-at-period-end.md): Cancel subscription at period end, the subscription will not turn to 'cancelled' at once but will cancelled at period end time, no invoice will generate, the flag 'cancelAtPeriodEnd' of subscription will be enabled - [Cancel Last Cancel Subscription At Period End](https://docs.unibee.dev/api-reference/subscription/cancel-last-cancel-subscription-at-period-end.md): This action should be request before subscription's period end, If subscription's flag 'cancelAtPeriodEnd' is enabled, this action will resume it to disable, and subscription will continue cycle recurring seems no cancelAtPeriod action be setting - [Change Subscription Currency](https://docs.unibee.dev/api-reference/subscription/change-subscription-currency.md): Change subscription currency, only available for merchants with multi-currency enabled - [Change Subscription Due Day](https://docs.unibee.dev/api-reference/subscription/change-subscription-due-day.md): Change subscription due day - [Change Subscription Gateway](https://docs.unibee.dev/api-reference/subscription/change-subscription-gateway.md) - [Create Subscription Preview](https://docs.unibee.dev/api-reference/subscription/create-subscription-preview.md) - [Create Subscription](https://docs.unibee.dev/api-reference/subscription/create-subscription.md) - [Subscription Detail](https://docs.unibee.dev/api-reference/subscription/subscription-detail.md) - [Subscription Detail](https://docs.unibee.dev/api-reference/subscription/subscription-detail-1.md) - [Get Subscription List](https://docs.unibee.dev/api-reference/subscription/get-subscription-list.md) - [Get Subscription List](https://docs.unibee.dev/api-reference/subscription/get-subscription-list-1.md) - [Subscription Next Invoice Preview](https://docs.unibee.dev/api-reference/subscription/subscription-next-invoice-preview.md) - [User Pending Crypto Subscription Detail](https://docs.unibee.dev/api-reference/subscription/user-pending-crypto-subscription-detail.md) - [User Pending Crypto Subscription Detail](https://docs.unibee.dev/api-reference/subscription/user-pending-crypto-subscription-detail-1.md) - [User Subscription Detail](https://docs.unibee.dev/api-reference/subscription/user-subscription-detail.md) - [User Subscription Detail](https://docs.unibee.dev/api-reference/subscription/user-subscription-detail-1.md) - [Get Subscription Note List](https://docs.unibee.dev/api-reference/subscription-note/get-subscription-note-list.md) - [Get Subscription Note List](https://docs.unibee.dev/api-reference/subscription-note/get-subscription-note-list-1.md) - [New Subscription Note](https://docs.unibee.dev/api-reference/subscription-note/new-subscription-note.md) - [Subscription Config](https://docs.unibee.dev/api-reference/subscription-config/subscription-config.md) - [Update Merchant Subscription Config](https://docs.unibee.dev/api-reference/subscription-config/update-merchant-subscription-config.md) - [New Subscription Onetime Addon Payment](https://docs.unibee.dev/api-reference/subscription-payment/new-subscription-onetime-addon-payment.md): Create payment for subscription onetime addon purchase - [New Subscription Onetime Addon Preview](https://docs.unibee.dev/api-reference/subscription-payment/new-subscription-onetime-addon-preview.md): Preview for subscription onetime addon purchase - [Get Subscription Onetime Addon Purchase History List](https://docs.unibee.dev/api-reference/subscription-payment/get-subscription-onetime-addon-purchase-history-list.md) - [New Subscription Payment](https://docs.unibee.dev/api-reference/subscription-payment/new-subscription-payment.md) - [Get Subscription TimeLine List](https://docs.unibee.dev/api-reference/subscription-timeline/get-subscription-timeline-list.md) - [Get Subscription TimeLine List](https://docs.unibee.dev/api-reference/subscription-timeline/get-subscription-timeline-list-1.md) - [Get User Admin Note List](https://docs.unibee.dev/api-reference/user/get-user-admin-note-list.md) - [Get User Admin Note List](https://docs.unibee.dev/api-reference/user/get-user-admin-note-list-1.md) - [Change User Email](https://docs.unibee.dev/api-reference/user/change-user-email.md) - [Change User Default Gateway](https://docs.unibee.dev/api-reference/user/change-user-default-gateway.md) - [Clear AutoCharge Method](https://docs.unibee.dev/api-reference/user/clear-autocharge-method.md) - [User Count](https://docs.unibee.dev/api-reference/user/user-count.md) - [Delete User](https://docs.unibee.dev/api-reference/user/delete-user.md) - [Get User Profile](https://docs.unibee.dev/api-reference/user/get-user-profile.md) - [User List](https://docs.unibee.dev/api-reference/user/user-list.md) - [User List](https://docs.unibee.dev/api-reference/user/user-list-1.md) - [New User](https://docs.unibee.dev/api-reference/user/new-user.md): User Creation If Not Exist - [New Admin Note](https://docs.unibee.dev/api-reference/user/new-admin-note.md) - [Resume User](https://docs.unibee.dev/api-reference/user/resume-user.md) - [User Search](https://docs.unibee.dev/api-reference/user/user-search.md) - [User Search](https://docs.unibee.dev/api-reference/user/user-search-1.md) - [Suspend User](https://docs.unibee.dev/api-reference/user/suspend-user.md) - [Update User Profile](https://docs.unibee.dev/api-reference/user/update-user-profile.md) - [Get Vat Country List](https://docs.unibee.dev/api-reference/vat-gateway/get-vat-country-list.md) - [Get Vat Country List](https://docs.unibee.dev/api-reference/vat-gateway/get-vat-country-list-1.md) - [Init Default Vat Gateway](https://docs.unibee.dev/api-reference/vat-gateway/init-default-vat-gateway.md) - [Vat Gateway Setup](https://docs.unibee.dev/api-reference/vat-gateway/vat-gateway-setup.md) - [US Vat Config Setup](https://docs.unibee.dev/api-reference/vat-gateway/us-vat-config-setup.md) - [US Vat Gateway Setup](https://docs.unibee.dev/api-reference/vat-gateway/us-vat-gateway-setup.md) - [Get US Vat Category List](https://docs.unibee.dev/api-reference/vat-gateway/get-us-vat-category-list.md) - [Validate US Vat Address](https://docs.unibee.dev/api-reference/vat-gateway/validate-us-vat-address.md) - [Vat Number Validation](https://docs.unibee.dev/api-reference/vat-gateway/vat-number-validation.md) - [Vat Number Validation History](https://docs.unibee.dev/api-reference/vat-gateway/vat-number-validation-history.md) - [Vat Number Validation History Activate](https://docs.unibee.dev/api-reference/vat-gateway/vat-number-validation-history-activate.md) - [Vat Number Validation History Deactivate](https://docs.unibee.dev/api-reference/vat-gateway/vat-number-validation-history-deactivate.md) - [Get US VAT Upload History List](https://docs.unibee.dev/api-reference/webhook/get-us-vat-upload-history-list.md) - [Delete Webhook Endpoint](https://docs.unibee.dev/api-reference/webhook/delete-webhook-endpoint.md) - [Get Webhook Endpoint list](https://docs.unibee.dev/api-reference/webhook/get-webhook-endpoint-list.md) - [Get Webhook Endpoint Log List](https://docs.unibee.dev/api-reference/webhook/get-webhook-endpoint-log-list.md) - [Webhook Event List](https://docs.unibee.dev/api-reference/webhook/webhook-event-list.md) - [Get Webhook Secret](https://docs.unibee.dev/api-reference/webhook/get-webhook-secret.md) - [New Webhook Endpoint](https://docs.unibee.dev/api-reference/webhook/new-webhook-endpoint.md) - [Remove Webhook Zapier Connnect](https://docs.unibee.dev/api-reference/webhook/remove-webhook-zapier-connnect.md) - [Resent Webhook](https://docs.unibee.dev/api-reference/webhook/resent-webhook.md) - [Update Webhook Endpoint](https://docs.unibee.dev/api-reference/webhook/update-webhook-endpoint.md) - [Get Webhook Zapier Connect Url](https://docs.unibee.dev/api-reference/webhook/get-webhook-zapier-connect-url.md) - [Transaction Data Storage](https://docs.unibee.dev/documentation/business-integration/data-storage.md): Understanding data storage for UniBee Opensource and Cloud versions - [Data migration guide](https://docs.unibee.dev/documentation/business-integration/data-migration-guide.md) - [History Invoice Import (supports override)](https://docs.unibee.dev/api-reference/invoice-import/history-invoice-import-supports-override.md): Each repetition import overrides existing invoices with matching InvoiceId (BizType=Import). - [Delete imported history invoice](https://docs.unibee.dev/api-reference/invoice-import/delete-imported-history-invoice.md): Delete an imported history invoice (BizType=Import) and its related payment/refund if applicable. - [Active Subscription Import(allows repetition imports)](https://docs.unibee.dev/api-reference/subscription-import/active-subscription-importallows-repetition-imports.md): Each repetition import overrides existing subscriptions with matching ExternalSubscriptionId. - [History Subscription Import(Allows repetition imports)](https://docs.unibee.dev/api-reference/subscription-import/history-subscription-importallows-repetition-imports.md): Each repetition import overrides existing subscriptions with matching ExternalSubscriptionId. ## OpenAPI Specs - [openapi](https://docs.unibee.dev/openapi.yaml) ## Optional - [GitHub](https://github.com/unibee-billing) - [Community](https://github.com/unibee-billing) - [Official website](https://unibee.dev/)