Skip to main content

Subscriptions

This guide explains subscriptions in MyCloudBook: the plans, the subscriptions of the customers with their trial, the statuses, the lifecycle periods, and the renewal of a subscription on an invoice or a receipt.

Overview

Subscriptions record the recurring services that the company sells to its customers, for example a monthly coffee delivery or a yearly maintenance contract. The feature has three parts:

  • a plan: the offer, with its billing frequency, price, trial days, income account, and tax;
  • a subscription: a customer that takes a plan, with its own name and price;
  • lifecycle periods: the periods that the subscription covers. A trial period, a renewal paid by an invoice or a receipt, or a period extended by hand.

A subscription has no accounting effect by itself. Money is recorded when an invoice or a receipt renews the subscription: the line of the document posts the sales to the income account of the plan, and the renewal adds a period to the subscription. The status of a subscription is computed from its periods every time the list is read.

Enable the feature first. The Subscriptions tab is shown only when Enable Subscription Services is checked in Settings, Preferences. The setting cannot be turned off while any subscription exists, including a canceled one. This setting is not the subscription of your company to MyCloudBook, which is managed under Manage My Subscriptions.

How to open the screen

  1. Check Enable Subscription Services in Settings, Preferences, and save.
  2. In the left navigation, click Sales, then the Subscriptions tab, the last tab of the Sales page.
The Subscriptions list of MyCloudBook with numbered markers on the toolbar and the columns.
Figure 1. The Subscriptions list.
  1. 1Subscriptions tab.
  2. 2New Subscription.
  3. 3Search .... Finds the subscriptions by name, description, notes, or custom field values.
  4. 4Customer.
  5. 5Plan. The active plans.
  6. 6Status.
  7. 7Search.
  8. 8Clear. Clears the search, the customer, and the status.
  9. 9Manage Plans. Opens the plans window.
  10. 10Name. Shown in red for an expired or canceled subscription.
  11. 11Customer.
  12. 12Plan. The plan of the current period.
  13. 13Status.
  14. 14Start Date. The start of the first period.
  15. 15Expire Date. The end of the last period.
  16. 16Billing Frequency.
  17. 17Price.

Plans

  1. In the Subscriptions list, click Manage Plans, then Add Plan.
  2. Type the Plan Name and a description. Choose the Billing Frequency, the Trial Days, and the Price.
  3. Select the Income Account that the renewals credit, and the Tax if the plan is taxed.
  4. Click Save.
The Add Subscription Plan window for the plan Monthly Coffee Supply: monthly, 14 trial days, price 49.
Figure 2. The Add Subscription Plan window.
  1. 1Plan Name. Required and unique.
  2. 2Description.
  3. 3Billing Frequency: Monthly, Quarterly, Semi-Annually, or Annually.
  4. 4Trial Days. Proposed for the trial period of a new subscription. Default 30.
  5. 5Price.
  6. 6Income Account. Required. The renewals of the plan are posted to it.
  7. 7Tax. Proposed on the renewal lines.
  8. 8Active or Inactive. An inactive plan is not offered for new subscriptions.
  9. 9Save.
The Manage Plans window with the plan Monthly Coffee Supply.
Figure 3. The Manage Plans window.
  1. 1Add Plan.
  2. 2Name. An inactive plan is marked (Inactive).
  3. 3Billing Frequency.
  4. 4Price.
  5. 5Trial Days.

A plan that is used by a subscription cannot be deleted. Set it to Inactive instead.

Adding a subscription

  1. In the Subscriptions list, click New Subscription.
  2. Type a Name, select the Customer, the Billing Frequency, and the Sales Price.
  3. For a trial, select the Plan in the Trial Period tab. The start date is today and the end date follows the trial days of the plan; both can be changed. Leave the plan empty to start without a trial.
  4. Click Save.
The Add Subscription window for Harbor View Catering with a trial of the plan Monthly Coffee Supply.
Figure 4. The Add Subscription window.
  1. 1Name. Required and unique.
  2. 2Customer. Required.
  3. 3Billing Frequency.
  4. 4Sales Price. The price proposed on the renewals.
  5. 5Description. Up to 1000 characters.
  6. 6Notes. Up to 1000 characters.
  7. 7The tabs Trial Period and Custom Fields.
  8. 8Plan of the trial period. Optional.
  9. 9Start Date of the trial.
  10. 10End Date of the trial.
  11. 11Trial Days. Computed from the two dates, both days included.
  12. 12Suspended. Gives the status Suspended.
  13. 13Save.

To change the trial period after the save, use Lifecycle Periods in the row menu of the subscription.

The Subscriptions list with the new subscription in status Trial.
Figure 5. The new subscription in the list.
  1. 1The subscription: status Trial, the plan, the dates, the frequency, and the price.

The fields

FieldRequiredPurpose and rules
NameRequiredThe name of the subscription, unique in the company.
CustomerRequiredThe customer. It cannot change once the subscription has a renewal.
Billing FrequencyOptionalMonthly, Quarterly, Semi-Annually, or Annually. Proposed as the period type of the renewals; empty means the frequency of the plan.
Sales PriceOptionalProposed as the unit price of the renewals; empty means the price of the plan.
Description
Notes
OptionalUp to 1000 characters each. The search finds them.
Plan (trial)OptionalThe plan of the trial period. With a plan, the trial start and end dates are required and the start must be before the end.
SuspendedOptionalMarks the subscription as suspended.

Statuses

