diff --git a/content/applications/sales/subscriptions/plans.rst b/content/applications/sales/subscriptions/plans.rst index 301d7f61d..6614a3483 100644 --- a/content/applications/sales/subscriptions/plans.rst +++ b/content/applications/sales/subscriptions/plans.rst @@ -2,45 +2,101 @@ Subscription plans ================== -Subscription plans are :doc:`quotation templates <../sales/send_quotations/quote_template>` specific -to **subscriptions** used to preconfigure selectable **plans** and **recurrence periods** to -configure quotations quickly. +*Subscription plans* are :doc:`quotation templates +` used to preconfigure quotations with +subscription products. Use subscription plans to quickly create subscription orders. -Configuration -============= +Configure subscription plans +============================ -To create a new subscription plan or edit an existing one, go to :menuselection:`Subscriptions --> -Configuration --> Plans`, and click :guilabel:`New` or select an existing plan. +To configure subscription plans, go to :menuselection:`Subscriptions --> Configuration --> Plans`. +Then, click :guilabel:`New` to create a new plan, or select an existing plan to edit it. -.. image:: plans/subplan-configuration.png - :alt: Subscription plan (quotation template) configuration +Since the Odoo *Subscriptions* app is integrated closely with the *Sales* app, subscription plans +use the same form as quotation templates. -When creating a subscription plan, several options are available: +.. image:: plans/subplan-quotation-template.png + :align: center + :alt: Subscription plan (quotation template) configuration form. -- The **name** of the plan; -- :guilabel:`Quotation expires after`: after how many days the quotation expires; -- :guilabel:`Online confirmation`: if the customer's :guilabel:`Signature` or - :guilabel:`Payment` confirms the order. Enable both to leave the choice to the customer; -- :guilabel:`Confirmation Mail`: the **mail template** used for the order confirmation mail; -- :guilabel:`Recurrence`: the recurrence of **recurring products** used with this template. +The subscription plan form contains the following options: -Selecting a :guilabel:`Recurrence` enables the following additional options: +- :guilabel:`Name`: Enter a name for the subscription plan at the top of the page. +- :guilabel:`Quotation expires after`: Enter the number of days after which the quotation expires, + starting from the day the quotation is sent to the customer. Leave this field at zero for the + quotation to never expire. +- :guilabel:`Online Confirmation`: Check the boxes next to :guilabel:`Signature` or + :guilabel:`Payment` to enable the customer to confirm their subscription order by signing or + paying for the quotation. Enable both to leave the choice to the customer. Enable neither to only + confirm the quotation in the backend. +- :guilabel:`Confirmation Mail`: Select an :doc:`email template + ` for the confirmation email that is + automatically sent to the customer after the quotation is confirmed. Leave this field blank to + send nothing. -- :guilabel:`Duration`: whether **recurring products** used with this template have no **end date**, - or if they have a :guilabel:`Fixed` duration. Selecting :guilabel:`Fixed` enables an additional - option to select the **duration**; -- :guilabel:`Self Closable`: if enabled, the **customer** can terminate their subscription from - their **customer portal**; -- :guilabel:`Automatic Closing`: the number of days after which **unpaid** subscriptions *past* the - due date are automatically closed; -- :guilabel:`Invoicing Journal`: if set, subscriptions with this template are invoiced in the set - journal. If none, the sales journal with the lowest sequence is used. + - To create a new email template, enter a name for the template, then click :guilabel:`Create and + edit`. + - To edit an existing email template, select one from the drop-down menu, then click on the + :guilabel:`Internal link` arrow at the end of the line. -.. note:: - On each template, you can add specific :doc:`Terms & Conditions - <../sales/send_quotations/terms_and_conditions>`. If **terms and conditions** are specified on a - template, these will be used instead of the default **terms and conditions** set in the **Sales** - app settings (if any are set). +- :guilabel:`Recurrence`: Select the recurrence period used for the plan. The recurrence periods + available here are the same ones that are configured in :menuselection:`Subscriptions --> + Configuration --> Recurrence Periods`. -.. image:: plans/subplan-terms.png - :alt: Terms and conditions of subscription plan +Selecting a :guilabel:`Recurrence` turns the quotation template into a subscription plan and enables +the following additional options: + +- :guilabel:`Duration`: Choose whether the subscription plan has no end date (:guilabel:`Forever`) + or a :guilabel:`Fixed` duration. + + - If the duration is :guilabel:`Forever`, then the subscription plan will continually renew until + either the customer or the company manually ends the subscription. + - If the duration is :guilabel:`Fixed`, then enter an :guilabel:`End After` date, which determines + the amount of time after which the subscription will automatically end. + +- :guilabel:`Self Closable`: Check this box to enable the customer to terminate their subscription + from the :doc:`customer portal + `. +- :guilabel:`Automatic Closing`: Enter the number of days after which *unpaid* subscriptions *past* + the due date are automatically closed. +- :guilabel:`Invoicing Journal`: Select the accounting journal in which invoices for this + subscription plan are recorded. Leave this field blank to use the sales journal with the lowest + sequence. + +.. image:: plans/subplan-recurrence.png + :align: center + :alt: Subscription plan with Recurrence selected. + +In the :guilabel:`Lines` tab, create the order lines for the quotation. Click :guilabel:`Add a +product`, select a product to include in the plan, and then enter the :guilabel:`Quantity` and +:guilabel:`Unit of Measure`. Add as many products as desired to the order lines. + +In the :guilabel:`Optional Products` tab, enter any optional products that the customer can add to +their quotation before confirming the order. + +If the subscription plan has unique :doc:`terms and conditions +`, add them in the :guilabel:`Terms +& Conditions` tab. If terms conditions are specified on a plan, these will be used instead of the +default terms and conditions set up in the *Sales* app settings. + +.. image:: plans/subplan-terms-conditions.png + :align: center + :alt: Subscription plan Terms & Conditions tab. + +Use subscription plans on quotations +==================================== + +Quotations for subscription products can be created in both the *Subscriptions* app and the *Sales* +app. + +From the :guilabel:`Subscriptions` dashboard, click :guilabel:`New` to create a new quotation. Then, +select a subscription plan in the :guilabel:`Subscription Plan` field. + +The :guilabel:`Recurrence`, products, and other information from the plan are automatically filled +in. The quotation can then be modified further as needed. + +From the :guilabel:`Sales` dashboard, click :guilabel:`New` to create a new quotation. Then, select +a subscription plan in the :guilabel:`Quotation Template` field. + +All subscription orders will appear on the :guilabel:`Subscriptions` dashboard regardless of whether +they were created in the *Subscriptions* app or the *Sales* app. diff --git a/content/applications/sales/subscriptions/plans/subplan-configuration.png b/content/applications/sales/subscriptions/plans/subplan-configuration.png deleted file mode 100644 index 47893b0b3..000000000 Binary files a/content/applications/sales/subscriptions/plans/subplan-configuration.png and /dev/null differ diff --git a/content/applications/sales/subscriptions/plans/subplan-quotation-template.png b/content/applications/sales/subscriptions/plans/subplan-quotation-template.png new file mode 100644 index 000000000..3823f4b9d Binary files /dev/null and b/content/applications/sales/subscriptions/plans/subplan-quotation-template.png differ diff --git a/content/applications/sales/subscriptions/plans/subplan-recurrence.png b/content/applications/sales/subscriptions/plans/subplan-recurrence.png new file mode 100644 index 000000000..9539b98d1 Binary files /dev/null and b/content/applications/sales/subscriptions/plans/subplan-recurrence.png differ diff --git a/content/applications/sales/subscriptions/plans/subplan-terms-conditions.png b/content/applications/sales/subscriptions/plans/subplan-terms-conditions.png new file mode 100644 index 000000000..f87c9e20e Binary files /dev/null and b/content/applications/sales/subscriptions/plans/subplan-terms-conditions.png differ diff --git a/content/applications/sales/subscriptions/plans/subplan-terms.png b/content/applications/sales/subscriptions/plans/subplan-terms.png deleted file mode 100644 index aae99fb59..000000000 Binary files a/content/applications/sales/subscriptions/plans/subplan-terms.png and /dev/null differ