# BillingServ

## Docs

- [API Settings](https://www.billingserv.com/docs/account/api.md): Find the account information needed to connect external systems to BillingServ.
- [Company Settings](https://www.billingserv.com/docs/account/company.md): Maintain the company details and customer-facing account settings used by BillingServ.
- [Account Security](https://www.billingserv.com/docs/account/security.md): Update the email address and password used to access the admin panel.
- [Create hosted checkout link](https://www.billingserv.com/docs/api-reference/checkout/create-hosted-checkout-link.md): Creates a one-hour hosted checkout URL for an existing BillingServ customer. `customer_id` is required and must reference a customer account (`account_type` 2). When the customer opens the returned URL, BillingServ signs them into a checkout-only session, shows a checkout-only page, allows saved pay…
- [Get country](https://www.billingserv.com/docs/api-reference/country/get-country.md)
- [List countries](https://www.billingserv.com/docs/api-reference/country/list-countries.md)
- [List counties by country](https://www.billingserv.com/docs/api-reference/county/list-counties-by-country.md)
- [Add customer credit](https://www.billingserv.com/docs/api-reference/customer/add-customer-credit.md)
- [Add customer note](https://www.billingserv.com/docs/api-reference/customer/add-customer-note.md)
- [Check customer credentials and return an API token](https://www.billingserv.com/docs/api-reference/customer/check-customer-credentials-and-return-an-api-token.md)
- [Create customer](https://www.billingserv.com/docs/api-reference/customer/create-customer.md)
- [Delete customer](https://www.billingserv.com/docs/api-reference/customer/delete-customer.md)
- [Delete customer payment method](https://www.billingserv.com/docs/api-reference/customer/delete-customer-payment-method.md)
- [Get customer](https://www.billingserv.com/docs/api-reference/customer/get-customer.md)
- [Get customer credit](https://www.billingserv.com/docs/api-reference/customer/get-customer-credit.md)
- [List customers](https://www.billingserv.com/docs/api-reference/customer/list-customers.md)
- [Reset customer password](https://www.billingserv.com/docs/api-reference/customer/reset-customer-password.md)
- [Update customer](https://www.billingserv.com/docs/api-reference/customer/update-customer.md)
- [Create group](https://www.billingserv.com/docs/api-reference/group/create-group.md)
- [Delete group](https://www.billingserv.com/docs/api-reference/group/delete-group.md)
- [Get group](https://www.billingserv.com/docs/api-reference/group/get-group.md)
- [List groups](https://www.billingserv.com/docs/api-reference/group/list-groups.md)
- [Update group](https://www.billingserv.com/docs/api-reference/group/update-group.md)
- [API overview](https://www.billingserv.com/docs/api-reference/introduction.md): Authenticate with BillingServ and start using the supported public API.
- [Accept quote](https://www.billingserv.com/docs/api-reference/invoice/accept-quote.md)
- [Capture invoice payment](https://www.billingserv.com/docs/api-reference/invoice/capture-invoice-payment.md)
- [Create invoice](https://www.billingserv.com/docs/api-reference/invoice/create-invoice.md)
- [Create quote](https://www.billingserv.com/docs/api-reference/invoice/create-quote.md)
- [Delete invoice](https://www.billingserv.com/docs/api-reference/invoice/delete-invoice.md)
- [Delete quote](https://www.billingserv.com/docs/api-reference/invoice/delete-quote.md)
- [Get invoice payment method](https://www.billingserv.com/docs/api-reference/invoice/get-invoice-payment-method.md)
- [Get invoice transactions](https://www.billingserv.com/docs/api-reference/invoice/get-invoice-transactions.md)
- [List invoices](https://www.billingserv.com/docs/api-reference/invoice/list-invoices.md)
- [Send invoice](https://www.billingserv.com/docs/api-reference/invoice/send-invoice.md)
- [Send invoice reminder](https://www.billingserv.com/docs/api-reference/invoice/send-invoice-reminder.md)
- [Update invoice](https://www.billingserv.com/docs/api-reference/invoice/update-invoice.md)
- [Update invoice transaction](https://www.billingserv.com/docs/api-reference/invoice/update-invoice-transaction.md)
- [Activate a software license](https://www.billingserv.com/docs/api-reference/licensing/activate-a-software-license.md): Registers a device or server installation against a license key. Server installations are bound to the configured domain, IP address, and installation-path policies. The license key is the credential; no bearer token is required.
- [Deactivate a license installation](https://www.billingserv.com/docs/api-reference/licensing/deactivate-a-license-installation.md): Deactivates the matching device or server instance and releases its activation slot.
- [Validate a software license](https://www.billingserv.com/docs/api-reference/licensing/validate-a-software-license.md): Validates an existing activation and refreshes its last-check timestamp. A valid response includes a short-lived Ed25519-signed offline token for temporary use when the API cannot be reached.
- [Create discount](https://www.billingserv.com/docs/api-reference/marketing/create-discount.md)
- [Delete discount](https://www.billingserv.com/docs/api-reference/marketing/delete-discount.md)
- [Get discount](https://www.billingserv.com/docs/api-reference/marketing/get-discount.md)
- [List discounts](https://www.billingserv.com/docs/api-reference/marketing/list-discounts.md)
- [Update discount](https://www.billingserv.com/docs/api-reference/marketing/update-discount.md)
- [Activate or deactivate module](https://www.billingserv.com/docs/api-reference/module/activate-or-deactivate-module.md)
- [Get module configuration](https://www.billingserv.com/docs/api-reference/module/get-module-configuration.md)
- [Accept order](https://www.billingserv.com/docs/api-reference/order/accept-order.md)
- [Add order](https://www.billingserv.com/docs/api-reference/order/add-order.md)
- [Cancel order](https://www.billingserv.com/docs/api-reference/order/cancel-order.md)
- [Change order package](https://www.billingserv.com/docs/api-reference/order/change-order-package.md)
- [Check order fraud status](https://www.billingserv.com/docs/api-reference/order/check-order-fraud-status.md)
- [Delete order](https://www.billingserv.com/docs/api-reference/order/delete-order.md)
- [List available package changes](https://www.billingserv.com/docs/api-reference/order/list-available-package-changes.md)
- [List orders](https://www.billingserv.com/docs/api-reference/order/list-orders.md)
- [List orders by status](https://www.billingserv.com/docs/api-reference/order/list-orders-by-status.md)
- [Mark order as fraud](https://www.billingserv.com/docs/api-reference/order/mark-order-as-fraud.md)
- [Mark order as pending](https://www.billingserv.com/docs/api-reference/order/mark-order-as-pending.md)
- [Preview package change](https://www.billingserv.com/docs/api-reference/order/preview-package-change.md)
- [Create package](https://www.billingserv.com/docs/api-reference/package/create-package.md)
- [Create package option](https://www.billingserv.com/docs/api-reference/package/create-package-option.md)
- [Delete package](https://www.billingserv.com/docs/api-reference/package/delete-package.md)
- [Delete package option](https://www.billingserv.com/docs/api-reference/package/delete-package-option.md)
- [Get package](https://www.billingserv.com/docs/api-reference/package/get-package.md)
- [Get package option](https://www.billingserv.com/docs/api-reference/package/get-package-option.md)
- [Get packages available to a customer](https://www.billingserv.com/docs/api-reference/package/get-packages-available-to-a-customer.md)
- [List package options](https://www.billingserv.com/docs/api-reference/package/list-package-options.md)
- [List packages](https://www.billingserv.com/docs/api-reference/package/list-packages.md)
- [Show package](https://www.billingserv.com/docs/api-reference/package/show-package.md)
- [Update package](https://www.billingserv.com/docs/api-reference/package/update-package.md)
- [Update package option](https://www.billingserv.com/docs/api-reference/package/update-package-option.md)
- [Annual sales report](https://www.billingserv.com/docs/api-reference/report/annual-sales-report.md)
- [Customer credit report](https://www.billingserv.com/docs/api-reference/report/customer-credit-report.md)
- [Customer debt report](https://www.billingserv.com/docs/api-reference/report/customer-debt-report.md)
- [Customer invoice report](https://www.billingserv.com/docs/api-reference/report/customer-invoice-report.md)
- [Customer receipt report](https://www.billingserv.com/docs/api-reference/report/customer-receipt-report.md)
- [Package leaderboard report](https://www.billingserv.com/docs/api-reference/report/package-leaderboard-report.md)
- [Revenue trend report](https://www.billingserv.com/docs/api-reference/report/revenue-trend-report.md)
- [Sales by customer report](https://www.billingserv.com/docs/api-reference/report/sales-by-customer-report.md)
- [Sales by staff report](https://www.billingserv.com/docs/api-reference/report/sales-by-staff-report.md)
- [Create staff user](https://www.billingserv.com/docs/api-reference/setting/create-staff-user.md)
- [Create tax class](https://www.billingserv.com/docs/api-reference/setting/create-tax-class.md)
- [Create tax zone](https://www.billingserv.com/docs/api-reference/setting/create-tax-zone.md)
- [Delete staff user](https://www.billingserv.com/docs/api-reference/setting/delete-staff-user.md)
- [Delete tax class](https://www.billingserv.com/docs/api-reference/setting/delete-tax-class.md)
- [Delete tax zone](https://www.billingserv.com/docs/api-reference/setting/delete-tax-zone.md)
- [Get invoice settings](https://www.billingserv.com/docs/api-reference/setting/get-invoice-settings.md)
- [Get staff user](https://www.billingserv.com/docs/api-reference/setting/get-staff-user.md)
- [Get tax class](https://www.billingserv.com/docs/api-reference/setting/get-tax-class.md)
- [Get tax zone](https://www.billingserv.com/docs/api-reference/setting/get-tax-zone.md)
- [List staff users](https://www.billingserv.com/docs/api-reference/setting/list-staff-users.md)
- [List tax classes](https://www.billingserv.com/docs/api-reference/setting/list-tax-classes.md)
- [List tax zones](https://www.billingserv.com/docs/api-reference/setting/list-tax-zones.md)
- [Update invoice settings](https://www.billingserv.com/docs/api-reference/setting/update-invoice-settings.md)
- [Update staff user](https://www.billingserv.com/docs/api-reference/setting/update-staff-user.md)
- [Update tax class](https://www.billingserv.com/docs/api-reference/setting/update-tax-class.md)
- [Update tax zone](https://www.billingserv.com/docs/api-reference/setting/update-tax-zone.md)
- [Create support ticket](https://www.billingserv.com/docs/api-reference/support/create-support-ticket.md)
- [Delete support ticket](https://www.billingserv.com/docs/api-reference/support/delete-support-ticket.md)
- [Get support ticket](https://www.billingserv.com/docs/api-reference/support/get-support-ticket.md)
- [List support tickets](https://www.billingserv.com/docs/api-reference/support/list-support-tickets.md)
- [Reply to support ticket](https://www.billingserv.com/docs/api-reference/support/reply-to-support-ticket.md)
- [Update support ticket](https://www.billingserv.com/docs/api-reference/support/update-support-ticket.md)
- [List order usage meters](https://www.billingserv.com/docs/api-reference/usage/list-order-usage-meters.md): Returns usage billing meters configured on the order's package, including current unbilled usage, remaining free allowance, billable quantity, and threshold warnings. The authenticated API key must own the order.
- [Record usage event](https://www.billingserv.com/docs/api-reference/usage/record-usage-event.md): Records bill-in-arrears usage for a configured package usage metric on a customer order. The authenticated API key must own the order, and `name` must match a usage metric configured on the order's package.
- [Create VPN branding](https://www.billingserv.com/docs/api-reference/vpn/create-vpn-branding.md)
- [Create VPN connection](https://www.billingserv.com/docs/api-reference/vpn/create-vpn-connection.md)
- [Create VPN server](https://www.billingserv.com/docs/api-reference/vpn/create-vpn-server.md)
- [Delete VPN server](https://www.billingserv.com/docs/api-reference/vpn/delete-vpn-server.md)
- [Deploy VPN server](https://www.billingserv.com/docs/api-reference/vpn/deploy-vpn-server.md)
- [Disconnect VPN connection](https://www.billingserv.com/docs/api-reference/vpn/disconnect-vpn-connection.md)
- [Get customer VPN connection details](https://www.billingserv.com/docs/api-reference/vpn/get-customer-vpn-connection-details.md)
- [Get VPN branding](https://www.billingserv.com/docs/api-reference/vpn/get-vpn-branding.md)
- [Get VPN details from client result](https://www.billingserv.com/docs/api-reference/vpn/get-vpn-details-from-client-result.md)
- [Get VPN server](https://www.billingserv.com/docs/api-reference/vpn/get-vpn-server.md)
- [List VPN servers](https://www.billingserv.com/docs/api-reference/vpn/list-vpn-servers.md): Returns the paginated VPN server list together with the ordered server-group representation used by VPN applications. The order of `server_groups` matches the order configured in VPN Deploy, and the order of each group's `servers` array matches the configured server order. Only online, enabled serve…
- [Update VPN server](https://www.billingserv.com/docs/api-reference/vpn/update-vpn-server.md)
- [Build a webhook endpoint](https://www.billingserv.com/docs/api-reference/webhooks/build-an-endpoint.md): Accept, acknowledge, and safely process BillingServ webhooks.
- [Webhook events](https://www.billingserv.com/docs/api-reference/webhooks/events.md): Supported webhook event types and their resource payloads.
- [Webhooks overview](https://www.billingserv.com/docs/api-reference/webhooks/overview.md): Receive BillingServ events in your own application.
- [Receive a billingserv webhook event](https://www.billingserv.com/docs/api-reference/webhooks/receive-a-billingserv-webhook-event.md): BillingServ sends this request to the HTTPS endpoint configured on the API Information page. Persist or enqueue the event and respond within 10 seconds. Deliveries may be retried and should be deduplicated using the event ID.
- [Changelog](https://www.billingserv.com/docs/changelog/index.md)
- [CMS overview](https://www.billingserv.com/docs/cms/cms.md): Manage the content your customers see.
- [Knowledge Base](https://www.billingserv.com/docs/cms/knowledge-base.md): Build structured help articles customers can use for self-service.
- [Package Options](https://www.billingserv.com/docs/cms/package-options.md): Add-ons and configurable extras customers can choose when ordering.
- [Packages](https://www.billingserv.com/docs/cms/packages.md): The main products and plans your customers can order.
- [Pages, Blog and FAQ](https://www.billingserv.com/docs/cms/pages-blog-faq.md): Manage your site's core content, updates, and common questions.
- [Bookings](https://www.billingserv.com/docs/customers/bookings.md): Track and manage customer bookings from creation to completion.
- [Calendar Bookings](https://www.billingserv.com/docs/customers/calendar-bookings.md): View bookings in a calendar so staff can see scheduled customer activity.
- [Customer Detail](https://www.billingserv.com/docs/customers/customer-detail.md): Review a customer account and manage its orders, invoices, credit, notes, and account actions.
- [Customers](https://www.billingserv.com/docs/customers/customers.md): Manage customer accounts, profiles, and account status.
- [Order Cancellations](https://www.billingserv.com/docs/customers/order-cancellations.md): Review, process, and track customer order cancellation requests.
- [Order Detail](https://www.billingserv.com/docs/customers/order-detail.md): Manage one order, its status, invoices, provisioning, cancellations, and digital delivery.
- [Pending Orders](https://www.billingserv.com/docs/customers/pending-orders.md): Find orders that are still waiting to be processed.
- [Dashboard](https://www.billingserv.com/docs/dashboard.md): What the BillingServ dashboard shows at a glance.
- [First-Time Setup](https://www.billingserv.com/docs/first-time-setup.md): Complete the business and currency details required before using the admin panel.
- [How to Sell Digital Products with BillingServ](https://www.billingserv.com/docs/guides/digital-downloads.md): Set up digital product delivery in BillingServ to sell ebooks, software, videos, and other digital downloads.
- [Software License Management Setup Guide](https://www.billingserv.com/docs/guides/software-licensing.md): Set up software license management in BillingServ to sell software, issue licence keys, manage activations, and control digital access.
- [Web Hosting Billing Software Setup Guide](https://www.billingserv.com/docs/guides/webhost-billing.md): Set up web hosting billing software in BillingServ to sell hosting plans, manage recurring billing, connect service integrations, and support customers.
- [Getting Started](https://www.billingserv.com/docs/index.md): What happens after you sign up and first log in.
- [InstantServ](https://www.billingserv.com/docs/instantserv.md): Create shareable order pages for a fixed set of products and services.
- [Invoice Detail](https://www.billingserv.com/docs/invoice-detail.md): Review an invoice, update its status, and manage credit notes.
- [Invoices](https://www.billingserv.com/docs/invoices.md): View invoice records and create new invoices for customers.
- [Activity Logs](https://www.billingserv.com/docs/reports/activity-logs.md): Audit request/activity events with method, status, user, and response time.
- [Compliance and Audit](https://www.billingserv.com/docs/reports/compliance-audit.md): Review security, compliance, and operational checks from one dashboard.
- [Customer and Growth Insights](https://www.billingserv.com/docs/reports/customer-growth.md): Understand customer growth, activity, revenue, and package performance.
- [Licensing and Digital Downloads](https://www.billingserv.com/docs/reports/digital-delivery-licensing.md): Track digital download activity, licence status, activations, and expiry dates.
- [Financial Performance](https://www.billingserv.com/docs/reports/financial-performance.md): Review package revenue, invoice activity, transactions, and order status in one report.
- [API Integration Detail](https://www.billingserv.com/docs/settings/api-integration-detail.md): Configure the connection details and notifications used by a BillingServ integration.
- [API Integrations](https://www.billingserv.com/docs/settings/api-integrations.md): Define the integrations and fields that can be used by the API.
- [Design Settings](https://www.billingserv.com/docs/settings/design.md): Control the visual assets and styling used by your customer-facing site.
- [Discount Codes](https://www.billingserv.com/docs/settings/discount-codes.md): Create and manage percentage discount codes for selected packages.
- [Domain Settings](https://www.billingserv.com/docs/settings/domain.md): Configure domain registrar access and the extensions shown in your domain ordering flow.
- [Email Template Variants](https://www.billingserv.com/docs/settings/email-template-variants.md): Maintain language-specific versions of an email template.
- [Email Templates](https://www.billingserv.com/docs/settings/email-templates.md): Manage the email templates and language variants used for customer notifications.
- [Fixed Discounts](https://www.billingserv.com/docs/settings/fixed-discounts.md): Create and manage percentage discounts that apply when an order reaches a minimum value.
- [Import and Export](https://www.billingserv.com/docs/settings/import-export.md): Move supported account data into or out of BillingServ.
- [Invoice Settings](https://www.billingserv.com/docs/settings/invoice.md): Configure invoice numbering, payment timing, currency, tax details, and billing options.
- [Payment Gateway Detail](https://www.billingserv.com/docs/settings/payment-gateway-detail.md): Enter or update the credentials and test settings for a payment provider.
- [Payment Gateways](https://www.billingserv.com/docs/settings/payment-gateways.md): Connect payment providers and choose whether each gateway runs in test mode.
- [Site Promotions](https://www.billingserv.com/docs/settings/promotions.md): Manage promotional offers displayed across the site.
- [Staff Logins](https://www.billingserv.com/docs/settings/staff-logins.md): Create staff accounts and control which parts of the admin panel they can access.
- [Tax Settings](https://www.billingserv.com/docs/settings/tax.md): Manage the tax classes and rates used when BillingServ calculates charges.
- [Support Macros](https://www.billingserv.com/docs/support/macros.md): Save reusable support replies for faster, more consistent ticket handling.
- [Public Support Page](https://www.billingserv.com/docs/support/public-support-page.md): How the customer-facing support page handles tickets and pre-sales inquiries.
- [Support overview](https://www.billingserv.com/docs/support/support.md): How support works across tickets, replies, and support configuration.
- [Support Settings](https://www.billingserv.com/docs/support/support-settings.md): Configure support departments and public pre-sales form behavior.
- [Support Tickets](https://www.billingserv.com/docs/support/support-tickets.md): Create, manage, and reply to customer support tickets.
- [VPN Branding](https://www.billingserv.com/docs/vpn/branding.md): Set the customer-facing identity, app links, and support details for your VPN service.
- [VPN Customers](https://www.billingserv.com/docs/vpn/customers.md): Review VPN customers, bandwidth usage, and last-seen activity.
- [VPN Dashboard](https://www.billingserv.com/docs/vpn/dashboard.md): Monitor the main VPN service metrics from the admin panel.
- [VPN Server Stats](https://www.billingserv.com/docs/vpn/server-stats.md): Inspect the latest CPU, memory, disk, and network metrics for a VPN server.
- [VPN Servers](https://www.billingserv.com/docs/vpn/servers.md): Add, configure, and monitor the servers used by the VPN service.

## OpenAPI Specs

- [openapi](https://www.billingserv.com/docs/api-reference/openapi.json)

## Optional

- [BillingServ](https://www.billingserv.com/)
- [Blog](https://www.billingserv.com/blog/)