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

Retrieve all companies that the authentication token has access to.

Get companies

Two-letter country code in ISO format. See [ISO 3166 Alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

bearer

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 customers

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 make it easier to assign subscriptions

Manage plans

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

Price books

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

Manage a subscription

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

Update a subscription

Learn about the hosted checkout page to let your customers subscribe

Checkout page

Public checkout page

Subscription exports

Overview

Quotes

Learn about Hyperline quote signature process

Signature

Quote signature

Templates

Quote templates

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

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

Xero

Exact Online

September

Product updates September, 2024

August

Product updates August, 2024

July

Product updates July, 2024

June

Product updates June, 2024

Product updates May, 2024

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

Product updates August, 2023

Product updates July, 2023

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

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

Ingest and calculate prices for a single billable event. This endpoint is in beta, please contact us if you want to know more.

Ingest and calculate billable event prices

Simulate prices for a single billable event. This endpoint is in beta, please contact us if you want to know more.

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

Get companies

Authorizations

Response