In Hyperline, the subscription model is the link between products (or a plan) and a customer.

The subscriptions can be created via the customer page on the product by an Hyperline user, or orchestrated via the technical API.

Subscriptions lifecycle

A customer can have one or multiple subscriptions at the same time. These subscriptions can be active (running), scheduled to start in the future, or scheduled to be automatically cancelled. This makes it easy to plan any changes or bill products with a different payment schedule and renewal logic.

Hyperline provides the flexibility to specify a commitment subscription period, which may differ from the billing interval of the product it encompasses. Furthermore, the billing intervals can also vary between different products.

Example đź’ˇ

This high level of flexibility enables you to depict intricate scenarios, such as a situation where a customer subscribes annually (annual commitment) but pays for a product based on monthly usage, along with an add-on with a fixed price paid on a quarterly basis.

When a subscription is created, its status is pending. You can choose how the subscription will be activated:

  • when a new customer completes the checkout flow
  • automatically at the scheduled start date
  • manually in the interface or with the API

Once a subscription is active, it will show a live green tag on your customer’s page.

A subscription will automatically be invoiced following the schedule described below once it’s active.

If you need to pause invoicing, you can pause the subscription directly in the interface using the “Pause payment collection” option.

For more details on how to manage your subscriptions please see this page.

Subscription status

Here is a description of each subscription status:

  • pending The subscription has been created and won’t be charged until it is activated using one of the options described above.
  • active The subscription is running and will be invoiced at the next payment date.
  • cancelled The subscription has been canceled from an active state.
  • voided The subscription has been voided directly from the pending state.
  • paused The subscription’s payment collection is paused.
  • errored We attempted 4 times (3 retries) and failed to charge a subscription’s invoice, see Handling payment errors. Here, we consider the subscription as inactive (as the customer failed to pay you) meaning that we won’t invoice the customer in the future nor collect payment. You can choose to reactivate it manually.

When is a subscription billed?

Hyperline lets you decide when to bill each product independently, either at the start or the end of the billing period. Usage-based product will always be billed at the end of the period, depending on the consumption.

Example đź’ˇ

This level of flexibility enables you to represent scenarios such as:

  • A yearly subscription with a flat fee billed at the start of the period, and add-ons billed at the end of each quarter.
  • A monthly subscription with a flat fee billed at the start of the month, and usage (like the number of user active) at the end of the month.

Only-once products

When creating a subscription, you can assign products billed only once (one-off items). This is useful for charging implementation or onboarding fees for example. You can also choose to bill these products at the start or end of the period, and when billed they will be detached from future invoicing.