Configuration¶

The Subscriptions app ‣ Configuration menu holds the three records the subscription lines are built from.

Billing periods¶

A billing period is the recurrence a subscription line is billed on. Go to Subscriptions app ‣ Configuration ‣ Billing Periods.

Period: the name shown on the lines, for example Monthly or Yearly.
Period Type: Day, Week, Month or Year. This is what every date computation uses.
Quantity: how many of those units one period contains. Period Type = Month with Quantity = 3 is a quarterly period.
UoM: an optional display unit from the Working Time unit category. It is not used for date arithmetic.

Important

Always set the Period Type correctly: the dates are derived from it, not from the period’s name or its unit of measure.

screenshot: sales-subscriptions-billing-periods

menu: Subscriptions ‣ Configuration ‣ Billing Periods
shows: The Billing Periods list with the Period, Period Type, Quantity and UoM columns for a monthly, a quarterly and a yearly period.
highlight: The Period Type column (red frame).
data: Monthly (Month, 1), Quarterly (Month, 3), Yearly (Year, 1).
module: subscription
notes: English UI, light theme, 1440px width, crop to the list.

Coupons¶

A coupon is a promotional code applied to every recurring invoice of the contract it is set on. Go to Subscriptions app ‣ Configuration ‣ Coupons.

Description and Code: the customer-facing redemption code is case-sensitive.
Discount Type: Percentage or Fixed amount.
Discount Value: the percentage (0–100), or the amount in the coupon’s Currency.
Valid From / Valid To: the validity window.
Max Uses: 0 means unlimited. Used counts the redemptions.

screenshot: sales-subscriptions-coupon-form

menu: Subscriptions ‣ Configuration ‣ Coupons ‣ (a coupon)
shows: A coupon form with the Code, the Discount group (type and value) and the Validity group (valid from/to, max uses, used count).
highlight: The Discount group (red frame).
data: Coupon "WELCOME10", percentage 10, valid for the current year, max uses 100.
module: subscription
notes: English UI, light theme, 1440px width, full form.

Quantity formulas¶

A quantity formula computes the billable quantity of a subscription line whose Quantity Source is Formula. Go to Subscriptions app ‣ Configuration ‣ Quantity Formulas.

Name and Code: the short internal identifier, for example users_active.
Formula: a Python expression evaluated in a sandbox, which must assign a number to result.
Last Evaluated At, Last Result and Last Error show the outcome of the latest evaluation. Formulas with an error are highlighted in the list.

Important

Writing formulas requires knowledge of the data model, and a wrong formula changes what customers are invoiced. Reserve it for administrators, and check Last Result after every change.

screenshot: sales-subscriptions-formula-form

menu: Subscriptions ‣ Configuration ‣ Quantity Formulas ‣ (a formula)
shows: A quantity formula form with the Name and Code fields, the Formula code area and the Last Evaluation group (last evaluated at, last result, last error).
highlight: The Last Evaluation group (red frame).
data: Formula "Active users" with code "users_active" and a last result of 12.
module: subscription
notes: English UI, light theme, 1440px width, full form.

Scheduled actions¶

Three scheduled actions drive the application. All of them are delivered inactive and are enabled in Settings ‣ Technical ‣ Automation ‣ Scheduled Actions:

Scheduled action	Interval	Purpose
Subscription: Generate Recurring Invoices	1 day	Creates the recurring invoices.
Subscription: Dunning Retry	4 hours	Re-attempts declined charges.
Subscription: Emit Alerts	1 day	Raises activities for ending trials and hard declines.