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;
}

API Reference

Integrations

Changelog

Blog

Hyperline

Get Started

Book a call

Support

Download invoice

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 to collaborate on Hyperline

Users & permissions

Email settings

Create customers

Learn about the hosted customer portal page

Customer portal

Exports

Customer exports

Learn about product types and pricing in Hyperline

Products catalog

Create plans to make it easier to assign subscriptions

Manage plans

How do subscriptions work?

Assign subscriptions to customers in Hyperline

Basic setup

Subscription basic setup

Metering options

We're improving our seat-based products by integrating metering capabilities.

Automated seat-based billing

Manage a subscription lifecycle, pause or cancel it or edit its configuration.

Manage a subscription

Hosted checkout

Subscription exports

Overview

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 refund a paid invoice and issue credit notes

Refunds & credit notes

VAT can drive a lot of complexity into your invoicing process, especially if you're based in the EU. Luckily, Hyperline can manage this for you, at no extra cost.

VAT management

Learn about electronic invoicing compliance in Hyperline

E-invoicing

Overview about customer email notifications for invoices

Invoice emails

Learn how to automate your payment reminders and dunning process

Reminders

Invoice reminders

Learn about invoices payment delay settings

Payment delay

Invoice payment delay

Invoice exports

Payment methods

Transactions and reconciliation

Handling payment errors

Create & apply coupons

Dashboard

Reports

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

Custom properties

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

No-code usage based with Hyperline connectors and automatic data pulling

Pull usage data with connectors

Pull data automatically from your BigQuery project

Connect with BigQuery

Pull data automatically from your MongoDB database

Connect with MongoDB

Pull data automatically from your Snowflake warehouse

Connect with Snowflake

Learn how Hyperline integrates with your tools stack

Integrations overview

Learn how to collect payments through Stripe on Hyperline

Stripe

Learn how to collect payments through Mollie on Hyperline

Mollie

Learn how to collect payments through GoCardless on Hyperline

GoCardless

Segment

Hightouch

Overview about Zapier no-code integration

Zapier

Automate using Zapier

Learn how to send automated messages to Slack

Slack

Learn how to connect Salesforce with Hyperline

Salesforce

Learn how to benefit from Hyperline UIs right into your CRM

Embedded flows

Salesforce component

Learn how to connect HubSpot with Hyperline

HubSpot

HubSpot component

Learn how to push your invoicing data in your accounting tool

Pennylane

April

Product updates April, 2024

March

Product updates March, 2024

February

Product updates February, 2024

January

Product updates January, 2024

December

Product updates December, 2023

November

Product updates November, 2023

October

Product updates October, 2023

August

Product updates August, 2023

July

Product updates July, 2023

June

Product updates June, 2023

Product updates May, 2023

Welcome to the Hyperline technical documentation 🤖

Getting started

Learn how to authenticate to use Hyperline's API

Authentication

Pagination and filtering

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

Retrieve all companies that the authentication token has access to.

Get companies

Get coupons

Create coupon

Retrieve the details of an existing coupon.

Get 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

Create customer

Retrieve the details of an existing customer.

Get customer

Update the details of an existing customer.

Update customer

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

Delete customer

Get customer portal

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

List all credits products attached to a customer.

List credit products

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

Create credit product

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

Get credit product

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

List credit transactions

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

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

Create credits usage

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

Create one-off invoice

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

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Integrations

Invoices

Invoicing entities

OAuth2

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Third-party apps

Wallets

Webhooks

Download invoice

Path Parameters

Query Parameters

Response