Subscriptions

A Subscription represents a customer’s ongoing agreement to pay for a product at a specific rate plan, currency, and billing frequency. Subscriptions are the central entity in BillHive — invoices, payments, usage events, and orders all revolve around them.

Creating a Subscription

URL: /subscriptions/add or /customers/{customerId}/subscription/add

  1. Navigate to a customer’s page and click Add Subscription, or go to Subscriptions > Add.
  2. Fill in the subscription form:
FieldRequiredDescription
ProductYesThe product the customer is subscribing to.
Rate PlanYesThe specific plan tier (e.g., “Professional Plan”). Populated based on the selected product.
CurrencyYesBilling currency (e.g., USD, INR, EUR).
Billing FrequencyYesHow often the customer is billed — includes term and period (e.g., 1 Month, 12 Months).
Is TrialNoWhether the subscription starts with a free trial period.
Trial PeriodConditionalDuration of the trial (term + period). Only shown when Is Trial is enabled.
Subscription Start DateYesWhen the subscription begins. Defaults to today. Can be a past date, within the tenant’s lookback limit (see Backdated Start Dates).
Billing CyclesNoNumber of billing cycles for the subscription commitment.
Auto RenewNoWhether the subscription automatically renews at the end of the term.
Payment MethodNoThe payment method to charge for this subscription.
  1. Review addons — mandatory addons are automatically included; recommended addons can be toggled on/off.
  2. Review the order estimate showing pricing, prorations, and totals.
  3. Click Place Order to create the subscription.

Backdated Start Dates

When you onboard an existing customer, you can create a subscription that started in the past.

  • Who can backdate. Only admin channels (the BillHive web app and the API). Subscriptions created from the public checkout (Website) or the Self-Serve Portal cannot start in the past.
  • How far back. Up to the tenant’s Backdate lookback (days) setting, which defaults to 90 (see Subscription Settings). A start date today or in the future is not affected by the limit.
  • Rejected dates. A start date older than the limit, or any past date from a non-admin channel, is rejected with HTTP 400, for example Start date 2026-06-01 is more than 90 days in the past (tenant lookback limit).

For a backdated start:

  • The first term runs from the start date for one billing period (for example, a monthly plan started 30 days ago has a term from that date to the day before its first monthly anniversary), not from today.
  • The first invoice is dated the start date. Its due date still counts from the day it is issued, so a Net 30 invoice is due 30 days after you create it.
  • The subscription starts Active, and days already elapsed in the term are counted as used.
  • Only the first term is billed. If the start date is so far back that the term has already ended, the subscription is created with that ended term, and renewal picks up from there: each renewal creates the next term starting the day after the previous one ends, so later terms are billed one at a time rather than all at once.
  • Trial plans are not backdated: the trial starts today.

Viewing a Subscription

URL: /customers/{customerId}/subscriptions/{subscriptionId}

The subscription details page is organized into tabs:

TabContent
HomeGeneral information, term progress, status, amount, billing period, addons
OrdersAll orders associated with this subscription (creation, amendments, renewals)
InvoicesGenerated invoices with status and amounts
UsageUsage events and summary for usage-based pricing models
Activity LogComplete audit trail of all changes and events
Danger ZoneDestructive actions like cancellation

Subscription Details (Home Tab)

The home tab displays:

  • Subscription ID — Unique identifier
  • Product & Rate Plan — What the customer subscribed to
  • Currency — Billing currency
  • Amount — Current subscription amount
  • Billing Period — Frequency and term details
  • Term Dates — Start date, end date, and a visual progress bar showing days used vs. days remaining
  • Auto Renew — Whether the subscription renews automatically
  • Status — Current lifecycle status with color-coded badge
  • Addons — List of active addons with applicability (Mandatory / Recommended), pricing model, quantity, price, and individual status

Subscriptions List

URL: /subscriptions (all subscriptions) or within a customer’s page

The subscriptions table shows:

ColumnDescription
Subscription IDClickable link to subscription details
NameProduct, Rate Plan, and Currency combined
ProgressTerm date range with visual progress bar
StatusColor-coded status badge
ActionsView, Edit, Delete buttons

Supports pagination (10 per page), full-text search, and sorting by last updated.

Subscription Statuses

StatusBadge ColorDescription
ActiveGreenBilling normally
TrialBlueIn free trial period
Trial Pending ActivationBlueAwaiting activation
Trial ExpiredGrayTrial ended without conversion
PausedYellowTemporarily suspended
Non RenewingOrangeWill expire at term end
ExpiredGrayTerm ended, not renewed
CancelledRedExplicitly cancelled
In DunningRedPayment retry in progress