diff --git a/content/applications/sales/subscriptions/closing.rst b/content/applications/sales/subscriptions/closing.rst index e301a66a4db..2b561538961 100644 --- a/content/applications/sales/subscriptions/closing.rst +++ b/content/applications/sales/subscriptions/closing.rst @@ -2,102 +2,92 @@ Close subscriptions =================== -Odoo *Subscriptions* provides flexibility for businesses to decide whether customers can self-manage -their subscriptions, or restrict that ability entirely. +The Odoo **Subscriptions** app provides flexibility for businesses to decide whether customers can +self-manage their subscriptions, or restrict that ability entirely. + +.. note:: + A subscription must have been invoiced before it can be closed. Subscriptions that have not yet + been invoiced may be cancelled instead. Configuration ============= -Start by navigating to :menuselection:`Subscriptions app --> Configuration --> Recurring Plans`. -From there, either create a new plan by clicking :guilabel:`New` or select an existing one to modify -it. +To allow customers to close their own subscriptions using their user portal, navigate to +:menuselection:`Subscriptions app --> Configuration --> Recurring Plans`. From there, either create +a new plan by clicking :guilabel:`New` or select an existing one to modify it. -Once on the :guilabel:`Recurring Plans` form, enable the :guilabel:`Closable` option, in the -:guilabel:`Self-Service` section, to allow customers to close their own subscriptions using the -customer portal. +Once on the :guilabel:`Recurring Plans` form, enable the :guilabel:`Closable` option in the +:guilabel:`Self-Service` section. This adds a drop-down menu that allows plans to be closed either +on the date of the user's choosing or at the end of the current renewal period. .. image:: closing/recurring-plans-closable-option.png - :align: center - :alt: The Closable option on a recurring plan form in Odoo Subscriptions. + :alt: The Closable option enabled and displaying the drop-down menu in Odoo Subscriptions. Close a subscription ==================== -Administrator view ------------------- - -After a quotation for a subscription product has been confirmed, it becomes a sales order, and the -subscription status changes to :guilabel:`In Progress`. - -At that point, the ability to close the subscription becomes available, via the :guilabel:`Close` -button at the top of the subscription order, near the row that contains :guilabel:`In Progress` and -other stages. This option is also available after the order has been invoiced and the payment has -been registered. +The methods available for closing a subscription depend on users' :doc:`access rights +<../../general/users/access_rights>`. Users with administrator access rights to the Odoo database +can close the subscription from within the **Subscriptions** app. External users must use their +:doc:`user portal <../../general/users/user_portals>`. -.. image:: closing/close-subscriptions-administrator.png - :align: center - :alt: Close subscription from an administration point of view with Odoo Subscriptions. +With administrator access rights +-------------------------------- -Clicking the :guilabel:`Close` button prompts a :guilabel:`Close Reason` pop-up window to appear, -allowing administrators to input the reason for closing the subscription, or choose from the -drop-down menu of options in the :guilabel:`Reason` field. +After a quotation for a subscription product has been confirmed, it becomes a sales order, and the +subscription status changes to :guilabel:`In Progress`. At that point, the subscription may be +closed. -.. image:: closing/close-reason-popup.png - :align: center - :alt: The Close Reason pop-up when the Close button is clicked in Odoo Subscriptions. +From the dashboard, open the :menuselection:`Subscriptions` app. By default, the **Subscriptions** +dashboard displays both :guilabel:`In Progress` and :guilabel:`Paused` subscriptions. Open an +in-progress subscription. -When the desired :guilabel:`Reason` is entered, click the :guilabel:`Submit` button. +The :guilabel:`Close` button is at the top of the subscription order. Clicking it opens the *Close +Subscription* form, allowing an administrator to enter the date when the subscription is to be +closed in the :guilabel:`When` field and select the reason for closing from the drop-down menu of +options in the :guilabel:`Reason` field. Custom reasons may be created by opening the +:guilabel:`Reason` drop-down and choosing :guilabel:`Search more...` -Clicking :guilabel:`Submit` on the :guilabel:`Close Reason` pop-up window updates the subscription -sales order to show :guilabel:`Churned` status tag, along with the specified :guilabel:`Close -Reason`. +When the desired :guilabel:`Reason` is entered, click the :guilabel:`Submit` button. Clicking +:guilabel:`Submit` on the :guilabel:`Close` form updates the chatter with the reason for closing. +Once it's been closed, a :guilabel:`Churned` banner appears on the subscription order and the +chatter reflects the subscription's updated status, end date, and reason for closure. .. image:: closing/churned-sales-order.png - :align: center - :alt: A churned sales order for a closed subscription in Odoo Subscriptions. - -That same close reason can be found in the *Chatter* of the sales order, as well. - -.. image:: closing/churned-sales-order-chatter.png - :align: center - :alt: The chatter of a churned sales order for a closed subscription in Odoo Subscriptions. + :alt: A churned sales order for a closed subscription in Odoo Subscriptions showing the banner + and the chatter. Customer view ------------- -.. note:: - As an administrator, the ability to visualize what customers see when managing their - subscriptions is accessible via the :guilabel:`Preview` button, located at the top of the - subscription sales order. - -From the customer's point of view, in the customer portal, the :guilabel:`Close Subscription` button -is located on the left side of the sales order. +.. tip:: + As an administrator, the ability to visualize what users see when managing their subscriptions is + accessible via the :guilabel:`Preview` button at the top of each subscription sales order. -.. image:: closing/close-subscription-button-customer-view.png - :align: center - :alt: Close subscription button on a customer's view of a sales order in Odoo Subscriptions. +In the user portal, subscriptions may be managed by clicking the :guilabel:`Subscriptions` button on +the home page. Clicking this button takes the user to the :guilabel:`Subscriptions` page, where they +can see a list of all subscriptions associated with their account, including those that are +currently closed. -When the customer clicks the :guilabel:`Close Subscription` button, a :guilabel:`Close Subscription` -pop-up window appears, in which the customer has to choose from a select list of reasons why they -are choosing to close the subscription. +Clicking a subscription opens the details page for that subscription, which includes a +:guilabel:`Close Subscription` button. Clicking the :guilabel:`Close Subscription` button opens a +:guilabel:`Close Subscription` pop-up, where users must select from a list of reasons why they are +choosing to close the subscription. .. image:: closing/close-subscription-customer-pov.png - :align: center :alt: The close subscription pop-up window customers see when closing a subscription. .. note:: - Customers can *only* chose a pre-configured reason why the subscription is being closed. They can - *not* enter a custom reason from the customer portal. These selections can be adjusted by - navigating to :menuselection:`Subscriptions --> Configuration --> Close Reasons`. - -Once the customer has chosen a close reason, they would click the :guilabel:`Submit` button on the -pop-up window. - -Upon closure, the subscription order in the customer portal is tagged as :guilabel:`Closed`. + Users must choose a pre-configured reason why the subscription is being closed. They **cannot** + enter a custom reason from the user portal. Administrators can create custom reasons for users to + choose from by logging into the database and navigating to :menuselection:`Subscriptions app --> + Configuration --> Close Reasons`. -In addition, the specified :guilabel:`Close Reason` appears on the subscription order in the -*Subscriptions* app in the backend (Administrator's view). +Once the customer has chosen a reason for closing the subscription, they can click the +:guilabel:`Submit` button on the pop-up window. Upon closure, the subscription order in the user +portal is labeled :guilabel:`Closed`. Within the database, the subscription is marked *Churned*, and +the specified reason for closure is added to the chatter. .. seealso:: - - :doc:`../subscriptions` + :doc:`../subscriptions` diff --git a/content/applications/sales/subscriptions/closing/churned-sales-order-chatter.png b/content/applications/sales/subscriptions/closing/churned-sales-order-chatter.png deleted file mode 100644 index 59b5e689787..00000000000 Binary files a/content/applications/sales/subscriptions/closing/churned-sales-order-chatter.png and /dev/null differ diff --git a/content/applications/sales/subscriptions/closing/churned-sales-order.png b/content/applications/sales/subscriptions/closing/churned-sales-order.png index ca07f8b4288..cfdba3f3c42 100644 Binary files a/content/applications/sales/subscriptions/closing/churned-sales-order.png and b/content/applications/sales/subscriptions/closing/churned-sales-order.png differ diff --git a/content/applications/sales/subscriptions/closing/close-reason-popup.png b/content/applications/sales/subscriptions/closing/close-reason-popup.png deleted file mode 100644 index 58b48b221d4..00000000000 Binary files a/content/applications/sales/subscriptions/closing/close-reason-popup.png and /dev/null differ diff --git a/content/applications/sales/subscriptions/closing/close-subscription-button-customer-view.png b/content/applications/sales/subscriptions/closing/close-subscription-button-customer-view.png deleted file mode 100644 index 4ebd60c272a..00000000000 Binary files a/content/applications/sales/subscriptions/closing/close-subscription-button-customer-view.png and /dev/null differ diff --git a/content/applications/sales/subscriptions/closing/close-subscription-customer-pov.png b/content/applications/sales/subscriptions/closing/close-subscription-customer-pov.png index a03349d2c53..36af66fae81 100644 Binary files a/content/applications/sales/subscriptions/closing/close-subscription-customer-pov.png and b/content/applications/sales/subscriptions/closing/close-subscription-customer-pov.png differ diff --git a/content/applications/sales/subscriptions/closing/close-subscriptions-administrator.png b/content/applications/sales/subscriptions/closing/close-subscriptions-administrator.png deleted file mode 100644 index df8e734f178..00000000000 Binary files a/content/applications/sales/subscriptions/closing/close-subscriptions-administrator.png and /dev/null differ diff --git a/content/applications/sales/subscriptions/closing/recurring-plans-closable-option.png b/content/applications/sales/subscriptions/closing/recurring-plans-closable-option.png index 1cad388694b..5d820d9001c 100644 Binary files a/content/applications/sales/subscriptions/closing/recurring-plans-closable-option.png and b/content/applications/sales/subscriptions/closing/recurring-plans-closable-option.png differ