> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Glossary

> Learn more about Hyperline's key concepts and their definitions

<Info>
  Is something still unclear? Don't hesitate to [reach out to our
  team](mailto:support@hyperline.co) if you need additional support.
</Info>

## Core Entities

| Term               | Definition                                                                                                                                     |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| **Bundle product** | A product that groups several existing products as components and sells them as a single unit. Distinct from the "bundle" pricing model.       |
| **Customer**       | An individual or company that purchases your products/services. Has billing information, payment methods, and can have multiple subscriptions. |
| **Invoice**        | A document requesting payment from a customer.                                                                                                 |
| **Product**        | A billable item in your catalog.                                                                                                               |
| **Quote**          | A sales proposal sent to customers before creating a subscription. Can be signed electronically or manually.                                   |
| **Subscription**   | A recurring billing agreement between you and a customer, defining which products are included, pricing, and billing schedule.                 |

## Subscription

| Term                      | Definition                                                                                                                 |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| **Activation strategy**   | How a subscription becomes active.                                                                                         |
| **Cancellation**          | Ending a subscription.                                                                                                     |
| **Contract terms**        | Terms governing the subscription contract including start/end dates, duration, and renewal settings.                       |
| **Proration**             | Calculating partial charges when changes occur mid-billing period.                                                         |
| **Renewal**               | When a subscription automatically continues for another term.                                                              |
| **Subscription phase**    | A distinct period within a subscription with its own products and terms (e.g., trial, standard).                           |
| **Subscription template** | A pre-configured subscription setup that can be reused for multiple customers or contexts (currency/country combinations). |
| **Subscription update**   | A pending change to a subscription (add/remove products, change prices, apply coupons).                                    |
| **Trial period**          | A free or discounted phase before regular billing begins.                                                                  |

## Pricing & Billing

| Term                                   | Definition                                                                                                                                                                  |
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Billing interval**                   | How often a customer is charged (e.g., monthly, yearly, weekly).                                                                                                            |
| **Commitment period**                  | Minimum contract duration for a subscription (e.g., 1-year commitment).                                                                                                     |
| **Price book**                         | A collection of custom price configurations that can be assigned to specific customers for special pricing.                                                                 |
| **Price configuration**                | Defines how a product is priced. Includes currency, billing interval, and pricing model.                                                                                    |
| **Pricing model - BPS (Basis Points)** | Percentage-based pricing typically used for payment processing fees.                                                                                                        |
| **Pricing model - Bulk**               | A single price per unit is applied based on the total usage tier (e.g., 150 units all priced at the 101-200 tier rate).                                                     |
| **Pricing model - Bundle**             | Predefined quantity/price packages on a seat or credit product (e.g., 1000 credits for $50, or 10 seats for $180). Distinct from a Bundle product, which is a product type. |
| **Pricing model - Fee**                | A fixed amount charged per billing period (e.g., \$99/month).                                                                                                               |
| **Pricing model - Packaged**           | Units are sold in packages/bundles (e.g., \$100 per 1000 API calls).                                                                                                        |
| **Pricing model - Volume**             | Price per unit decreases as usage increases through tiers (e.g., first 100 units at $0.10, next 100 units at $0.08).                                                        |

## Usage & Metering

| Term                       | Definition                                                                                                                |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| **Billable event**         | A usage record sent via API that represents a customer action to be metered (e.g., API call, message sent, storage used). |
| **Committed count**        | A guaranteed minimum usage amount that will be charged regardless of actual usage.                                        |
| **Metering configuration** | Defines how billable events are counted or summed for billing.                                                            |
| **Metering filter**        | Conditions applied to narrow down which events count toward billing (e.g., only count events where `region = 'us'`).      |
| **Usage interval**         | The period over which usage is measured before billing (can differ from billing interval).                                |

## Credits & Wallet

| Term                      | Definition                                                                                       |
| ------------------------- | ------------------------------------------------------------------------------------------------ |
| **Credit transaction**    | A record of credits being added, consumed, or expired.                                           |
| **Credits**               | Pre-purchased units that can be consumed against usage-based products. Can expire.               |
| **Low balance threshold** | A configurable threshold that triggers notifications when credits or wallet balance falls below. |
| **Top-up**                | Adding credits or wallet balance to a customer's account.                                        |
| **Wallet**                | A prepaid balance account for a customer that can be used to pay invoices.                       |
| **Wallet transaction**    | A record of funds being credited or debited from a customer's wallet.                            |

## Discounts & Promotions

