Hyperline

Docs

• Hyperline CLI: An agent-first CLI to interact with your Hyperline account from the terminal
• Hyperline MCP: Connect AI assistants to your Hyperline account using the Model Context Protocol
• Build with LLMs: Use Hyperline documentation and APIs with AI assistants and LLMs
• Currency amounts: Technical representation of monetary values in Hyperline
• Authentication: Learn how to authenticate to use Hyperline's API
• Dates & timezones: Technical representation of dates in Hyperline
• Error handling: Learn how to handle errors when using Hyperline's API
• Getting started: Welcome to the Hyperline technical documentation
• Idempotent requests: Use idempotency keys to safely retry API requests without duplicating operations
• Pagination and filtering
• Rate limiting
• React components: Learn how to embed Hyperline directly into your React application
• Third-party app: Enable your app to access Hyperline accounts using OAuth flows
• API upgrades: Keep track of changes and deprecation to the Hyperline API
• Webhooks: Receive webhook messages
• Create accounting rule: Create a new accounting rule for account code routing or journal posting.
• Delete accounting rule: Soft-delete an accounting rule.
• Get accounting rule: Retrieve a single accounting rule by its identifier.
• List accounting rules: Retrieve existing accounting rules with optional filtering.
• Resolve accounting rule: Preview which account codes would be resolved for a given context.
• Update accounting rule: Update an existing accounting rule.
• Get aggregator usage: Retrieve a usage row for an aggregator (name, unit and thresholds).
• Get aggregator usage events: List raw billable events for an aggregator across every customer of the client.
• Get aggregator usage grouped by customer: Per-customer total usage for an aggregator over a period, ordered by total DESC, paginated.
• Get aggregator usage timeseries: Get client-wide usage for an aggregator bucketed by month, day or hour.
• Create aggregator: Create a new aggregator.
• Delete aggregator: Delete an existing aggregator.
• Get aggregator: Retrieve the details of an existing aggregator.
• List aggregators: Retrieve existing aggregators.
• Update aggregator: Update the details of an existing aggregator.
• Get analytics: Retrieve your pre-computed account's analytics (ARR, revenues, churn, etc).
• List audit logs: Retrieve existing audit logs. Sorted by happened_at descending.
• Get bank account: Retrieve a specific bank account by ID.
• List bank accounts: Retrieve existing bank accounts.
• Delete billable events: Delete existing billable events.
• Get billable event prices: Get previous price simulation results for a billable event. You can search by either calculation_id / record_id or both.
• Get events: Retrieve billable events filtered by event type.
• Ingest billable event: 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: 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: Simulate prices for a single billable event without ingesting it.
• Create company: Create a new company to which the authentication token will have access to.
• List companies: Retrieve all companies that the authentication token has access to.
• Create promotion code: Create a new promotion code.
• Delete promotion code: Delete an existing promotion code.
• Get promotion code: Retrieve the details of an existing promotion code.
• List promotion codes: Retrieve existing promotion codes.
• Update promotion code: Update the details of an existing promotion code.
• Create coupon: Create a new coupon.
• Delete coupon: Delete an existing coupon.
• Get coupon: Retrieve the details of an existing coupon.
• List coupons: Retrieve existing coupons.
• Update coupon: Update the details of an existing coupon.
• Create custom property: Create a new custom property.
• Delete custom property: Delete an existing custom property.
• List custom properties: Retrieve all custom properties previously created.
• Update custom property: Update an existing custom property.
• Create credit product: Create a credit entity for a given product with an optional balance.
• Create credits usage: Create a usage entry for a credit product. This will impact the balance of the customer by usage_retained.
• Get credit product: Retrieve the details of an existing credit product for a customer.
• List all credit products: Retrieve credit products for all customers.
• List credit products: Retrieve credit products attached to a customer.
• List credit transactions: Retrieve all credit transactions associated with a credit product.
• Purchase credits: Purchase a number of credits. This action will generate an invoice and charge the customer.
• Topup credits: Topup a number of free credits. This action will not charge the customer.
• Update credit product: Update the configuration of a customer's credit product.
• Update credit topup expiration: Update the expiration date of a topup credit transaction. Only non-expired topup transactions can be updated.
• Delete customer entitlement: Delete an entitlement override from a customer.
• Resolve customer entitlements: Resolve entitlement values for a customer.
• Set customer entitlement: Set an entitlement override for a customer.
• Create payment method: Import an existing customer payment method from a connected payment provider.
• Delete payment method: Delete an existing customer payment method.
• Get payment method: Retrieve the details of an existing customer payment method.
• List payment methods: Retrieve payment methods attached to a customer.
• Create segment: Create a new customer segment.
• Delete segment: Delete an existing customer segment.
• Get segment: Retrieve the details of an existing customer segment.
• List segments: Retrieve all customer segments.
• Update segment: Update an existing customer segment.
• Get customer usage events: List raw billable events for a customer and a specific aggregator over a period.
• Get customer usage for an aggregator: Get the usage of a customer for a specific aggregator over a period.
• Get customer usage timeseries: Get the usage of a customer for an aggregator bucketed by month, day or hour.
• List customer usage: 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.
• Archive customer: Archive an existing customer.
• Bulk update providers/customers mapping: Bulk update providers/customers mapping, make sure to check the query response to see if all customers were updated.
• Create customer: Create a new customer.
• Create customers batch: Create a batch of new customers.
• Delete customer: Delete an existing customer. The customer must be archived prior to the deletion.
• Get customer: Retrieve the details of an existing customer.
• Get customer: We recommend using the GET /v2/customers/{id} endpoint instead.
• Get customer portal: Retrieve the URL of the customer portal.
• Get customer tax rates: Retrieve the eligible tax rates for a customer.
• Get customer valuation: Compute aggregated valuation metrics across all active subscriptions for a customer.
• List customers: We recommend using the GET /v2/customers endpoint instead.
• List customers: Retrieve existing customers.
• Unarchive customer: Unarchive an archived customer.
• Update customer: Update the details of an existing customer.
• Create export: 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.
• Download export: 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.
• Get export: Retrieve the details of an existing export.
• List exports: List previously created exports, most recent first.
• Archive feature: Archive an entitlement feature.
• Create feature: Create an entitlement feature.
• Get feature: Retrieve an entitlement feature.
• List features: List entitlement features.
• Unarchive feature: Unarchive an entitlement feature.
• Update feature: Update an entitlement feature.
• Create file: Create a new file.
• Delete file: Delete an existing file.
• Download file: Download an existing file content.
• List files: Retrieve existing files.
• Create component token: Create a new token for embedded components.
• List invoice events: 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: Create a transaction linked to an existing invoice. This may update the invoice status to paid/partially paid.
• Delete transaction: Delete a transaction linked to an existing invoice. Only applies to scheduled transaction.
• Charge invoice: Manually trigger the payment of the invoice.
• Create credit note: Create a credit note for an existing invoice.
• Create invoice: Create a new invoice.
• Create invoices: Create invoices async in batch. Results can be tracked via webhooks with the invoice.batch.creation_succeeded and invoice.batch.creation_failed events.
• Delete invoice: 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.
• Download invoice: Download the PDF of an existing invoice. If the invoice is in draft or open status, the PDF will be generated without redirect
• Get invoice: We recommend using the GET /v2/invoices/{id} endpoint instead.
• Get invoice: Retrieve the details of an existing invoice.
• List invoices: We recommend using the GET /v2/invoices endpoint instead.
• List invoices: Retrieve existing invoices. By default, invoices with status open are not included.
• Mark as uncollectible: Mark an invoice as uncollectible, useful for keeping track of bad debts that can be written off for accounting purposes.
• Update invoice: Update an invoice in draft or grace_period status.
• Upload PDF to invoice: Upload a PDF file to an existing invoice.
• Validate draft invoice: Send a draft invoice for payment, set the status to to_pay and its number. This is not reversible.
• Void invoice: Void an invoice in a to_pay status. This action generates a corresponding credit note.
• Create invoicing entity: Create a new invoicing entity to send invoices from.
• Delete invoicing entity: Soft deletes an invoicing entity. This action won't delete the associated invoices.
• Get invoicing entity: Retrieve a specific invoicing entity.
• List invoicing entities: Retrieve existing invoicing entities.
• Update invoicing entity: Update an existing invoicing entity.
• Authorize: Initiates OAuth authorization flow.
• Generate tokens: Exchange authorization code for access token or refresh an existing token.
• Get user info: Returns user information for the authenticated access token.
• OAuth callback: Handles authorization callback and redirects to client's registered URI.
• Register OAuth client: Register a dynamic OAuth client per RFC 7591.
• Revoke token: Revoke an access or refresh token.
• Get organisation: Retrieve the details of an existing organisation.
• Patch organisation: Update the details of an existing organisation.
• Create payment: Initiate a new payment (limited to one-time): generate an invoice and charge it directly or with a checkout session
• Add products to price book: Add products to a price book by copying their default price configurations.
• Create price book: Create a new price book.
• Delete price book: Delete an existing price book.
• Get price book: Retrieve the details of an existing price book.
• List price books: Retrieve existing price books.
• Remove product from price book: Remove a product and its price configurations from a price book.
• Update price book: Update the details of an existing price book.
• Create price configuration: Create a new price configuration on an existing product.
• Delete price configuration: Delete an existing price configuration.
• List price configurations: Retrieve existing price configurations.
• Update prices: Update prices of an existing price configuration.
• Delete product entitlement: Delete an entitlement value from a product.
• List product entitlements: List entitlement values assigned to a product.
• Set product entitlement: Set an entitlement value for a product.
• Archive product: Archive an existing product.
• Create product: Create a new product.
• Get product: 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: Retrieve existing products.
• Unarchive product: Unarchive an archived product.
• Update product: Update the details of an existing product.
• Approve quote: Approve an existing quote (acting as the account owner).
• Create quote: Create a new quote.
• Download quote: Download an existing quote.
• Download quote file: Download a file (attachment or manually signed file) attached to an existing quote.
• Get quote: Retrieve the details of an existing quote.
• Get quote valuation: Compute valuation metrics for an existing quote.
• List quotes: Retrieve existing quotes.
• Send quote: Send an existing quote by email for signature.
• Sign quote: Manually mark the quote as signed externally. Built-in Hyperline signature flow won't be used.
• Update quote: Update an existing quote.
• Void quote: Void an existing quote.
• Get subscription phase: Retrieve the details of a phase for an existing subscription.
• List subscription phases: Retrieve the details of the phases for an existing subscription.
• Transition subscription to next phase: Update a subscription and transition it to the next available phase.
• Create subscription template: Create a new subscription template.
• Create subscription template configuration: Add a configuration (currency/country, phases, products, contract terms) to a subscription template.
• Delete subscription template: Delete a subscription template. Fails if a quote template depends on it.
• Delete subscription template configuration: Delete a configuration from a subscription template.
• Get subscription template: Retrieve an existing subscription template with its configurations details.
• List subscription templates: Retrieve existing subscription templates.
• Update subscription template: Update the name or description of a subscription template.
• Update subscription template configuration: Replace an existing configuration for a subscription template.
• Cancel subscription transition: Cancel a scheduled subscription transition.
• Create subscription transition: 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.
• Get subscription transition: Retrieve the details of an existing subscription transition.
• List subscription transitions: Retrieve existing subscription transitions.
• Activate subscription: Manually start a subscription for the first time.
• Cancel subscription: Cancel an existing subscription.
• Create subscription: Create a new subscription from a plan or manually with products.
• Create subscription update: Create an update to apply on an existing subscription.
• Create subscription updates: Create multiple updates to apply at once to an existing subscription.
• Get subscription: Retrieve the details of an existing subscription.
• Get subscription valuation: Compute valuation metrics for an existing subscription.
• List subscriptions: Retrieve existing subscriptions. By default, draft, voided, and cancelled subscriptions are not included.
• Pause subscription: Pause a subscription.
• Reactivate subscription: Reactivate a paused subscription.
• Refresh seat products: 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: 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: Reinstate an existing subscription scheduled for cancellation.
• Renew subscription: 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: Simulate the effect of updates on a subscription without actually applying them.
• Update subscription: Update configuration of a subscription including phases and products.
• Get tax rate: Retrieve the details of an existing custom tax rate.
• List tax rates: Retrieve existing custom tax rates.
• Create app: Create a new third-party app.
• Delete app: Delete an existing third-party app.
• List apps: Retrieve existing third-party apps.
• Update app: Update an existing third-party app.
• Refund transaction: 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 role: Retrieve the details of an existing user role.
• List user roles: Retrieve existing user roles.
• Get user: Retrieve the details of an existing user.
• List users: Retrieve existing users.
• Create wallet: Create a new wallet.
• Get wallet: Retrieve the details of an existing wallet.
• Get wallet settings: Retrieve the global settings of the wallets.
• List wallet transactions: Retrieve all transactions of an existing wallet.
• List wallets: Retrieve existing wallets.
• Load wallet: Load credits on an existing wallet. The related customer must have an active payment method.
• Revert wallet load: Revert a credit wallet transaction. Voids the related credit note/document and creates a debit transaction.
• Update wallet: Update the details of an existing wallet.
• Update wallet settings: Update the global settings of the wallets.
• Create webhook endpoint: Create a new webhook endpoint.
• Delete webhook endpoint: Delete an existing webhook endpoint.
• Get webhook endpoint: Retrieve an existing webhook endpoint.
• List webhook endpoints: Retrieve all webhook endpoints.
• List webhook messages: Retrieve all webhook messages sent.
• Update webhook endpoint: Update an existing webhook endpoint.
• Product updates June, 2025
• Product updates July, 2025
• Product updates August, 2025
• Product updates September, 2025
• Product updates October, 2025
• Product updates November, 2025
• Product updates December, 2025
• Product updates January, 2026
• Product updates February, 2026
• Product updates March, 2026
• Product updates April, 2026
• Product updates May, 2026
• Chart of accounts: Manage the general ledger accounts used in your Hyperline accounting ledger
• Journal entries: Browse journal entry lines and drill into the details of each entry
• Ledgers: Create and manage accounting ledgers in Hyperline
• Overview: Understand how Hyperline automates general ledger accounting, journal entries, and revenue recognition
• Revenue recognition: Automate deferred revenue and recognition schedules with Hyperline's revenue recognition engine
• Accounting rules: Configure the rules that determine which GL accounts are debited and credited for each billing event
• Automated exports: Sync Hyperline reports and invoice exports to your database
• Dashboard
• Insights: Learn about the financial insights available in Hyperline
• Reports: Learn about pre-built reports available in Hyperline
• Coupons: Create reusable discounts and apply them to subscriptions, invoices, and checkout flows
• Promotion codes: Let customers redeem coupon discounts from checkout pages
• Set-up credits on your account: Learn how to set-up customer credit ledgers
• Customer exports: Learn how to export your customers
• Organisation-based billing: Learn how to bill customers together
• Customers: Manage the individuals and companies you bill
• Public customer portal: Learn about the hosted customer portal page
• Customer segments: Group customers dynamically using rule-based filters
• Features and entitlements: Learn how to entitle customers with catalog features, product grants, and customer overrides
• Configure your account
• Supported currencies: Learn about supported currencies and different types
• Email settings: Learn about your account email settings
• Invoicing entities: Manage all your companies and subsidiaries within same Hyperline account
• Markdown format text: Stylize your text to your liking in selected text areas
• Multiple accounts: Manage multiple companies on Hyperline
• Testing mode: Learn how you can experiment with billing safely before going to production
• Users & permissions: Invite team members and set permissions to collaborate on Hyperline
• Home
• Glossary: Learn more about Hyperline's key concepts and their definitions
• Why building your billing system in-house is not a good idea
• Invoice configuration: Learn how to configure your invoices
• Custom documents: How to customize your custom documents
• Chorus Pro: Learn about automatic invoice transmission via Chorus Pro in France
• Overview: Learn about electronic invoicing compliance in Hyperline
• Peppol: Learn about automatic invoice transmission via Peppol in Belgium
• Invoice emails: Overview about customer email notifications for invoices
• Invoice exports: Learn how to export your invoices
• Public invoice page: Easily share a dedicated invoice page with your customers
• Manage invoices: Create, edit, and duplicate invoices manually
• Overview: Overview of the invoice concept
• Reconciliation: Learn how invoice reconciliation works in Hyperline
• Credit notes & refunds: Learn how to issue credit notes and handle refund money movement
• Invoice reminders & dunning: Learn how to automate your payment reminders and dunning process
• Tax management: Taxes computation can drive a lot of complexity into your invoicing process. Luckily, Hyperline can manage this for you, at no extra cost.
• Invoice payment term: Learn about invoices payment term settings
• Payment orchestration: Learn how Hyperline orchestrates payment providers
• Handling payment errors: Learn how to handle invoice payment errors
• Payment methods: Learn about supported payment methods
• Payout reconciliation: Review payment provider payouts from connected bank accounts
• Scheduled transactions: Plan one or several future transactions on invoices
• Price books: Learn about extending your product catalog with price books and fine-grained pricing attribution
• Usage-based options: Learn about metering in Hyperline
• Products and prices: Learn about product types and pricing in Hyperline
• Custom properties: Learn how to adapt Hyperline to your extra needs using custom properties
• Quote approval: Learn about the Hyperline quote approval process
• Quote for one-off invoice: Create a quote for a non recurring payment
• Create and send quotes: Streamline your CPQ process with Hyperline
• Quote signature: Learn about Hyperline quote signature process
• Hyperline CPQ ↔ Stripe Billing: Learn how to integrate Hyperline CPQ with your existing Stripe Billing setup
• Quote for subscription update: Create a quote to update an existing subscription
• Quote templates: Streamline your quoting process
• Overview: Monitor your billing operations with Sentinel, Hyperline's real-time alerting system
• Checkout page: Hosted payment page that lets your customers subscribe and complete purchases securely
• Automated seat-based billing: Track seats, licenses, users, or any other quantity in real time as part of your subscriptions
• Contract duration: Add a contract duration to your subscription
• Subscription basic setup: Assign subscriptions to customers in Hyperline
• Subscription exports: Learn how to export your subscriptions
• Manage a subscription: Manage a subscription lifecycle, pause or cancel it
• How do subscriptions work?: Overview of the subscription concept
• Subscription phases: Create subscriptions with planned ramp-ups
• Subscription templates: Streamline your subscription assignment process
• Translations: Store custom product names and descriptions per subscription for multilingual customers
• Update subscription: Make changes to a subscription configuration, products, and phases
• Aggregators: Configure aggregators to transform raw events into billable metrics
• Connect with BigQuery: Pull data automatically from your BigQuery project
• Customer usage: Monitor real-time aggregator usage per customer with charts, filters, and event exploration
• Explore your data usage: Exploring your data usage to understand how your customers are consuming your products
• Getting Started: Configure your first usage-based subscription
• Global usage: Monitor aggregated usage across all customers and identify top consumers per aggregator
• Import events with a CSV file
• Connect with MongoDB: Pull data automatically from your MongoDB database
• Send usage data: Learn how to send usage data in Hyperline
• Simulate usage data: Simulate usage data without code for testing purposes
• Connect with Snowflake: Pull data automatically from your Snowflake warehouse
• Pull usage data with connectors: No-code usage based with Hyperline connectors and automatic data pulling
• Manage wallet balances: Learn about top-ups, debits, and balances
• Overview: Learn about invoice prepayment with Hyperline wallets
• Bulk update subscriptions: Learn how to add products or make changes to multiple subscriptions at once using the API
• Configure usage-based billing: Step-by-step guide to set up your first usage-based subscription
• Set up credit-based billing for an AI platform: Step-by-step guide to implement a credit system with weighted consumption across multiple AI models
• Implement Hyperline for a self-serve product
• Importing historical data: Import customers, subscriptions, and invoices from another billing system
• Keyboard shortcuts: Move around Hyperline, search anything, create records, and pull data out of tables without touching the mouse
• Subscription billing cycles: Learn how to change the billing cycle alignment of a subscription using the advanced update feature
• Adyen: Learn how to collect payments through Adyen on Hyperline
• Airwallex: Learn how to collect payments through Airwallex on Hyperline
• Anrok: Learn how to use Anrok as tax engine on Hyperline
• Attio: Learn how to connect Attio with Hyperline
• Exact Online: Learn how to push your invoicing data in your accounting tool
• GoCardless: Learn how to collect payments through GoCardless on Hyperline
• Hightouch: Learn how to sync data from Hightouch
• HubSpot: Learn how to connect HubSpot with Hyperline
• Mollie: Learn how to collect payments through Mollie on Hyperline
• NetSuite: Learn how to push your invoicing data in your accounting tool
• Integrations overview: Learn how Hyperline integrates with your tools stack
• Pennylane: Learn how to push your invoicing data in your accounting tool
• QuickBooks: Learn how to push your invoicing data in your accounting tool
• Rillet: Learn how to push your invoicing data in your accounting tool
• Salesforce: Learn how to connect Salesforce with Hyperline
• Segment: Learn how to ingest events from Segment
• Slack: Learn how to send automated messages to Slack
• Stripe: Learn how to collect payments through Stripe on Hyperline
• Xero: Learn how to push your invoicing data in your accounting tool
• Automate using Zapier: Overview about Zapier no-code integration
• Zoho Books: Learn how to push your invoicing data in your accounting tool

OpenAPI Specs

• openapi
• openapi-main
• openapi-ingest