# Hyperline

## Docs

- [Documentation](https://docs.hyperline.co/docs/index.md): Hyperline documentation: manage customer intelligence, CPQ, subscriptions, AI monetization, invoicing, payments, accounting, and developer integrations.
- [Why building billing in-house is risky](https://docs.hyperline.co/docs/introduction/why-billing-is-complex.md): Understand why building a billing system in-house is risky for growing software companies, and how a dedicated platform supports pricing changes.
- [Glossary](https://docs.hyperline.co/docs/introduction/glossary.md): Look up Hyperline billing terminology, including customers, products, subscriptions, invoices, aggregators, and ledgers, with clear definitions.
- [Quick start](https://docs.hyperline.co/docs/getting-started/quick-start.md): Follow the shortest path to configure your Hyperline account, test safely in sandbox, create your first billing objects, and issue your first invoice.
- [Configure your account](https://docs.hyperline.co/docs/getting-started/configure-account.md): Configure your Hyperline account: business information, brand identity, logo, favicon, payment providers, and billing settings during onboarding.
- [Sandbox and test mode](https://docs.hyperline.co/docs/getting-started/sandbox.md): Use Hyperline's sandbox and test mode to safely experiment with subscriptions, invoices, and payment flows before switching to production.
- [Account settings](https://docs.hyperline.co/docs/account/settings.md): Configure general Hyperline account settings including account name, supported currencies, email notifications, saved views, and Markdown formatting.
- [Users & permissions](https://docs.hyperline.co/docs/account/users-permissions.md): Invite or automatically provision team members, configure single sign-on, and assign roles to control access to your Hyperline account.
- [Invoicing entities](https://docs.hyperline.co/docs/account/invoicing-entities.md): Manage multiple billing profiles under one Hyperline account with invoicing entities, each with its own tax setup, legal info, and payment methods.
- [Single sign-on and user provisioning](https://docs.hyperline.co/docs/account/enterprise-sso.md): Connect Google Workspace for single sign-on, directory synchronization, automatic user provisioning, and group-based role assignment.
- [Customers](https://docs.hyperline.co/docs/customers/overview.md): Manage the individuals and companies you bill in Hyperline: create customers manually or via API, track subscriptions, and update billing info.
- [How the customer balance is calculated](https://docs.hyperline.co/docs/customers/balance.md): Learn how Hyperline calculates a customer account balance from outstanding invoices, credit notes, and wallet credit, and how to read it.
- [Customer segments](https://docs.hyperline.co/docs/customers/segments.md): Group Hyperline customers into dynamic segments using rule-based filters on country, currency, subscription status, custom properties, and more.
- [Public customer portal](https://docs.hyperline.co/docs/customers/portal.md): Give customers a hosted Hyperline portal to manage subscriptions, payment methods, invoices, and billing information across multiple languages.
- [Organisation-based billing](https://docs.hyperline.co/docs/customers/organisation-based.md): Bill multiple Hyperline customers under a single parent account with organisation-based billing, while keeping each child's subscriptions distinct.
- [Customer exports](https://docs.hyperline.co/docs/customers/exports.md): Export Hyperline customer data to CSV — including subscriptions, estimated ARR, payment status, and contact details — for external analysis.
- [Customer intelligence](https://docs.hyperline.co/docs/customer-intelligence/overview.md): Use Hyperline customer intelligence to monitor account health, usage trends, ownership, followers, and payment behavior signals in one place.
- [Customer monitoring agent](https://docs.hyperline.co/docs/customer-intelligence/customer-monitoring-agent.md): Configure the Hyperline customer monitoring agent to analyze account health, surface risk signals, and notify the right teammates automatically.
- [Custom usage tracking](https://docs.hyperline.co/docs/customer-intelligence/custom-usage-tracking.md): Assign usage aggregators directly to customers for monitoring and threshold alerts without creating a subscription or billing them.
- [Owner and followers](https://docs.hyperline.co/docs/customer-intelligence/owner-followers.md): Assign a customer owner, follow customers or segments, and route Hyperline monitoring notifications using owner and follower signals.
- [Late payment behavior](https://docs.hyperline.co/docs/customer-intelligence/late-payment-behavior.md): Use Hyperline's late payment behavior smart segment and payment metrics to identify at-risk customers and prioritize collections outreach.
- [Products and prices](https://docs.hyperline.co/docs/products/overview.md): Manage your product catalog in Hyperline: define products, pricing models, currencies, intervals, and reusable price configurations for billing.
- [Price books](https://docs.hyperline.co/docs/price-books/overview.md): Extend the Hyperline product catalog with price books, giving specific roles or customers tailored pricing on quotes and subscriptions.
- [Coupons](https://docs.hyperline.co/docs/coupons/overview.md): Create reusable coupons in Hyperline that apply fixed-amount or percentage discounts to subscriptions, invoices, and checkout flows.
- [Promotion codes](https://docs.hyperline.co/docs/coupons/promotion-codes.md): Let customers redeem coupon discounts using promotion codes during Hyperline checkout, with code-level redemption rules and product targeting.
- [Feature entitlements](https://docs.hyperline.co/docs/entitlements/overview.md): Manage product capabilities, feature flags, and usage limits in Hyperline with catalog features, product grants, and per-customer overrides.
- [Subscriptions overview](https://docs.hyperline.co/docs/subscriptions/overview.md): Understand the Hyperline subscription model: a contract between you and a customer, with products, pricing, terms, and scheduled future changes.
- [Create a subscription](https://docs.hyperline.co/docs/subscriptions/create.md): Assign subscriptions to customers in Hyperline manually or via templates, with options for trials, contracts, billing cycles, and activation strategies.
- [Usage-based product metering](https://docs.hyperline.co/docs/subscriptions/metering.md): Configure usage-based products in Hyperline by linking them to aggregators that turn raw events into billable metrics at the end of each period.
- [Upfront metered products](https://docs.hyperline.co/docs/subscriptions/upfront-metering.md): Bill usage-based products upfront at the start of each period based on projected consumption, then true-up against actual usage on the next invoice.
- [Automated seat-based billing](https://docs.hyperline.co/docs/subscriptions/connected-seats.md): Automate seat-based billing in Hyperline by syncing seat counts directly from your database in real time as users, licenses, or units change.
- [Manage a subscription](https://docs.hyperline.co/docs/subscriptions/manage.md): Manage the Hyperline subscription lifecycle: activate pending subscriptions, pause invoice issuance, cancel, reactivate, and generate future invoices.
- [Update subscription](https://docs.hyperline.co/docs/subscriptions/update.md): Update active Hyperline subscriptions globally or locally — change products, prices, quantities, contract terms — with previews and version history.
- [Subscription phases](https://docs.hyperline.co/docs/subscriptions/phases.md): Split Hyperline subscriptions into phases with different products and coupons to build ramp-up deals, free trials, and evolving contracts.
- [Contract duration](https://docs.hyperline.co/docs/subscriptions/contracts.md): Add a contract duration to Hyperline subscriptions to reflect contractual commitments with start and end dates, replacing the legacy commitment model.
- [Subscription templates](https://docs.hyperline.co/docs/subscriptions/templates.md): Pre-configure reusable subscription templates in Hyperline that auto-fill products, pricing, billing cycles, and contract terms during assignment.
- [Checkout page](https://docs.hyperline.co/docs/subscriptions/checkout-page.md): Create hosted Hyperline checkout sessions where customers review pricing, enter billing details, and pay securely across multiple payment methods.
- [Subscription exports](https://docs.hyperline.co/docs/subscriptions/exports.md): Export Hyperline subscription data to CSV — including products, prices, ARR, billing cycle, and customer info — for accounting and analysis.
- [Subscription translation overrides](https://docs.hyperline.co/docs/subscriptions/translations.md): Store custom product names and descriptions per Hyperline subscription so invoices stay translated for multilingual customers despite catalog edits.
- [Create and send quotes](https://docs.hyperline.co/docs/quotes/overview.md): Run a full CPQ process in Hyperline: configure products, set custom prices, generate quotes for signature, and auto-activate the subscription.
- [Quote signature](https://docs.hyperline.co/docs/quotes/signature.md): Collect customer signatures on Hyperline quotes — basic digital signature, DocuSign, Yousign, or countersigner workflows to formalize agreements.
- [Quote templates](https://docs.hyperline.co/docs/quotes/templates.md): Speed up the Hyperline quoting process with reusable quote templates that pre-fill products, pricing, terms, and clauses for sales teams.
- [Quote for subscription update](https://docs.hyperline.co/docs/quotes/subscription-update.md): Generate a Hyperline quote to update an active subscription with customer approval — ideal for contract upsells, add-ons, and price changes.
- [Quote for one-off invoice](https://docs.hyperline.co/docs/quotes/one-off-invoice.md): Create Hyperline quotes for one-off invoices to charge non-recurring fees, project work, or one-time setup costs that customers can sign and pay.
- [Quote approval](https://docs.hyperline.co/docs/quotes/approval.md): Add multi-step approval workflows to Hyperline quotes so sales managers and finance can review and approve deals before they reach the customer.
- [Use Hyperline CPQ with Stripe Billing](https://docs.hyperline.co/docs/quotes/stripe-billing.md): Integrate Hyperline CPQ with your existing Stripe Billing setup to give sales a robust quoting workflow while keeping Stripe as the billing engine.
- [Invoices overview](https://docs.hyperline.co/docs/invoices/overview.md): Automate recurring invoicing and create one-off invoices in Hyperline, with automatic line items from subscriptions, multi-currency support, and PDFs.
- [Invoice configuration](https://docs.hyperline.co/docs/invoices/configuration.md): Configure Hyperline invoices from settings: brand assets, trade and legal names, tax IDs, footers, numbering format, and default behaviors.
- [Manage invoices](https://docs.hyperline.co/docs/invoices/manage.md): Create, edit, and duplicate Hyperline invoices manually for ad-hoc billing needs that fall outside subscription or recurring payment flows.
- [Credit notes & refunds](https://docs.hyperline.co/docs/invoices/refunds.md): Issue credit notes and process refunds in Hyperline: cancel charges, return funds via the original payment method, or top up customer wallets.
- [Custom documents](https://docs.hyperline.co/docs/invoices/documents.md): Create custom Hyperline documents with unique names that behave like invoices — numbered, payable, and tailored to specific business needs.
- [Tax management](https://docs.hyperline.co/docs/invoices/tax-management.md): Apply the right VAT and sales tax rules on Hyperline invoices, with country-specific rates, reverse charge logic, and exemption handling.
- [Invoice reminders & dunning](https://docs.hyperline.co/docs/invoices/reminders.md): Automate payment reminders and dunning sequences for overdue Hyperline invoices, with configurable email cadence and escalation rules.
- [E-invoicing overview](https://docs.hyperline.co/docs/invoices/einvoicing/overview.md): Understand e-invoicing compliance with Hyperline: standardized digital invoice transmission across regions like the European Union and beyond.
- [French e-invoicing with a PA](https://docs.hyperline.co/docs/invoices/einvoicing/france-pa.md): Transmit French domestic B2B e-invoices in Factur-X format through a Plateforme Agréée using Hyperline or Pennylane, with customer routing setup.
- [Chorus Pro](https://docs.hyperline.co/docs/invoices/einvoicing/chorus-pro.md): Send invoices automatically to French public administrations via Chorus Pro with Hyperline's e-invoicing integration for B2G and G2G sales.
- [Peppol](https://docs.hyperline.co/docs/invoices/einvoicing/peppol.md): Send compliant electronic invoices to Belgian and German customers over the Peppol network with Hyperline using the Peppol BIS Billing UBL format.
- [Invoice payment term](https://docs.hyperline.co/docs/invoices/term.md): Set invoice payment terms in Hyperline to define how long customers have to pay and when invoices are flagged as late, with configurable defaults.
- [Consolidated invoicing](https://docs.hyperline.co/docs/invoices/consolidated-invoicing.md): Merge a customer's subscription invoices billed on the same day into one consolidated invoice, so they receive and pay a single invoice instead of many.
- [Reconciliation](https://docs.hyperline.co/docs/invoices/reconciliations.md): Reconcile invoices with banking transactions in Hyperline — automatic matching for PSP card and SEPA payments, plus bank statement import.
- [Invoice exports](https://docs.hyperline.co/docs/invoices/exports.md): Export Hyperline invoice data with built-in CSV exports — simple, accounting, or comprehensive formats — for bookkeeping and external analysis.
- [Invoice emails](https://docs.hyperline.co/docs/invoices/emails.md): Send automated invoice email notifications to customers in Hyperline when an invoice is issued, paid, or overdue, with customizable recipients.
- [Public invoice page](https://docs.hyperline.co/docs/invoices/invoice-page.md): Share a hosted public invoice page where customers can view, download, and pay outstanding or paid invoices through a secure Hyperline link.
- [Payment orchestration](https://docs.hyperline.co/docs/payments/orchestration.md): Connect Stripe, Adyen, GoCardless, and other PSPs in one click — Hyperline orchestrates payment processing, customer sync, and reconciliation.
- [Payment methods](https://docs.hyperline.co/docs/payments/payment-methods.md): Browse Hyperline-supported payment methods: credit cards, SEPA and ACH direct debit, bank transfers, Apple Pay, Google Pay, and more by country.
- [Handling payment errors](https://docs.hyperline.co/docs/payments/payment-errors.md): Diagnose and resolve failed Hyperline payments: understand decline reasons, retry logic, and how to recover unpaid invoices for customers.
- [Scheduled transactions](https://docs.hyperline.co/docs/payments/scheduled-transactions.md): Schedule future Hyperline transactions on a chosen payment method and date — useful for installments or splitting an invoice across methods.
- [Payout reconciliation](https://docs.hyperline.co/docs/payments/payouts.md): Reconcile payment service provider payouts against bank account transactions in Hyperline, with grouped payment matching and finance overviews.
- [AI monetization](https://docs.hyperline.co/docs/ai-monetization/overview.md): Use Hyperline to monetize AI products with usage-based billing, prepaid credits, wallets, subscriptions, and customer-facing balance workflows.
- [Dashboard](https://docs.hyperline.co/docs/analytics/dashboard.md): Explore the Hyperline dashboard: track collected revenue, outstanding invoices, and weekly performance with daily refreshed billing metrics.
- [Reports](https://docs.hyperline.co/docs/analytics/reports.md): Browse Hyperline's pre-built finance reports — accounts receivable, MRR movements, cohorts, exports — and download them for deeper analysis.
- [Insights](https://docs.hyperline.co/docs/analytics/insights.md): Track MRR, ARR, churn, and revenue metrics in Hyperline Insights with interactive charts, drill-down tables, and custom filters for finance teams.
- [Automated exports](https://docs.hyperline.co/docs/analytics/automated-exports.md): Set up automated data syncs that push Hyperline datasets — invoices, customers, subscriptions — to your PostgreSQL database on a recurring schedule.
- [Sentinel monitoring](https://docs.hyperline.co/docs/sentinel/overview.md): Monitor Hyperline billing operations with Sentinel — actionable tasks for failed payments, disconnected integrations, and other revenue issues.
- [Getting started with usage-based billing](https://docs.hyperline.co/docs/usage/getting-started.md): Build your first usage-based billing workflow in Hyperline: send events, create an aggregator, configure a metered product, and bill a subscription.
- [Aggregators](https://docs.hyperline.co/docs/usage/aggregators.md): Configure aggregators to transform raw usage events into billable metrics for subscription products or assign them to customers for usage monitoring.
- [Customer usage](https://docs.hyperline.co/docs/usage/customer-usage.md): Monitor per-customer consumption from subscription-linked and directly assigned usage aggregators with real-time charts, thresholds, and event details.
- [Global usage](https://docs.hyperline.co/docs/usage/global-usage.md): View aggregator usage across all Hyperline customers from one place, drill into top consumers, and analyze billable metric trends in real time.
- [Import events with a CSV file](https://docs.hyperline.co/docs/usage/import-events-csv.md): Import usage events into Hyperline in bulk by uploading a CSV file from Google Sheets, Excel, or any spreadsheet editor with required fields.
- [Send usage data](https://docs.hyperline.co/docs/usage/send-usage-data.md): Send usage events to Hyperline through the API to drive usage-based billing, with guidance on event design, payload structure, and best practices.
- [Simulate usage data](https://docs.hyperline.co/docs/usage/simulate-usage-data.md): Simulate usage events in Hyperline's sandbox without code to test usage-based subscriptions and explore billing behavior before going to production.
- [Explore usage events and consumption](https://docs.hyperline.co/docs/usage/explore-usage-consumption.md): Explore raw usage events in Hyperline at global, customer, subscription, and invoice levels, or pull events programmatically through the API.
- [Pull usage data with connectors](https://docs.hyperline.co/docs/usage/usage-data-with-connectors.md): Pull usage data from your own database into Hyperline using connectors for PostgreSQL, BigQuery, Snowflake, and MongoDB without writing API code.
- [Connect with BigQuery](https://docs.hyperline.co/docs/usage/bigquery.md): Connect a Google BigQuery dataset to Hyperline as a data loader to pull usage events automatically, with service account permissions and queries.
- [Connect with MongoDB](https://docs.hyperline.co/docs/usage/mongodb.md): Connect a MongoDB database to Hyperline as a data loader to pull usage events automatically, without writing custom integrations or API code.
- [Connect with Snowflake](https://docs.hyperline.co/docs/usage/snowflake.md): Connect a Snowflake warehouse to Hyperline as a data loader to pull usage events automatically, with credentials and query configuration steps.
- [Connect with PostHog](https://docs.hyperline.co/docs/usage/posthog.md): Connect a PostHog Cloud project to Hyperline and import product events into usage-based billing using a scheduled HogQL query data loader.
- [Getting started with accounting](https://docs.hyperline.co/docs/accounting/getting-started.md): Set up accounting in Hyperline: create your first ledger and let Hyperline generate journal entries from your billing activity automatically.
- [Ledgers](https://docs.hyperline.co/docs/accounting/ledgers.md): Create and manage Hyperline accounting ledgers per invoicing entity for statutory, management, or consolidation books with isolated entries.
- [Chart of accounts](https://docs.hyperline.co/docs/accounting/accounts.md): Manage the chart of accounts for each Hyperline ledger: pre-populate GL accounts, customize them, and reference them in accounting rules.
- [Accounting rules](https://docs.hyperline.co/docs/accounting/rules.md): Configure accounting rules that determine which GL accounts Hyperline debits and credits for invoices, payments, credit notes, and refunds.
- [How entries are computed](https://docs.hyperline.co/docs/accounting/entry-mechanics.md): Understand the debits and credits Hyperline posts for each billing event: invoice posting, revenue recognition, usage, settlement, refunds, and credit notes.
- [Journal entries](https://docs.hyperline.co/docs/accounting/entries.md): Browse every journal entry from the Journal tab, drill into a single account's lines from the Ledger, and audit accounting activity in any Hyperline ledger.
- [Revenue recognition](https://docs.hyperline.co/docs/accounting/revenue-recognition.md): Automate deferred revenue and recognition schedules in Hyperline, with per-line schedules and journal entries posted as revenue is earned.
- [Credits overview](https://docs.hyperline.co/docs/credits/overview.md): Set up customer credit balances in Hyperline: configure credit products, expiration, auto top-up, and apply them across plans and subscriptions.
- [Wallets overview](https://docs.hyperline.co/docs/wallets/overview.md): Manage customer prepaid balances in Hyperline wallets — top up funds, auto-apply to invoices, and support upfront billing or pay-as-you-go flows.
- [Manage wallet balance](https://docs.hyperline.co/docs/wallets/balance.md): Top up Hyperline customer wallets via prepayment, offline payments, free funds, the customer portal, or the API, and track every wallet movement.
- [Custom properties](https://docs.hyperline.co/docs/properties/overview.md): Define custom properties in Hyperline to store extra data on customers, products, subscriptions, and invoices, and use them across templates.
- [Getting started with the Hyperline API](https://docs.hyperline.co/api-reference/docs/getting-started.md): Start building with the Hyperline API: create your API key, make your first request, explore key endpoints, and integrate billing into your product.
- [Authentication](https://docs.hyperline.co/api-reference/docs/authentication.md): Authenticate to the Hyperline API with bearer tokens, manage API keys, and configure secure access for production and sandbox environments.
- [Pagination and filtering](https://docs.hyperline.co/api-reference/docs/pagination.md): Paginate and filter Hyperline API list endpoints with cursor-based pagination, page sizes, and per-endpoint filter parameters for efficient queries.
- [Error handling](https://docs.hyperline.co/api-reference/docs/error-handling.md): Handle Hyperline API errors safely: HTTP status codes, error response payloads, validation failures, retry guidance, and common troubleshooting.
- [Rate limiting](https://docs.hyperline.co/api-reference/docs/rate-limiting.md): Understand Hyperline API rate limits, response headers, and best practices to handle 429 responses with retries and exponential backoff strategies.
- [Idempotent requests](https://docs.hyperline.co/api-reference/docs/idempotent-requests.md): Safely retry Hyperline API requests using idempotency keys to avoid duplicate operations across customer, subscription, and payment endpoints.
- [Currency amounts](https://docs.hyperline.co/api-reference/docs/amount.md): Understand how Hyperline represents monetary values in the API — currency, integer amounts in minor units, and rounding rules across endpoints.
- [Dates & timezones](https://docs.hyperline.co/api-reference/docs/dates-and-timezones.md): Understand how Hyperline represents dates, datetimes, and timezones across the API — ISO 8601 formatting, UTC defaults, and billing-cycle conventions.
- [API upgrades](https://docs.hyperline.co/api-reference/docs/upgrades.md): Track Hyperline API changes, deprecations, and upgrades — see what's changed across versions and plan migrations for breaking changes safely.
- [Build with LLMs](https://docs.hyperline.co/api-reference/docs/ai/overview.md): Use Hyperline documentation and APIs with AI assistants, LLMs, and agent frameworks through CLI, MCP server, and structured machine-readable docs.
- [Hyperline MCP](https://docs.hyperline.co/api-reference/docs/ai/mcp.md): Connect AI assistants like Claude and Cursor to your Hyperline account through the Model Context Protocol for billing data lookups and actions.
- [Hyperline CLI](https://docs.hyperline.co/api-reference/docs/ai/cli.md): Use the Hyperline CLI — an agent-first command-line tool — to query customers, subscriptions, invoices, and events directly from your terminal.
- [React components](https://docs.hyperline.co/api-reference/docs/react-components.md): Embed Hyperline checkout, customer portal, and payment method components directly in your React application with the official React SDK.
- [Third-party app](https://docs.hyperline.co/api-reference/docs/third-party-app.md): Build a third-party app that connects to multiple Hyperline accounts via OAuth, with scoped permissions and secure token-based authorization.
- [Webhooks](https://docs.hyperline.co/api-reference/docs/webhooks.md): Receive webhook messages from Hyperline for entity events and user-triggered custom actions, with signing, delivery, and retry guidance.
- [Get accounting rule](https://docs.hyperline.co/api-reference/endpoints/accounting/get-accounting-rule.md): Retrieve a single accounting rule by its identifier.
- [List accounting rules](https://docs.hyperline.co/api-reference/endpoints/accounting/list-accounting-rules.md): Retrieve existing accounting rules with optional filtering.
- [Create accounting rule](https://docs.hyperline.co/api-reference/endpoints/accounting/create-accounting-rule.md): Create a new accounting rule for account code routing or journal posting.
- [Update accounting rule](https://docs.hyperline.co/api-reference/endpoints/accounting/update-accounting-rule.md): Update an existing accounting rule.
- [Resolve accounting rule](https://docs.hyperline.co/api-reference/endpoints/accounting/resolve-accounting-rule.md): Preview which account codes would be resolved for a given context.
- [Delete accounting rule](https://docs.hyperline.co/api-reference/endpoints/accounting/delete-accounting-rule.md): Soft-delete an accounting rule.
- [Get aggregator](https://docs.hyperline.co/api-reference/endpoints/aggregators/get-aggregator.md): Retrieve the details of an existing aggregator.
- [List aggregators](https://docs.hyperline.co/api-reference/endpoints/aggregators/list-aggregators.md): Retrieve existing aggregators.
- [Create aggregator](https://docs.hyperline.co/api-reference/endpoints/aggregators/create-aggregator.md): Create a new aggregator.
- [Update aggregator](https://docs.hyperline.co/api-reference/endpoints/aggregators/update-aggregator.md): Update the details of an existing aggregator.
- [Delete aggregator](https://docs.hyperline.co/api-reference/endpoints/aggregators/delete-aggregator.md): Delete an existing aggregator.
- [Get aggregator usage](https://docs.hyperline.co/api-reference/endpoints/aggregators->-usage/get-aggregator-usage.md): Retrieve a usage row for an aggregator (name, unit and thresholds).
- [Get aggregator usage timeseries](https://docs.hyperline.co/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-timeseries.md): Get client-wide usage for an aggregator bucketed by month, day or hour.
- [Get aggregator usage grouped by customer](https://docs.hyperline.co/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-grouped-by-customer.md): Per-customer total usage for an aggregator over a period, ordered by total DESC, paginated.
- [Get aggregator usage events](https://docs.hyperline.co/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-events.md): List raw billable events for an aggregator across every customer of the client.
- [Get analytics](https://docs.hyperline.co/api-reference/endpoints/analytics/get-analytics.md): Retrieve your pre-computed account's analytics (ARR, revenues, churn, etc).
- [Get approval workflow](https://docs.hyperline.co/api-reference/endpoints/approval-workflows/get-approval-workflow.md): Retrieve a single approval workflow.
- [List approval workflows](https://docs.hyperline.co/api-reference/endpoints/approval-workflows/list-approval-workflows.md): Retrieve approval workflows with optional filtering.
- [Create approval workflow](https://docs.hyperline.co/api-reference/endpoints/approval-workflows/create-approval-workflow.md): Create a new approval workflow.
- [Update approval workflow](https://docs.hyperline.co/api-reference/endpoints/approval-workflows/update-approval-workflow.md): Update an existing approval workflow.
- [Delete approval workflow](https://docs.hyperline.co/api-reference/endpoints/approval-workflows/delete-approval-workflow.md): Delete an existing approval workflow.
- [List audit logs](https://docs.hyperline.co/api-reference/endpoints/audit-logs/list-audit-logs.md): Retrieve existing audit logs. Sorted by `happened_at` descending.
- [Get bank account](https://docs.hyperline.co/api-reference/endpoints/bank-accounts/get-bank-account.md): Retrieve a specific bank account by ID.
- [List bank accounts](https://docs.hyperline.co/api-reference/endpoints/bank-accounts/list-bank-accounts.md): Retrieve existing bank accounts.
- [List bank transactions](https://docs.hyperline.co/api-reference/endpoints/bank-accounts/list-bank-transactions.md): Retrieve transactions for a specific connected bank account.
- [Get events](https://docs.hyperline.co/api-reference/endpoints/billable-events/get-events.md): Retrieve billable events filtered by event type.
- [Get billable event prices](https://docs.hyperline.co/api-reference/endpoints/billable-events/get-billable-event-prices.md): Get previous price simulation results for a billable event. You can search by either calculation_id / record_id or both.
- [Ingest billable event](https://docs.hyperline.co/api-reference/endpoints/billable-events/ingest-billable-event.md): Ingest a new billable event. This endpoint is idempotent, an event with the same id will be updated if it already exists.
- [Ingest billable events](https://docs.hyperline.co/api-reference/endpoints/billable-events/ingest-billable-events.md): Ingest several billable events in batch (limited to max 5000 events per request). This endpoint is idempotent, an event with the same id, will be updated if it already exists.
- [Simulate billable event prices](https://docs.hyperline.co/api-reference/endpoints/billable-events/simulate-billable-event-prices.md): Simulate prices for a single billable event without ingesting it.
- [Delete billable events](https://docs.hyperline.co/api-reference/endpoints/billable-events/delete-billable-events.md): Delete existing billable events.
- [Get catalog draft](https://docs.hyperline.co/api-reference/endpoints/catalog/get-catalog-draft.md): Retrieve the pending catalog draft, or null when no draft exists.
- [Get catalog version](https://docs.hyperline.co/api-reference/endpoints/catalog/get-catalog-version.md): Retrieve a single catalog version.
- [List catalog versions](https://docs.hyperline.co/api-reference/endpoints/catalog/list-catalog-versions.md): Retrieve the product catalog versions: the pending draft followed by published versions. Requires catalog versioning to be enabled.
- [Create catalog draft](https://docs.hyperline.co/api-reference/endpoints/catalog/create-catalog-draft.md): Create the pending draft from the current live catalog. Returns the existing draft when one is already pending.
- [Discard catalog draft](https://docs.hyperline.co/api-reference/endpoints/catalog/discard-catalog-draft.md): Archive the pending catalog draft without applying its changes.
- [Export catalog](https://docs.hyperline.co/api-reference/endpoints/catalog/export-catalog.md): Export the live product catalog as a portable snapshot (the same artifact the app exports), usable for backups or imports into another organisation.
- [Publish catalog draft](https://docs.hyperline.co/api-reference/endpoints/catalog/publish-catalog-draft.md): Apply the pending draft to the live catalog and mark it as a published version.
- [Revert catalog version](https://docs.hyperline.co/api-reference/endpoints/catalog/revert-catalog-version.md): Publish a new catalog version restoring the state of a previous published version (revert). Fails while a draft is pending.
- [List companies](https://docs.hyperline.co/api-reference/endpoints/companies/list-companies.md): Retrieve all companies that the authentication token has access to.
- [Create company](https://docs.hyperline.co/api-reference/endpoints/companies/create-company.md): Create a new company to which the authentication token will have access to.
- [Get coupon](https://docs.hyperline.co/api-reference/endpoints/coupons/get-coupon.md): Retrieve the details of an existing coupon.
- [List coupons](https://docs.hyperline.co/api-reference/endpoints/coupons/list-coupons.md): Retrieve existing coupons.
- [Create coupon](https://docs.hyperline.co/api-reference/endpoints/coupons/create-coupon.md): Create a new coupon.
- [Update coupon](https://docs.hyperline.co/api-reference/endpoints/coupons/update-coupon.md): Update the details of an existing coupon.
- [Delete coupon](https://docs.hyperline.co/api-reference/endpoints/coupons/delete-coupon.md): Delete an existing coupon.
- [Get promotion code](https://docs.hyperline.co/api-reference/endpoints/coupons->-promotion-codes/get-promotion-code.md): Retrieve the details of an existing promotion code.
- [List promotion codes](https://docs.hyperline.co/api-reference/endpoints/coupons->-promotion-codes/list-promotion-codes.md): Retrieve existing promotion codes.
- [Create promotion code](https://docs.hyperline.co/api-reference/endpoints/coupons->-promotion-codes/create-promotion-code.md): Create a new promotion code.
- [Update promotion code](https://docs.hyperline.co/api-reference/endpoints/coupons->-promotion-codes/update-promotion-code.md): Update the details of an existing promotion code.
- [Delete promotion code](https://docs.hyperline.co/api-reference/endpoints/coupons->-promotion-codes/delete-promotion-code.md): Delete an existing promotion code.
- [List custom properties](https://docs.hyperline.co/api-reference/endpoints/custom-properties/list-custom-properties.md): Retrieve all custom properties previously created.
- [Create custom property](https://docs.hyperline.co/api-reference/endpoints/custom-properties/create-custom-property.md): Create a new custom property.
- [Update custom property](https://docs.hyperline.co/api-reference/endpoints/custom-properties/update-custom-property.md): Update an existing custom property.
- [Delete custom property](https://docs.hyperline.co/api-reference/endpoints/custom-properties/delete-custom-property.md): Delete an existing custom property.
- [Get customer](https://docs.hyperline.co/api-reference/endpoints/customers/get-customer.md): Retrieve the details of an existing customer.
- [Get customer](https://docs.hyperline.co/api-reference/endpoints/customers/get-customer-1.md): We recommend using the `GET /v2/customers/{id}` endpoint instead.
- [Get customer portal](https://docs.hyperline.co/api-reference/endpoints/customers/get-customer-portal.md): Retrieve the URL of the customer portal.
- [Get customer tax rates](https://docs.hyperline.co/api-reference/endpoints/customers/get-customer-tax-rates.md): Retrieve the eligible tax rates for a customer.
- [Get customer ARR history](https://docs.hyperline.co/api-reference/endpoints/customers/get-customer-arr-history.md): List the subscription-level ARR evolutions for a customer in reverse chronological order.
- [Get customer valuation](https://docs.hyperline.co/api-reference/endpoints/customers/get-customer-valuation.md): Compute aggregated valuation metrics across all active subscriptions for a customer.
- [List customers](https://docs.hyperline.co/api-reference/endpoints/customers/list-customers.md): We recommend using the `GET /v2/customers` endpoint instead.
- [List customers](https://docs.hyperline.co/api-reference/endpoints/customers/list-customers-1.md): Retrieve existing customers.
- [Create customer](https://docs.hyperline.co/api-reference/endpoints/customers/create-customer.md): Create a new customer.
- [Create customers batch](https://docs.hyperline.co/api-reference/endpoints/customers/create-customers-batch.md): Create a batch of new customers.
- [Update customer](https://docs.hyperline.co/api-reference/endpoints/customers/update-customer.md): Update the details of an existing customer.
- [Archive customer](https://docs.hyperline.co/api-reference/endpoints/customers/archive-customer.md): Archive an existing customer.
- [Bulk update providers/customers mapping](https://docs.hyperline.co/api-reference/endpoints/customers/bulk-update-providerscustomers-mapping.md): Bulk update providers/customers mapping, make sure to check the query response to see if all customers were updated.
- [Unarchive customer](https://docs.hyperline.co/api-reference/endpoints/customers/unarchive-customer.md): Unarchive an archived customer.
- [Delete customer](https://docs.hyperline.co/api-reference/endpoints/customers/delete-customer.md): Delete an existing customer. The customer must be archived prior to the deletion.
- [Get credit product](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/get-credit-product.md): Retrieve the details of an existing credit product for a customer.
- [List all credit products](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/list-all-credit-products.md): Retrieve credit products for all customers.
- [List credit products](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/list-credit-products.md): Retrieve credit products attached to a customer.
- [List credit transactions](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/list-credit-transactions.md): Retrieve all credit transactions associated with a credit product.
- [Create credit product](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/create-credit-product.md): Create a credit entity for a given product with an optional balance.
- [Create credits usage](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/create-credits-usage.md): Create a usage entry for a credit product. This will impact the balance of the customer by `usage_retained`.
- [Update credit product](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/update-credit-product.md): Update the configuration of a customer's credit product.
- [Update credit topup expiration](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/update-credit-topup-expiration.md): Update the expiration date of a topup credit transaction. Only non-expired topup transactions can be updated.
- [Purchase credits](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/purchase-credits.md): Purchase a number of credits. This action will generate an invoice and charge the customer.
- [Topup credits](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/topup-credits.md): Topup a number of free credits. This action will not charge the customer.
- [Resolve customer features](https://docs.hyperline.co/api-reference/endpoints/customers->-features/resolve-customer-features.md): Resolve feature values for a customer.
- [Set customer feature](https://docs.hyperline.co/api-reference/endpoints/customers->-features/set-customer-feature.md): Set a feature override for a customer.
- [Delete customer feature](https://docs.hyperline.co/api-reference/endpoints/customers->-features/delete-customer-feature.md): Delete a feature override from a customer.
- [Get payment method](https://docs.hyperline.co/api-reference/endpoints/customers->-payment-methods/get-payment-method.md): Retrieve the details of an existing customer payment method.
- [List payment methods](https://docs.hyperline.co/api-reference/endpoints/customers->-payment-methods/list-payment-methods.md): Retrieve payment methods attached to a customer.
- [Create payment method](https://docs.hyperline.co/api-reference/endpoints/customers->-payment-methods/create-payment-method.md): Import an existing customer payment method from a connected payment provider.
- [Delete payment method](https://docs.hyperline.co/api-reference/endpoints/customers->-payment-methods/delete-payment-method.md): Delete an existing customer payment method.
- [Get segment](https://docs.hyperline.co/api-reference/endpoints/customers->-segments/get-segment.md): Retrieve the details of an existing customer segment.
- [List segments](https://docs.hyperline.co/api-reference/endpoints/customers->-segments/list-segments.md): Retrieve all customer segments.
- [Create segment](https://docs.hyperline.co/api-reference/endpoints/customers->-segments/create-segment.md): Create a new customer segment.
- [Update segment](https://docs.hyperline.co/api-reference/endpoints/customers->-segments/update-segment.md): Update an existing customer segment.
- [Delete segment](https://docs.hyperline.co/api-reference/endpoints/customers->-segments/delete-segment.md): Delete an existing customer segment.
- [Get customer usage for an aggregator](https://docs.hyperline.co/api-reference/endpoints/customers->-usage/get-customer-usage-for-an-aggregator.md): Get the usage of a customer for a specific aggregator over a period.
- [Get customer usage timeseries](https://docs.hyperline.co/api-reference/endpoints/customers->-usage/get-customer-usage-timeseries.md): Get the usage of a customer for an aggregator bucketed by month, day or hour.
- [Get customer usage events](https://docs.hyperline.co/api-reference/endpoints/customers->-usage/get-customer-usage-events.md): List raw billable events for a customer and a specific aggregator over a period.
- [List customer usage](https://docs.hyperline.co/api-reference/endpoints/customers->-usage/list-customer-usage.md): List one usage row per aggregator for a single customer over a period. Use `GET /v1/aggregators/{id}/usage/group-by-customer` for the inverse: one row per customer for a single aggregator.
- [Get export](https://docs.hyperline.co/api-reference/endpoints/exports/get-export.md): Retrieve the details of an existing export.
- [List exports](https://docs.hyperline.co/api-reference/endpoints/exports/list-exports.md): List previously created exports, most recent first.
- [Download export](https://docs.hyperline.co/api-reference/endpoints/exports/download-export.md): Download the file associated with a specific export. Pass `as_redirect=true` to receive a 302 redirect to a short-lived S3 signed URL instead of the file body.
- [Create export](https://docs.hyperline.co/api-reference/endpoints/exports/create-export.md): Prepare an export of a given type for download. You can check the export readiness status using the GET endpoint. Once the export is ready, download the export using the download endpoint.
- [Get feature](https://docs.hyperline.co/api-reference/endpoints/features/get-feature.md): Retrieve a feature definition.
- [List features](https://docs.hyperline.co/api-reference/endpoints/features/list-features.md): List feature definitions.
- [Create feature](https://docs.hyperline.co/api-reference/endpoints/features/create-feature.md): Create a feature definition.
- [Update feature](https://docs.hyperline.co/api-reference/endpoints/features/update-feature.md): Update a feature definition.
- [Archive feature](https://docs.hyperline.co/api-reference/endpoints/features/archive-feature.md): Archive a feature definition.
- [Unarchive feature](https://docs.hyperline.co/api-reference/endpoints/features/unarchive-feature.md): Unarchive a feature definition.
- [Delete feature](https://docs.hyperline.co/api-reference/endpoints/features/delete-feature.md): Delete an archived feature definition that is not in use.
- [List files](https://docs.hyperline.co/api-reference/endpoints/files/list-files.md): Retrieve existing files.
- [Download file](https://docs.hyperline.co/api-reference/endpoints/files/download-file.md): Download an existing file content.
- [Create file](https://docs.hyperline.co/api-reference/endpoints/files/create-file.md): Create a new file.
- [Delete file](https://docs.hyperline.co/api-reference/endpoints/files/delete-file.md): Delete an existing file.
- [Create component token](https://docs.hyperline.co/api-reference/endpoints/integrations/create-component-token.md): Create a new token for embedded components.
- [Get invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/get-invoice.md): We recommend using the `GET /v2/invoices/{id}` endpoint instead.
- [Get invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/get-invoice-1.md): Retrieve the details of an existing invoice.
- [List invoices](https://docs.hyperline.co/api-reference/endpoints/invoices/list-invoices.md): We recommend using the `GET /v2/invoices` endpoint instead.
- [List invoices](https://docs.hyperline.co/api-reference/endpoints/invoices/list-invoices-1.md): Retrieve existing invoices. By default, invoices with status open are not included.
- [Download invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/download-invoice.md): Download the PDF of an existing invoice. If the invoice is in draft or open status, the PDF will be generated without redirect
- [Create invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/create-invoice.md): Create a new invoice.
- [Create credit note](https://docs.hyperline.co/api-reference/endpoints/invoices/create-credit-note.md): Create a credit note for an existing invoice.
- [Create invoices](https://docs.hyperline.co/api-reference/endpoints/invoices/create-invoices.md): Create invoices async in batch. Results can be tracked via webhooks with the `invoice.batch.creation_succeeded` and `invoice.batch.creation_failed` events.
- [Update invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/update-invoice.md): Update an invoice. Draft and grace_period invoices allow full edits; finalized invoices are restricted (paid: custom_note and purchase_order only; uncollectible: metadata only — properties, custom_note, custom_properties).
- [Charge invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/charge-invoice.md): Manually trigger the payment of the invoice.
- [Mark as uncollectible](https://docs.hyperline.co/api-reference/endpoints/invoices/mark-as-uncollectible.md): Mark an invoice as uncollectible, useful for keeping track of bad debts that can be written off for accounting purposes.
- [Send invoice emails](https://docs.hyperline.co/api-reference/endpoints/invoices/send-invoice-emails.md): Send a specific email (`email_type`) to the customer for a list of invoices, asynchronously in batch. An invoice whose status doesn't resolve to the requested email is skipped. Results can be tracked via webhooks with the `invoice.batch.email_succeeded`, `invoice.batch.email_skipped` and `invoice.ba…
- [Upload PDF to invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/upload-pdf-to-invoice.md): Upload a PDF file to an existing invoice.
- [Validate draft invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/validate-draft-invoice.md): Send a draft invoice for payment, set the status to `to_pay` and its number. This is not reversible.
- [Void invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/void-invoice.md): Void an invoice in a `to_pay` status. This action generates a corresponding credit note.
- [Delete invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/delete-invoice.md): Delete an invoice in `draft` status or imported from an external source. For other statuses, the `POST /v1/invoices/{id}/void` endpoint must be used.
- [List invoice events](https://docs.hyperline.co/api-reference/endpoints/invoices->-events/list-invoice-events.md): Retrieve billable events for an invoice, with per-event pricing computed against the invoice's billing rules. Works for any invoice status: draft and open invoices compute pricing live, finalized invoices serve the snapshot taken at issuance. Per-event amounts are gross — discounts (coupons, percent…
- [Create transaction](https://docs.hyperline.co/api-reference/endpoints/invoices->-transactions/create-transaction.md): Create a transaction linked to an existing invoice. This may update the invoice status to paid/partially paid.
- [Delete transaction](https://docs.hyperline.co/api-reference/endpoints/invoices->-transactions/delete-transaction.md): Delete a scheduled transaction or wallet debit linked to an existing invoice.
- [Get invoicing entity](https://docs.hyperline.co/api-reference/endpoints/invoicing-entities/get-invoicing-entity.md): Retrieve a specific invoicing entity.
- [List invoicing entities](https://docs.hyperline.co/api-reference/endpoints/invoicing-entities/list-invoicing-entities.md): Retrieve existing invoicing entities.
- [Create invoicing entity](https://docs.hyperline.co/api-reference/endpoints/invoicing-entities/create-invoicing-entity.md): Create a new invoicing entity to send invoices from.
- [Update invoicing entity](https://docs.hyperline.co/api-reference/endpoints/invoicing-entities/update-invoicing-entity.md): Update an existing invoicing entity.
- [Delete invoicing entity](https://docs.hyperline.co/api-reference/endpoints/invoicing-entities/delete-invoicing-entity.md): Soft deletes an invoicing entity. This action won't delete the associated invoices.
- [Get user info](https://docs.hyperline.co/api-reference/endpoints/oauth2/get-user-info.md): Returns user information for the authenticated access token.
- [Authorize](https://docs.hyperline.co/api-reference/endpoints/oauth2/authorize.md): Initiates OAuth authorization flow.
- [Generate tokens](https://docs.hyperline.co/api-reference/endpoints/oauth2/generate-tokens.md): Exchange authorization code for access token or refresh an existing token.
- [OAuth callback](https://docs.hyperline.co/api-reference/endpoints/oauth2/oauth-callback.md): Handles authorization callback and redirects to client's registered URI.
- [Register OAuth client](https://docs.hyperline.co/api-reference/endpoints/oauth2/register-oauth-client.md): Register a dynamic OAuth client per RFC 7591.
- [Revoke token](https://docs.hyperline.co/api-reference/endpoints/oauth2/revoke-token.md): Revoke an access or refresh token.
- [Get organisation](https://docs.hyperline.co/api-reference/endpoints/organisations/get-organisation.md): Retrieve the details of an existing organisation.
- [Patch organisation](https://docs.hyperline.co/api-reference/endpoints/organisations/patch-organisation.md): Update the details of an existing organisation.
- [Create payment](https://docs.hyperline.co/api-reference/endpoints/payments/create-payment.md): Initiate a new payment (limited to one-time): generate an invoice and charge it directly or with a checkout session
- [Get price book](https://docs.hyperline.co/api-reference/endpoints/price-books/get-price-book.md): Retrieve the details of an existing price book.
- [List price books](https://docs.hyperline.co/api-reference/endpoints/price-books/list-price-books.md): Retrieve existing price books.
- [Create price book](https://docs.hyperline.co/api-reference/endpoints/price-books/create-price-book.md): Create a new price book.
- [Update price book](https://docs.hyperline.co/api-reference/endpoints/price-books/update-price-book.md): Update the details of an existing price book.
- [Add products to price book](https://docs.hyperline.co/api-reference/endpoints/price-books/add-products-to-price-book.md): Add products to a price book by copying their default price configurations.
- [Remove product from price book](https://docs.hyperline.co/api-reference/endpoints/price-books/remove-product-from-price-book.md): Remove a product and its price configurations from a price book.
- [Delete price book](https://docs.hyperline.co/api-reference/endpoints/price-books/delete-price-book.md): Delete an existing price book.
- [Get price configuration](https://docs.hyperline.co/api-reference/endpoints/price-configurations/get-price-configuration.md): Retrieve the details of an existing price configuration.
- [List price configurations](https://docs.hyperline.co/api-reference/endpoints/price-configurations/list-price-configurations.md): Retrieve existing price configurations.
- [Create price configuration](https://docs.hyperline.co/api-reference/endpoints/price-configurations/create-price-configuration.md): Create a new price configuration on an existing product.
- [Update prices](https://docs.hyperline.co/api-reference/endpoints/price-configurations/update-prices.md): Update prices of an existing price configuration.
- [Delete price configuration](https://docs.hyperline.co/api-reference/endpoints/price-configurations/delete-price-configuration.md): Delete an existing price configuration.
- [Get product](https://docs.hyperline.co/api-reference/endpoints/products/get-product.md): Retrieve the details of an existing product. Only the first 50 price configurations are returned, to retrieve all of them use `GET /v1/price-configurations`.
- [List products](https://docs.hyperline.co/api-reference/endpoints/products/list-products.md): Retrieve existing products.
- [Create product](https://docs.hyperline.co/api-reference/endpoints/products/create-product.md): Create a new product.
- [Update product](https://docs.hyperline.co/api-reference/endpoints/products/update-product.md): Update the details of an existing product.
- [Archive product](https://docs.hyperline.co/api-reference/endpoints/products/archive-product.md): Archive an existing product.
- [Unarchive product](https://docs.hyperline.co/api-reference/endpoints/products/unarchive-product.md): Unarchive an archived product.
- [Delete product](https://docs.hyperline.co/api-reference/endpoints/products/delete-product.md): Delete an archived product that is not in use.
- [List product features](https://docs.hyperline.co/api-reference/endpoints/products->-features/list-product-features.md): List feature values assigned to a product.
- [Set product feature](https://docs.hyperline.co/api-reference/endpoints/products->-features/set-product-feature.md): Set a feature value for a product.
- [Delete product feature](https://docs.hyperline.co/api-reference/endpoints/products->-features/delete-product-feature.md): Delete a feature value from a product.
- [Get quote](https://docs.hyperline.co/api-reference/endpoints/quotes/get-quote.md): Retrieve the details of an existing quote.
- [Get quote valuation](https://docs.hyperline.co/api-reference/endpoints/quotes/get-quote-valuation.md): Compute valuation metrics for an existing quote.
- [List quotes](https://docs.hyperline.co/api-reference/endpoints/quotes/list-quotes.md): Retrieve existing quotes.
- [Download quote](https://docs.hyperline.co/api-reference/endpoints/quotes/download-quote.md): Download an existing quote.
- [Download quote file](https://docs.hyperline.co/api-reference/endpoints/quotes/download-quote-file.md): Download a file (attachment or manually signed file) attached to an existing quote.
- [Create quote](https://docs.hyperline.co/api-reference/endpoints/quotes/create-quote.md): Create a new quote.
- [Update quote](https://docs.hyperline.co/api-reference/endpoints/quotes/update-quote.md): Update an existing quote.
- [Approve quote](https://docs.hyperline.co/api-reference/endpoints/quotes/approve-quote.md): Approve an existing quote (acting as the account owner).
- [Duplicate quote](https://docs.hyperline.co/api-reference/endpoints/quotes/duplicate-quote.md): Create a draft duplicate of an existing quote.
- [Finalize quote](https://docs.hyperline.co/api-reference/endpoints/quotes/finalize-quote.md): Finalize a draft quote by submitting it for approval or marking it approved when no approval is required.
- [Send quote](https://docs.hyperline.co/api-reference/endpoints/quotes/send-quote.md): Send an existing quote by email for signature.
- [Sign quote](https://docs.hyperline.co/api-reference/endpoints/quotes/sign-quote.md): Manually mark the quote as signed externally. Built-in Hyperline signature flow won't be used.
- [Void quote](https://docs.hyperline.co/api-reference/endpoints/quotes/void-quote.md): Void an existing quote.
- [Get quote template](https://docs.hyperline.co/api-reference/endpoints/quotes->-templates/get-quote-template.md): Retrieve the details of an existing quote template.
- [List quote templates](https://docs.hyperline.co/api-reference/endpoints/quotes->-templates/list-quote-templates.md): Retrieve existing quote templates.
- [Get subscription](https://docs.hyperline.co/api-reference/endpoints/subscriptions/get-subscription.md): Retrieve the details of an existing subscription.
- [Get subscription ARR history](https://docs.hyperline.co/api-reference/endpoints/subscriptions/get-subscription-arr-history.md): List the ARR evolutions for a subscription in reverse chronological order.
- [Get subscription valuation](https://docs.hyperline.co/api-reference/endpoints/subscriptions/get-subscription-valuation.md): Compute valuation metrics for an existing subscription.
- [List subscriptions](https://docs.hyperline.co/api-reference/endpoints/subscriptions/list-subscriptions.md): Retrieve existing subscriptions. By default, draft, voided, and cancelled subscriptions are not included.
- [Create subscription update](https://docs.hyperline.co/api-reference/endpoints/subscriptions/create-subscription-update.md): Create an update to apply on an existing subscription.
- [Create subscription updates](https://docs.hyperline.co/api-reference/endpoints/subscriptions/create-subscription-updates.md): Create multiple updates to apply at once to an existing subscription.
- [Create subscription](https://docs.hyperline.co/api-reference/endpoints/subscriptions/create-subscription.md): Create a new subscription from a plan or manually with products.
- [Update subscription](https://docs.hyperline.co/api-reference/endpoints/subscriptions/update-subscription.md): Update configuration of a subscription including phases and products.
- [Activate subscription](https://docs.hyperline.co/api-reference/endpoints/subscriptions/activate-subscription.md): Manually start a subscription for the first time.
- [Cancel subscription](https://docs.hyperline.co/api-reference/endpoints/subscriptions/cancel-subscription.md): Cancel an existing subscription.
- [Pause subscription](https://docs.hyperline.co/api-reference/endpoints/subscriptions/pause-subscription.md): Pause a subscription. If the subscription is already paused, updates its reactivation date.
- [Reactivate subscription](https://docs.hyperline.co/api-reference/endpoints/subscriptions/reactivate-subscription.md): Reactivate a paused subscription.
- [Refresh seat products](https://docs.hyperline.co/api-reference/endpoints/subscriptions/refresh-seat-products.md): Triggers 'count' updates on connected seat products within the subscription. This action will use the dataloader query to retrieve and update the number of units for each seat product.
- [Refresh subscriptions](https://docs.hyperline.co/api-reference/endpoints/subscriptions/refresh-subscriptions.md): Triggers refresh of subscriptions usage data and related open invoices. This action is used when the automatic billing update upon ingestion option is disabled for the account.
- [Reinstate subscription](https://docs.hyperline.co/api-reference/endpoints/subscriptions/reinstate-subscription.md): Reinstate an existing subscription scheduled for cancellation.
- [Renew subscription](https://docs.hyperline.co/api-reference/endpoints/subscriptions/renew-subscription.md): This action will move the subscription into the future up to a specific date (exclusive), as if the renewals had occurred. As a result, the corresponding future invoices will be generated.
- [Simulate subscription updates](https://docs.hyperline.co/api-reference/endpoints/subscriptions/simulate-subscription-updates.md): Simulate the effect of updates on a subscription without actually applying them.
- [Get subscription phase](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-phases/get-subscription-phase.md): Retrieve the details of a phase for an existing subscription.
- [List subscription phases](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-phases/list-subscription-phases.md): Retrieve the details of the phases for an existing subscription.
- [Transition subscription to next phase](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-phases/transition-subscription-to-next-phase.md): Update a subscription and transition it to the next available phase.
- [Get subscription template](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-templates/get-subscription-template.md): Retrieve an existing subscription template with its configurations details.
- [List subscription templates](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-templates/list-subscription-templates.md): Retrieve existing subscription templates.
- [Create subscription template](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-templates/create-subscription-template.md): Create a new subscription template.
- [Create subscription template configuration](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-templates/create-subscription-template-configuration.md): Add a configuration (currency/country, phases, products, contract terms) to a subscription template.
- [Update subscription template](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-templates/update-subscription-template.md): Update the name or description of a subscription template.
- [Update subscription template configuration](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-templates/update-subscription-template-configuration.md): Replace an existing configuration for a subscription template.
- [Delete subscription template](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-templates/delete-subscription-template.md): Delete a subscription template. Fails if a quote template depends on it.
- [Delete subscription template configuration](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-templates/delete-subscription-template-configuration.md): Delete a configuration from a subscription template.
- [Get subscription transition](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-transitions/get-subscription-transition.md): Retrieve the details of an existing subscription transition.
- [List subscription transitions](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-transitions/list-subscription-transitions.md): Retrieve existing subscription transitions.
- [Create subscription transition](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-transitions/create-subscription-transition.md): Transition a subscription to another subscription, configured from a subscription, a plan or a template. If the application_schedule is `immediately`, the transition is applied right away.
- [Cancel subscription transition](https://docs.hyperline.co/api-reference/endpoints/subscriptions->-transitions/cancel-subscription-transition.md): Cancel a scheduled subscription transition.
- [Get tax rate](https://docs.hyperline.co/api-reference/endpoints/taxes/get-tax-rate.md): Retrieve an existing custom or default tax rate mapping.
- [List tax rates](https://docs.hyperline.co/api-reference/endpoints/taxes/list-tax-rates.md): Retrieve existing custom and default tax rate mappings.
- [Create tax rate](https://docs.hyperline.co/api-reference/endpoints/taxes/create-tax-rate.md): Create a custom rate or a code mapping for a default rate.
- [Update tax rate](https://docs.hyperline.co/api-reference/endpoints/taxes/update-tax-rate.md): Update an existing custom or default tax rate mapping.
- [Delete tax rate](https://docs.hyperline.co/api-reference/endpoints/taxes/delete-tax-rate.md): Delete an existing custom or default tax rate mapping.
- [List apps](https://docs.hyperline.co/api-reference/endpoints/third-party-apps/list-apps.md): Retrieve existing third-party apps.
- [Create app](https://docs.hyperline.co/api-reference/endpoints/third-party-apps/create-app.md): Create a new third-party app.
- [Update app](https://docs.hyperline.co/api-reference/endpoints/third-party-apps/update-app.md): Update an existing third-party app.
- [Delete app](https://docs.hyperline.co/api-reference/endpoints/third-party-apps/delete-app.md): Delete an existing third-party app.
- [Refund transaction](https://docs.hyperline.co/api-reference/endpoints/transactions/refund-transaction.md): Refund a settled banking transaction for its full amount. The related invoice will switch back to to pay status. Use the create credit note endpoint if you want to cancel (and optionally refund) the initial invoice.
- [Get user](https://docs.hyperline.co/api-reference/endpoints/users/get-user.md): Retrieve the details of an existing user.
- [List users](https://docs.hyperline.co/api-reference/endpoints/users/list-users.md): Retrieve existing users.
- [Get user role](https://docs.hyperline.co/api-reference/endpoints/users->-roles/get-user-role.md): Retrieve the details of an existing user role.
- [List user roles](https://docs.hyperline.co/api-reference/endpoints/users->-roles/list-user-roles.md): Retrieve existing user roles.
- [Get wallet settings](https://docs.hyperline.co/api-reference/endpoints/wallets/get-wallet-settings.md): Retrieve the global settings of the wallets.
- [Get wallet](https://docs.hyperline.co/api-reference/endpoints/wallets/get-wallet.md): Retrieve the details of an existing wallet.
- [List wallets](https://docs.hyperline.co/api-reference/endpoints/wallets/list-wallets.md): Retrieve existing wallets.
- [List wallet transactions](https://docs.hyperline.co/api-reference/endpoints/wallets/list-wallet-transactions.md): Retrieve all transactions of an existing wallet.
- [Create wallet](https://docs.hyperline.co/api-reference/endpoints/wallets/create-wallet.md): Create a new wallet.
- [Update wallet settings](https://docs.hyperline.co/api-reference/endpoints/wallets/update-wallet-settings.md): Update the global settings of the wallets.
- [Update wallet](https://docs.hyperline.co/api-reference/endpoints/wallets/update-wallet.md): Update the details of an existing wallet.
- [Load wallet](https://docs.hyperline.co/api-reference/endpoints/wallets/load-wallet.md): Load paid or free credits on an existing wallet.
- [Revert wallet load](https://docs.hyperline.co/api-reference/endpoints/wallets/revert-wallet-load.md): Revert a credit wallet transaction. Voids the related credit note/document and creates a debit transaction.
- [Get webhook endpoint](https://docs.hyperline.co/api-reference/endpoints/webhooks/get-webhook-endpoint.md): Retrieve an existing webhook endpoint.
- [List webhook endpoints](https://docs.hyperline.co/api-reference/endpoints/webhooks/list-webhook-endpoints.md): Retrieve all webhook endpoints.
- [List webhook messages](https://docs.hyperline.co/api-reference/endpoints/webhooks/list-webhook-messages.md): Retrieve all webhook messages sent.
- [Create webhook endpoint](https://docs.hyperline.co/api-reference/endpoints/webhooks/create-webhook-endpoint.md): Create a new webhook endpoint.
- [Update webhook endpoint](https://docs.hyperline.co/api-reference/endpoints/webhooks/update-webhook-endpoint.md): Update an existing webhook endpoint.
- [Delete webhook endpoint](https://docs.hyperline.co/api-reference/endpoints/webhooks/delete-webhook-endpoint.md): Delete an existing webhook endpoint.
- [Importing historical data](https://docs.hyperline.co/guides/importing-historical-data.md): Import customers, subscriptions, and invoices from another billing system into Hyperline, with API endpoints and best practices for migrations.
- [Implement Hyperline for a self-serve product](https://docs.hyperline.co/guides/implement-self-serve.md): Implement Hyperline for a self-serve SaaS product: signups, checkout, subscription lifecycle, and customer portal integration with your application.
- [Configure usage-based billing](https://docs.hyperline.co/guides/configure-usage-based-billing.md): Step-by-step guide to set up your first usage-based subscription in Hyperline — events, aggregators, products, pricing tiers, and customer assignment.
- [Set up credit-based billing for an AI platform](https://docs.hyperline.co/guides/credit-based-billing-ai.md): Implement credit-based billing for an AI platform: configure credit products, weighted consumption across multiple models, and customer top-ups.
- [Run Hyperline on autopilot](https://docs.hyperline.co/guides/autopilot.md): Use Sentinel, customer intelligence, usage tracking, notifications, exports, and AI assistants to reduce manual checks across revenue operations.
- [Getting started](https://docs.hyperline.co/guides/ai.md): Connect Claude, ChatGPT, Cursor, and other AI assistants to Hyperline using MCP, the CLI, and reusable skills for common billing workflows.
- [Create a subscription from a template with AI](https://docs.hyperline.co/guides/ai/create-subscription-from-template.md): AI skill for creating a Hyperline subscription from a subscription template while preserving the template's billing configuration.
- [Create an invoice with AI](https://docs.hyperline.co/guides/ai/create-invoice.md): AI skill for creating draft or payable Hyperline invoices through the public API with explicit line items, customer, currency, and status.
- [Create a quote from a template with AI](https://docs.hyperline.co/guides/ai/create-quote-from-template.md): AI skill for creating a Hyperline quote from a template while preserving terms, attachments, contract documents, and optional draft subscription updates.
- [Build an insights report with AI](https://docs.hyperline.co/guides/ai/build-insights-report.md): AI skill for building revenue, invoice, subscription, and usage insights reports by querying Hyperline analytics and billing data.
- [Investigate a customer balance with AI](https://docs.hyperline.co/guides/ai/investigate-customer-balance.md): AI skill for reconciling a Hyperline customer's balance across their invoices, wallet, credits, payments, and outstanding transactions.
- [Answer a billing question with AI](https://docs.hyperline.co/guides/ai/answer-billing-question.md): AI skill that answers Hyperline billing questions by combining product documentation with read-only checks against your live account data.
- [Bulk update subscriptions with AI](https://docs.hyperline.co/guides/ai/bulk-update-subscriptions.md): AI skill for planning, confirming, applying, and verifying bulk subscription updates in Hyperline without breaking customer billing.
- [Bulk update subscriptions](https://docs.hyperline.co/guides/bulk-update-subscriptions.md): Bulk update Hyperline subscriptions through the API: add products, change prices, or adjust contracts on many subscriptions in a single workflow.
- [Subscription billing cycles](https://docs.hyperline.co/guides/subscription-billing-cycles.md): Change the billing cycle alignment of a Hyperline subscription using the advanced update feature, with prorations, anchors, and timing examples.
- [Retroactive subscription update](https://docs.hyperline.co/guides/retroactive-subscription-update.md): Apply a Hyperline subscription change retroactively after the current period is already invoiced, using the advanced update flow with transition invoice.
- [Upsell and downsell a subscription](https://docs.hyperline.co/guides/upsell-downsell-subscriptions.md): Upsell or downsell a Hyperline subscription with the advanced update flow, or send a quote for subscription update that the customer signs.
- [Keyboard shortcuts](https://docs.hyperline.co/guides/keyboard-shortcuts.md): Move around Hyperline with keyboard shortcuts — search, create records, pull data from tables, and run operations without touching the mouse.
- [Integrations overview](https://docs.hyperline.co/integrations/overview.md): Browse Hyperline integrations for payment gateways, accounting systems, CRMs, tax engines, and automation platforms to connect your billing stack.
- [Stripe](https://docs.hyperline.co/integrations/stripe.md): Collect card, ACH, SEPA, and Apple Pay payments through Stripe on Hyperline with one-click connection, customer sync, and full reconciliation.
- [Mollie](https://docs.hyperline.co/integrations/mollie.md): Collect card and local payment method transactions through Mollie on Hyperline with one-click connection and automatic invoice reconciliation.
- [GoCardless](https://docs.hyperline.co/integrations/gocardless.md): Collect SEPA, BACS, and ACH direct debit payments through GoCardless on Hyperline with one-click setup, mandate management, and reconciliation.
- [Airwallex](https://docs.hyperline.co/integrations/airwallex.md): Collect card and bank transfer payments through Airwallex on Hyperline, with automatic customer sync, payment routing, and reconciliation.
- [Adyen](https://docs.hyperline.co/integrations/adyen.md): Collect card and local payments through Adyen on Hyperline with one-click connection, payment orchestration, and automatic reconciliation.
- [Salesforce](https://docs.hyperline.co/integrations/salesforce.md): Connect Salesforce with Hyperline to sync accounts, opportunities, contracts, and subscription data between your CRM and billing platform.
- [HubSpot](https://docs.hyperline.co/integrations/hubspot.md): Connect HubSpot with Hyperline to sync deals, customers, contracts, and subscription data between your CRM and your billing platform.
- [Attio](https://docs.hyperline.co/integrations/attio.md): Connect Attio CRM with Hyperline to sync customers, subscriptions, and revenue data, and surface billing details on Attio records and lists.
- [Pennylane](https://docs.hyperline.co/integrations/pennylane.md): Push invoices, credit notes, and customer data from Hyperline to Pennylane accounting for French SMBs with automatic ledger synchronization.
- [Xero](https://docs.hyperline.co/integrations/xero.md): Push invoices, credit notes, customers, and payments from Hyperline to Xero accounting with automatic product mapping and tax code synchronization.
- [QuickBooks](https://docs.hyperline.co/integrations/quickbooks.md): Push invoices, credit notes, customers, and payments from Hyperline to QuickBooks Online accounting with chart of accounts and tax mapping.
- [NetSuite](https://docs.hyperline.co/integrations/netsuite.md): Connect NetSuite to synchronize customers, invoices, credit notes, payments, refunds, chargebacks, and wallet activity from Hyperline.
- [Exact Online](https://docs.hyperline.co/integrations/exact-online.md): Push invoices, credit notes, and customers from Hyperline into Exact Online accounting for Belgian, French, German, and Dutch bookkeeping.
- [Rillet](https://docs.hyperline.co/integrations/rillet.md): Push invoices, credit notes, customers, payments, and subscription contracts from Hyperline to Rillet accounting with per-entity subsidiary mapping.
- [Zoho Books](https://docs.hyperline.co/integrations/zoho-books.md): Push invoices, credit notes, customers, and payments from Hyperline to Zoho Books accounting with automatic chart of accounts and tax mapping.
- [Anrok](https://docs.hyperline.co/integrations/anrok.md): Use Anrok as the tax engine for Hyperline: automate sales tax calculation, product mapping, and compliance for US transactions and beyond.
- [Segment](https://docs.hyperline.co/integrations/segment.md): Ingest usage events from Segment directly into Hyperline to drive usage-based billing without writing custom event-forwarding integrations.
- [Hightouch](https://docs.hyperline.co/integrations/hightouch.md): Sync customer and revenue data from Hightouch into Hyperline reverse-ETL pipelines to power billing automation and finance workflows.
- [Automate Hyperline with Zapier](https://docs.hyperline.co/integrations/zapier.md): Connect Hyperline to thousands of apps using Zapier — automate customer creation, invoice events, and subscription updates without writing code.
- [Slack](https://docs.hyperline.co/integrations/slack.md): Connect Slack to Hyperline to send automated billing notifications, alerts, and quote approval requests to your team's channels and direct messages.
- [Product updates July, 2026](https://docs.hyperline.co/changelog/2026-07.md): Hyperline July 2026 release notes: consolidated invoicing, Customer Intelligence integrations, feature entitlements, Slack quote approvals, and PostHog.
- [Product updates June, 2026](https://docs.hyperline.co/changelog/2026-06.md): Hyperline June 2026 release: customer intelligence, new customer details page, formula-based aggregators, duplicate quotes, saved views, API logs.
- [Product updates May, 2026](https://docs.hyperline.co/changelog/2026-05.md): Hyperline May 2026 release: Sentinel monitoring, Rillet and NetSuite integrations, portal self-service, invoice custom properties, Insights GA, payouts.
- [Product updates April, 2026](https://docs.hyperline.co/changelog/2026-04.md): Hyperline April 2026 release: customer segments, Adyen integration, file summary, minimum invoice fees, multiple checkout payment methods, valuation APIs.
- [Product updates March, 2026](https://docs.hyperline.co/changelog/2026-03.md): Hyperline March 2026 release: Slack notifications, Hyperline CLI, French localization, aggregators catalog, multi-aggregator credits, Zoho Books, idempotency.
- [Product updates February, 2026](https://docs.hyperline.co/changelog/2026-02.md): Hyperline February 2026 release: MCP server, revamped quote-based subscription updates, custom invoice notes, audit log tracking, Insights improvements.
- [Product updates January, 2026](https://docs.hyperline.co/changelog/2026-01.md): Hyperline January 2026 release: customer portal authentication, quote approval workflows, expired quote filters, user merge, payment initiation delay.
- [Product updates December, 2025](https://docs.hyperline.co/changelog/2025-12.md): Hyperline December 2025 release: scheduled subscription updates, US bank reconciliation, dark mode, wallet auto-load, Insights export, outstanding pay.
- [Product updates November, 2025](https://docs.hyperline.co/changelog/2025-11.md): Hyperline November 2025 release: Insights analytics, Attio integration, bank statement reconciliation, quote countersigners, exports API, custom ARR.
- [Product updates October, 2025](https://docs.hyperline.co/changelog/2025-10.md): Hyperline October 2025 release: transactions page, subscription versions, accounting observability, edit current phase, e-invoicing Spain and Belgium.
- [Product updates September, 2025](https://docs.hyperline.co/changelog/2025-09.md): Hyperline September 2025 release: subscription templates, credit auto top-up, relative coupon durations, uncollectible invoices, non-recurring subs.
- [Product updates August, 2025](https://docs.hyperline.co/changelog/2025-08.md): Hyperline August 2025 release: edit subscription phases, prefill quantities, preview invoices and quotes, ChartMogul integration, scheduled changes.
- [Product updates July, 2025](https://docs.hyperline.co/changelog/2025-07.md): Hyperline July 2025 release: Apple Pay and Google Pay, expanded filters, customer files API, custom quote file names, external payment method imports.
- [Product updates June, 2025](https://docs.hyperline.co/changelog/2025-06.md): Hyperline June 2025 release: multi-factor authentication, update subscription phases, cancellation reasons, bundle pricing, ChorusPro auto-transmission.

## OpenAPI Specs

- [openapi](https://docs.hyperline.co/openapi)
- [openapi-main](https://docs.hyperline.co/api-reference/openapi-main.json)
- [openapi-ingest](https://docs.hyperline.co/api-reference/openapi-ingest.json)