| Term                | Definition                                                                                        |
| ------------------- | ------------------------------------------------------------------------------------------------- |
| **Coupon**          | A discount that can be applied to subscriptions. Can be a fixed amount or percentage off.         |
| **Coupon duration** | How long a coupon applies.                                                                        |
| **Coupon repeat**   | Controls coupon application frequency.                                                            |
| **Promotion code**  | A shareable code that customers can use to redeem a coupon. Can have usage limits and expiration. |

## Documents

| Term                  | Definition                                                                                                    |
| --------------------- | ------------------------------------------------------------------------------------------------------------- |
| **Checkout page**     | A hosted payment page where customers can enter payment details and complete a purchase.                      |
| **Checkout session**  | A hosted page experience for customers to complete payment and subscription activation.                       |
| **Contract clause**   | Reusable text blocks that can be included in contracts.                                                       |
| **Contract template** | Legal document templates that can be attached to quotes.                                                      |
| **Credit note**       | A document issued to reverse or reduce a previously issued invoice.                                           |
| **Customer portal**   | A self-service interface where customers can view invoices, manage subscriptions, and update payment methods. |
| **Invoice line item** | An individual charge on an invoice representing a product or adjustment.                                      |
| **Purchase order**    | A customer's reference number for their internal tracking.                                                    |
| **Quote template**    | Reusable configuration for quotes including terms, display options, and attached documents.                   |

## Approvals

| Term                     | Definition                                                                                                                                 |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| **Approval request**     | A request for approval created when a quote matches an approval workflow. Tracks the approval status and history.                          |
| **Approval step**        | A stage in an approval workflow where designated approvers must approve or reject before proceeding.                                       |
| **Approval workflow**    | A configurable set of rules and steps that determine when and how quotes require approval based on conditions like amount or products.     |
| **Approver requirement** | Whether any single approver or all designated approvers must approve a step (`any` or `all`).                                              |
| **Workflow condition**   | A rule that determines if a workflow applies to a quote (e.g., total amount greater than €10,000, specific products, discount percentage). |
| **Workflow priority**    | A number used to select between multiple matching workflows. Higher priority workflows are selected first.                                 |

## Payments

| Term                               | Definition                                                                                                          |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| **Bank account**                   | Customer's bank account details used for manual bank transfer payments.                                             |
| **Chargeback**                     | When a customer disputes a charge with their bank, resulting in reversed payment.                                   |
| **Dunning**                        | The process of automatically retrying failed payments and communicating with customers to collect overdue invoices. |
| **Grace period**                   | A delay between invoice creation and payment collection, allowing review or manual adjustment.                      |
| **Payment method**                 | How a customer pays (card, direct debit, bank transfer, etc.).                                                      |
| **Payment method state**           | Current status of a payment method.                                                                                 |
| **Payment service provider (PSP)** | A third-party service that processes payments (e.g., Stripe, GoCardless, Mollie).                                   |
| **Transaction**                    | A payment attempt or successful charge against an invoice.                                                          |

## Organization

| Term                 | Definition                                                                                                                          |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| **Client**           | Your account/organization in Hyperline (the seller).                                                                                |
| **Custom field**     | User-defined properties that can be added to customers, subscriptions, products, plans, or quotes.                                  |
| **Invoicing entity** | A legal entity that issues invoices (your company or subsidiaries). Has its own branding, address, tax ID, and numbering sequences. |
| **Tax ID**           | A tax identification number (e.g., VAT number) for a customer or invoicing entity, used for tax compliance and validation.          |
| **Tax rate**         | VAT/sales tax rates applied to invoices.                                                                                            |
| **Tax scheme**       | How tax is applied to an invoice.                                                                                                   |

## Analytics & Reporting

| Term                                   | Definition                                                                        |
| -------------------------------------- | --------------------------------------------------------------------------------- |
| **ARPA (Average Revenue Per Account)** | ARR divided by the number of active customers.                                    |
| **ARR (Annual Recurring Revenue)**     | The value of recurring revenue normalized to a yearly amount.                     |
| **Churn**                              | When customers cancel their subscriptions or reduce spending.                     |
| **Contract value**                     | Total value of a subscription over its full contract term.                        |
| **Estimated ARR**                      | Projected annual revenue from a subscription including variable/usage components. |
| **MRR (Monthly Recurring Revenue)**    | The value of recurring revenue normalized to a monthly amount.                    |

## Integrations

| Term            | Definition                                                         |
| --------------- | ------------------------------------------------------------------ |
| **External ID** | Your system's identifier for a customer, used for mapping records. |
