a[href*="mintlify.com"] {
  display: none;
  visibility: hidden;
}

.text-2xl {
  font-weight: 600;
}

.tag-blue {
  height: 20px;
  line-height: 20px;
  display: inline-block;
  background: #93c5fd;
  margin: 0;
  padding: 0 6px;
  border-radius: 4px;
  color: #0166ff;
  border: 1px solid #0166ff;
  font-weight: 600;
  font-size: 12px;
}

.tag-orange {
  height: 20px;
  line-height: 20px;
  display: inline-block;
  background: #fef9e0;
  margin: 0;
  padding: 0 6px;
  border-radius: 4px;
  color: #da9e09;
  border: 1px solid #da9e09;
  font-weight: 600;
  font-size: 12px;
}

Download invoice

Hyperline

Hyperline is the most flexible billing platform for B2B SaaS businesses.

Welcome to Hyperline

Welcome to Hyperline!

Build vs. Buy

Why building your billing system in-house is not a good idea

Billing can get **quite complex**. Learn more about Hyperline's key concepts and what they mean in the context of the platform.

Glossary

Configure your account

Learn how you can experiment with billing safely before going to production

Testing mode

Multiple accounts

Learn about supported currencies and different types

Supported currencies

Invite team members and set permissions to collaborate on Hyperline

Users & permissions

Email settings

Create customer

Learn about the hosted customer portal page

Customer portal

Public customer portal

Org. based billing

Organisation-based billing

Exports

Customer exports

Learn about product types and pricing in Hyperline

Products catalog

Create plans to assign subscriptions seamlessly

Manage plans

Learn about extending your product catalog with price books and fine-grained pricing attribution

Price books

How do subscriptions work?

Manage a subscription lifecycle, pause or cancel it

Manage a subscription

Update aspects of a subscription, such as products, quantities, and coupons.

Update a subscription

Create subscriptions with planned ramp-ups

Subscription phases

Add a contract duration to your subscription

Contract duration

Learn about the hosted checkout page to let your customers subscribe

Checkout page

Public checkout page

Subscription exports

Streamline your CPQ process with Hyperline

Overview

Quotes

Learn about Hyperline quote signature process

Signature

Quote signature

Templates

Quote templates

Learn how you can add contracts to your quotes from templates

Contracts

Add contracts to quotes

Invoice configuration

Create invoice manually

Learn how to edit an existing invoice before being sent for payment

Edit invoice

Learn how to duplicate an existing invoice and edit it

Duplicate invoice

How to issue credit notes and refund a paid invoice

Credit notes & refunds

Custom documents

Taxes computation can drive a lot of complexity into your invoicing process. Luckily, Hyperline can manage this for you, at no extra cost.

Tax management

Learn how to automate your payment reminders and dunning process

Reminders & dunning

Invoice reminders & dunning

Learn about electronic invoicing compliance in Hyperline

E-invoicing

Learn about invoices payment term settings

Payment term

Invoice payment term

Invoice exports

Overview about customer email notifications for invoices

Emails

Invoice emails

Easily share a dedicated invoice page with your customers

Public page

Public invoice page

Learn how Hyperline orchestrates payment providers

Orchestration

Payment orchestration

Payment methods

Transactions and reconciliation

Handling payment errors

Create & apply coupons

Dashboard

Reports

Learn how to set-up customer credit ledgers

Set-up credits on your account

Learn how to adapt Hyperline to your extra needs using custom properties

Custom properties

Learn about invoice prepayment with Hyperline wallets

Manage wallet balances

Configure your first usage-based subscription

Import events with a CSV file

Send your usage data

Exploring your data usage to understand how your customers are consuming your products

Explore your data usage

Welcome to the Hyperline technical documentation

Getting started

Learn how to authenticate to use Hyperline's API

Authentication

Pagination and filtering

Rate limiting

Technical representation of monetary values in Hyperline

Currency amounts

Keep track of changes and deprecation to the Hyperline API

API upgrades

Learn how to embed Hyperline directly into your React application

React components

Enable your app to access Hyperline accounts using OAuth flows

Third-party app

Webhooks

Retrieve your pre-computed account's analytics (ARR, revenues, churn, etc).

Get analytics

Create billable event

Create several billable events in batch (limited to max 5000 events per request).

Create billable events

Get previous calculation results for a billable event. You can search by either calculation_id / record_id or both.

Query billable event prices

Ingest and calculate prices for a single billable event. After the first ingestion, events are not ingested again and the prices won't be calculated again. The initially calculated prices will be returned in subsequent calls.

Ingest and calculate billable event prices

Simulate prices for a single billable event without ingesting it.

Simulate billable event prices

Retrieve all companies that the authentication token has access to.

Get companies

Create a new company to which the authentication token will have access to.

Create company

Get coupons

Retrieve the details of an existing coupon.

Get coupon

Create coupon

Update the details of an existing coupon.

Update coupon

Delete coupon

Retrieve all custom properties previously created.

Get custom properties

Create custom property

Update custom property

Delete custom property

Get customers

Retrieve the details of an existing customer.

Get customer

Get customer portal

Retrieve the eligible tax rates for a customer.

Get customer tax rates

Update the details of an existing customer.

Update customer

Delete an existing customer. The customer must be archived prior to the deletion.

Delete customer

Archive customer

Bulk update providers/customers mapping, make sure to check the query response to see if all customers were updated.

Bulk update providers/customers mapping

Unarchive customer

Retrieve the details of an existing credit product for a customer.

Get credit product

List all credits products attached to a customer.

List credit products

Retrieve all credit transactions associated with a credit product for a specific customer.

List credit transactions

Create a credit entity for a given product with an optional balance for a customer.

Create credit product

Create a usage entry for a credit product. This will impact the balance of the customer by `usage_retained`.

Create credits usage

Purchase a number of credits. This action will generate an invoice and charge the customer. Can take a few seconds to complete.

Purchase credits

Topup a number of free credits. This action will not charge the customer.

Topup credits

Retrieve the details of an existing customer payment method.

Get payment method

List all payment methods attached to a customer.

List payment methods

Delete an existing customer payment method.

Delete payment method

Create a new token for embedded components.

Create component token

Retrieve all existing invoices. By default, invoices with status `open` are not included.

Get invoices

Retrieve the details of an existing invoice.

Get invoice

Create invoice

Create new invoices in batch (max 50 items).

Create invoices

Manually create a transaction linked to an existing invoice to mark it as paid/partially paid

Create transaction

Update an invoice in draft or grace_period status.

Update invoice

Delete an invoice in `draft` status. For other statuses, the `POST /v1/invoices/{id}/void` endpoint must be used.

Delete invoice

Upload a PDF file to an existing invoice.

Upload PDF to invoice

Send a draft invoice for payment, set the status to `to_pay` and its number. This is not reversible.

Validate draft invoice

Void an invoice in a `to_pay` status. This action generates a corresponding credit note.

Void invoice

Retrieve all invoicing entities for your current client.

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Integrations

Invoices

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Taxes

Third-party apps

Wallets

Webhooks

Download invoice

Path Parameters

Query Parameters

Response