The status is not stored. MyCloudBook computes it from the periods and the dates each time the list is read, so a subscription becomes Expired by itself after its last period.

StatusWhen it is shown
PendingThe subscription has no period yet, for example a subscription saved without a trial and not yet renewed.
TrialThe current period is a trial period, and it has not ended.
ActiveThe current period is a renewal or an extended period, and it has not ended.
ExpiredThe last period ended before today.
SuspendedThe Suspended box is checked.
CanceledThe subscription was canceled with Cancel. It is hidden from the list unless the filter is Canceled, and it cannot be renewed. Restore cancels the cancel.
The Status filter of the Subscriptions list with Pending, Trial, Active, Expired and Canceled.
Figure 6. The Status filter.
  1. 1Status.
  2. 2Pending, Trial, Active, Expired, Canceled.
The row actions menu of a subscription with Edit, Lifecycle Periods, Delete and Cancel.
Figure 7. The row actions menu.
  1. 1Edit.
  2. 2Lifecycle Periods.
  3. 3Delete. Allowed only while the subscription has no period other than its trial.
  4. 4Cancel. For a canceled subscription the menu shows Restore instead.

Lifecycle periods

Lifecycle Periods in the row menu opens the periods of the subscription in a tab: the trial, the renewals with the invoice or the receipt that paid them, and the extended periods. Record Lifecycle Period adds a trial period or an extended period by hand, for example a free month. The new period starts on the day after the last period and must not overlap another period.

The Lifecycle Periods tab of the subscription with its trial period.
Figure 8. The lifecycle periods of a subscription.
  1. 1The Lifecycle Periods tab of the subscription.
  2. 2Record Lifecycle Period.
  3. 3Event Type: Trial Period, Renew, or Extended Period.
  4. 4Plan Name.
  5. 5Period Start Date.
  6. 6Period End Date.
  7. 7Document: the invoice or the receipt of a renewal. A click opens it.
  8. 8Amount.
The Record Lifecycle Period window with Event Type, Plan, Notes, Period Start, Period End and Total Days.
Figure 9. The Record Lifecycle Period window.
  1. 1Event Type: Extended Period or Trial Period.
  2. 2Plan. Required.
  3. 3Notes.
  4. 4Period Start: the day after the last period.
  5. 5Period End.
  6. 6Total Days.

A renewal period can be changed or deleted only through its document: change the line of the invoice or the receipt, or delete the document.

Renewing a subscription

  1. Open a new invoice or receipt and select the customer.
  2. Click Renew Subscription above the lines. The window lists the subscriptions of the customer that are not canceled.
  3. Select the subscription. The plan, the period type, the start date (the day after the expire date), the quantity 1, and the unit price are proposed; the end date and the total are computed.
  4. Change the period type or the quantity if needed, and click Add. A line with the subscription and its period is added to the document.
  5. Save the document. The renewal period is added to the subscription, and the expire date moves to its end.
The Renew Subscription window of an invoice with the subscription, the plan, the period and the price.
Figure 10. The Renew Subscription window.
  1. 1Renew Subscription, on an invoice or a receipt.
  2. 2Subscription.
  3. 3Plan.
  4. 4Period Type: Month, Quarter, Semi-Annual, Year, or Custom Days.
  5. 5Start Date: the day after the expire date.
  6. 6Quantity. The number of periods.
  7. 7End Date, computed.
  8. 8Unit Price.
  9. 9Total.

The edit icon in the Subscription column of the line reopens the window as Update Renew Subscription; the subscription itself cannot change there. Removing the line or deleting the document removes the renewal period.

Messages and their meaning

MessageCauseWhat to do
Some fields are not valid!A required field is empty.Fill in the field that is marked in red.
Subscription name already exists: XAnother subscription has the same name.Use another name.
Plan name already exists: XAnother plan has the same name.Use another name.
'Trial Start Date' must be before the 'Trial End Date'The trial dates are reversed.Correct the dates.
You cannot change the customer because there are one or more 'Renew' lifecycle events associated with this subscription.The subscription was renewed.Keep the customer, or create a new subscription.
This subscription has a lifecycle record and cannot be deleted. ...The subscription has a renewal or an extended period.Use Cancel instead.
You cannot delete the plan 'X' because it is used by N subscription(s). ...Subscriptions use the plan.Set the plan to Inactive.
The subscription 'X' already includes a period from 'A' to 'B'. Please adjust the new period to avoid overlap.The new period overlaps another period.Change the dates.
You can not delete the event related to Invoice. ...Delete of a renewal period.Delete the invoice line or the invoice.
Please select a customer first.Renew Subscription without a customer.Select the customer of the document.

Questions and answers

How do I sell a subscription in MyCloudBook?

Enable Subscription Services in Settings, Preferences. Create a plan in Manage Plans, create the subscription for the customer, and renew it with Renew Subscription on an invoice or a receipt.

How are the renewals of a subscription recorded?

Each renewal is a line of an invoice or a receipt that a user creates with Renew Subscription. The document records the sale and adds the period to the subscription.

How do I give a customer a free month?

Open Lifecycle Periods of the subscription, click Record Lifecycle Period, choose Extended Period, and set the dates.

Can I delete a subscription?

Only while it has no period other than its trial. A subscription with renewals can be canceled; Restore reverses the cancel.

Why can I not turn off Enable Subscription Services?

The setting cannot be turned off while any subscription exists, including a canceled one. Delete the subscriptions first.