1. Add a "Payment Plan Settings" to Administer menu.
2. In the settings page, a configuration checkbox "Use latest price when auto renew membership?" should be provided.
3. If the "Use latest price when auto renew membership?" is not checked, nothing changes.
4. If the "Use latest price when auto renew membership?" is checked, when an offline auto renew membership is being renewed by the "Renew offline auto-renewal memberships" scheduled job
   1. the generated contribution/ recurring contribution should reflect the current membership fee configured in the corresponding membership type for each membership line included in the recurring contribution
   2. the line items and other sub-entities of the generated contributions should also reflect the current membership fee configured in the corresponding membership type

1. Add a "Offline auto-renew option" custom fieldset to Membership Entity with boolean custom field "Opt-out auto price update for offline auto-renew".
2. When"Opt-out auto price update for offline auto-renew" is true for a membership, if "Use latest price when auto renew membership?" is turned on, this membership should not reflect the new price when it gets auto-renewed by the offline auto-renew scheduled job.

1. Create a database table "membershipextras_subscription_line" upon installation of the extension. The database table have following columns:
   
   1. contribution_recur_id - integer - required
   2. line_item_id - integer - required
   3. start_date - date
   4. end_date - date
   5. auto_renew - boolean
   6. is_removed - boolean

1. Adding a hook or adding into an existing hook so that when a recurring contribution is created using an offline payment processor (payment processor with Payment Manual class):
   1. create a copy of each line item of a instalment contribution
   2. the contribution_id of the copied line items should NULL
   3. a record should be created in "membershipextras_subscription_line" table for each of the copied line item:
      1. contribution_recur_id - the id of the recurring contribution
      2. line_item_id - the id of the copied line item
      3. start_date - start date of the recurring contribution
      4. end_date - leave empty
      5. auto_renew - true if the recurring contribution auto-renews, otherwise false
      6. is_removed - false

1. Creating a custom fieldset "Related Payment Plan Periods" for recurring contribution entity. It should contain two read-only integer fields:
   1. Previous Payment Plan Period
   2. Next Payment Plan Period

1. Add a "View/Modify Future Instalments" action to any recurring contribution that uses an offline payment processor (payment processor with payment manual class).
2. When the action is selected, a "Manage Instalments" modal popup should appear.
3. In the current period tab (default), each "membershipextras_subscription_line" whose start date is not empty and is_removed = false should be displayed. each row should have the following information:
   1. Item - line item label
   2. Start date - start_date in membershipextras_subscription_line
   3. End date - biggest end date among all linked memberships
   4. Renew automatically - auto_renew in membershipextras_subscription_line. This should not show if the recurring contribution is not auto-renew.
   5. Financial type - financial type of the line item
   6. Tax - the tax percentage of the financial type, show N/A if there is no tax account in the financial type
   7. Amount - line total of the line item
   8. Remove button - show as bin icon
4. An "Add Membership" button and an "Add Other Amount" button should be shown under the last row
5. At the bottom of the tab, the following information should be shown:
   1. Untaxed Amount - total amount of the line_totals
   2. Tax - total amount of tax_amounts
   3. Total per instalment - sum of a and b

1. In the "Manage Instalments" modal popup, a next period tab should be shown if the recurring contribution has auto-renew enabled and it has at least one membership.
2. In the next period tab (default), each "membershipextras_subscription_line" with auto-renew = TRUE should be displayed. each row should have the following information:
   1. Item - line item label
   2. Financial type - financial type of the line item
   3. Tax - the tax percentage of the financial type, show N/A if there is no tax account in the financial type
   4. Amount - line total of the line item
   5. Remove button - show as bin icon
3. An "Add Membership" button and an "Add Other Amount" button should be shown under the last row
4. At the bottom of the tab, the following information should be shown:
   1. Untaxed Amount - total amount of the line_totals
   2. Tax - total amount of tax_amounts
   3. Total per instalment - sum of a and b

1. In the "View/Modify Future Instalments" current period tab, user can click on the bin button on each of the line item to perform a removal action.
2. Once the bin button is clicked, if the item is the last item in the current period tab, a notice with warning sign should appear with text "Cannot remove the last item in an order" and action should be cancelled.
3. Once the bin button is clicked, if the item is not the last item in the current period tab, a dialog with title "Remove LINE_ITEM_LABEL ?" should appear with the following components:
   1. dialog body text - "LINE_ITEM_LABEL amount should be deducted from all remaining instalments after the end date. Please note the changes should take effect immediately after "Apply"."
   2. Adjust end date - checkbox option
   3. End date - datepicker that should only be shown if "Adjust end date" is checked, default to today's date
   4. Cancel button
   5. Apply button
4. If user clicked on "Apply":
   1. end_date in membershipextras_subscription_line for the corresponding item should be filled in with today's date. If "Adjust end date" is checked, the end_date should be set to the date user picked.
   2. auto_renew in membershipextras_subscription_line for the corresponding item should set to False.
   3. is_removed in membershipextras_subscription_line for the corresponding item should set to True.
   4. for any "Pending" instalment contribution with "Received Date" equals to or after the end_date, any line_item with same label as the recurring line item should be removed. Contribution amounts should be adjusted.
   5. if the line item is a membership, update the corresponding membership (linked to the recurring contribution) to have the new end_date and clear the contribution_recurr_id
   6. a notice should appear with text "LINE_ITEM_LABEL has been removed from the active order."
   7. a notice should appear with text "LINE_ITEM_LABEL should no longer be continued in the next period."
   8. the content of "Manage Instalments" modal should be reloaded.
5. If user clicked on "Cancel", the action should be cancelled and no change is made.

1. In the "View/Modify Future Instalments" next period tab, user can click on the bin button on each of the line item to perform a removal action.
2. Once the bin button is clicked, a dialog with title "Remove LINE_ITEM_LABEL ?" should appear with the following components:
   1. dialog body text - "Please note the changes should take effect immediately after "Apply"."
   2. Cancel button
   3. Apply button
3. If user clicked on "Apply":
   
   1. auto_renew in membershipextras_subscription_line for the corresponding item should set to False.
   2. is_removed in membershipextras_subscription_line for the corresponding item should set to True.
   3. if the line item is a membership, clear the contribution_recurr_id of the corresponding membership (linked to the recurring contribution)
   4. a notice should appear with text "LINE_ITEM_LABEL should no longer be continued in the next period."
   5. the content of "Manage Instalments" modal should be reloaded.
4. If user clicked on "Cancel", the action should be cancelled and no change is made.
5. User can also uncheck "Renew automatically" field for any of the line in "Current period" tab to perform the same action. Point 2-4 also apply here.

1. In the "View/Modify Future Instalments" current period tab, user can use "Add Membership" and "Add Other Amount" buttons to add line items to the current order.
2. Once the "Add Membership" is clicked, a new row should appear in current period tab with the following information:
   1. Item - required - a dropdown contains all membership types which are not belong to any of the membership organisation for the existing lines
   2. Start date - required - a datepicker default to today's date. If there is an active membership of the same type, default to the start date of that membership.
   3. End date - required - a date picker default to biggest end date among all linked memberships
   4. Renew automatically - a checkbox checked by default, only show if the recurring contribution has auto-renew enabled.
   5. Financial type - text showing the financial type of the selected membership
   6. Tax - text showing the tax percentage of the financial type, show N/A if there is no tax account in the financial type
   7. Amount - required - a money input box defaulted to the minimum_fee of the membership type divided by number_of_instalments.
   8. cross icon - cancel action
   9. check icon - confirm action
3. When a row is added but not yet confirmed/ cancelled, any parts of the modal popup other then the row itself should be made unclickable. If the user tries to click on any other parts, the row should flash to remind the user an item is yet to be completed.
4. If user clicked on cross icon, the row should be cancelled and no change is made.
5. When user clicked on the check icon, if there is no "Pending" instalment contribution with "Received Date" equals to or after the today/ start date (whichever is later), a notice with warning sign should appear with text "No outstanding instalment contribution from the selected start date. Suggest to follow the steps below:
   1. Add the the item to next period instead.
   2. (optional) Create the membership or contribution outside the reucrring order."
6.  When user clicked on the check icon, if there are "Pending" instalment contributions with "Received Date" equals to or after the today/ start date (whichever is later), a dialog with title "Add LINE_ITEM_LABEL ?" should appear with the following components:
   1. dialog body text - "Please note the changes should take effect immediately after "Apply"."
   2. a "Adjust the amount of the first instalment" checkbox option.
   3. a "First instalment amount" money text input. Defaults to the instalment amount. This is only revealed when "Adjust the amount of the first instalment" checkbox is ticked.
   4. Cancel button
   5. Apply button
7. If user click on "Apply" button:
   1. a line item with empty contribution_id should be created according to the information user inputted. Note that the tax_amount will calculated by multiplying amount with tax rate.
   2. a membershipextras_subscription_line should be created linking the line item and the recurring contribution. It's start date should be the selected start date and it's end date should be empty.
   3. for any "Pending" instalment contribution with "Received Date" equals to or after the today/ start date (whichever is later), a copy of the line_item should be added. Contribution amounts should be adjusted. If "Adjust the amount of the first instalment" is checked, the first  "Pending" instalment contribution should apply "First instalment amount".
   4. if a membership of the same type doesn't yet exist, a new membership should be created with the start date and end date and linked to all "Pending" instalment contribution with "Received Date" equals to or after the today/ start date (whichever is later).
   5. if a membership of the same type already exists, it should be updated with the new start date and end date and linked to all "Pending" instalment contribution with "Received Date" equals to or after the today/ start date (whichever is later).
   6. if auto_renew is checked, the auto_renew in membershipextras_subscription_line for the corresponding item should set to TRUE. The membership contribution_recurr_id should be set to the id of the recurring contribution.
   7. if auto_renew is not checked, the auto_renew in membershipextras_subscription_line for the corresponding item should set to FALSE. The membership contribution_recurr_id should be emptied.
   8. a notice should appear with text "LINE_ITEM_LABEL has been added to the active order."
   9. if auto-renew is selected, a notice should appear with text "LINE_ITEM_LABEL will now be continued in the next period."
   10. the content of "Manage Instalments" modal should be reloaded.
8. If user clicked on "Cancel", the action should be cancelled and no change is made.

1. In the "View/Modify Future Instalments" current period tab, user can use "Add Membership" and "Add Other Amount" buttons to add line items to the current order.
2. Once the "Add Other Amount" is clicked, a new row should appear in current period tab with the following information:
   1. Item - required - a text box
   2. Start date - required - a datepicker default to today's date.
   3. End date - text "N/A"
   4. Renew automatically - a checkbox checked by default, only show if the recurring contribution has auto-renew enabled.
   5. Financial type - select list with all available financial types
   6. Tax - text showing the tax percentage of the selected financial type, show N/A if there is no tax account in the selected financial type
   7. Amount - required - a money input box
   8. cross icon - cancel action
   9. check icon - confirm action
3. When a row is added but not yet confirmed/ cancelled, any parts of the modal popup other then the row itself should be made unclickable. If the user tries to click on any other parts, the row should flash to remind the user an item is yet to be completed.
4. If user clicked on cross icon, the row should be cancelled and no change is made.
5. When user clicked on the check icon, if there is no "Pending" instalment contribution with "Received Date" equals to or after the today/ start date (whichever is later), a notice with warning sign should appear with text "There are no instalments left for this period. Suggest to follow the steps below:
   1. Add the the item to the next period.
   2. (optional) Create the membership or a one-off contribution outside the recurring order."
6.  When user clicked on the check icon, if there are "Pending" instalment contributions with "Received Date" equals to or after the today/ start date (whichever is later), a dialog with title "Add LINE_ITEM_LABEL ?" should appear with the following components:
   1. dialog body text - "Please note the changes should take effect immediately after "Apply"."
   2. a "Adjust the amount of the first instalment" checkbox option.
   3. a "First instalment amount" money text input. Defaults to the instalment amount. This is only revealed when "Adjust the amount of the first instalment" checkbox is ticked.
   4. Cancel button
   5. Apply button
7. If user click on "Apply" button:
   1. a line item with empty contribution_id should be created according to the information user inputted. Note that the tax_amount will calculated by multiplying amount with tax rate.
   2. a membershipextras_subscription_line should be created linking the line item and the recurring contribution. It's start date should be the selected start date and it's end date should be empty.
   3. for any "Pending" instalment contribution with "Received Date" equals to or after the today/ start date (whichever is later), a copy of the line_item should be added. Contribution amounts should be adjusted. If "Adjust the amount of the first instalment" is checked, the first  "Pending" instalment contribution should apply "First instalment amount".
   4. if auto_renew is checked, the auto_renew in membershipextras_subscription_line for the corresponding item should set to TRUE. Otherwise FALSE.
   5. a notice should appear with text "LINE_ITEM_LABEL has been added to the active order."
   6. if auto-renew is selected, a notice should appear with text "LINE_ITEM_LABEL will now be continued in the next period."
   7. the content of "Manage Instalments" modal should be reloaded.
8. If user clicked on "Cancel", the action should be cancelled and no change is made.

1. In the "View/Modify Future Instalments" next period tab, user can use "Add Membership" and "Add Other Amount" buttons to add line items to the current order.
2. Once the "Add Membership" is clicked, a new row should appear in next period tab with the following information:
   1. Item - required - a dropdown contains all membership types which are not belong to any of the membership organisation for the existing lines
   2. Financial type - text showing the financial type of the selected membership
   3. Tax - text showing the tax percentage of the financial type, show N/A if there is no tax account in the financial type
   4. Amount - required - a money input box defaulted to the minimum_fee of the membership type divided by number_of_instalments.
   5. cross icon - cancel action
   6. check icon - confirm action
3. When a row is added but not yet confirmed/ cancelled, any parts of the modal popup other then the row itself should be made unclickable. If the user tries to click on any other parts, the row should flash to remind the user an item is yet to be completed.
4. If user clicked on cross icon, the row should be cancelled and no change is made.
5. When user clicked on the check icon, a dialog with title "Add LINE_ITEM_LABEL ?" should appear with the following components:
   1. dialog body text - "Please note the changes should take effect immediately after "Apply"."
   2. Cancel button
   3. Apply button
6. If user click on "Apply" button:
   
   1. a line item with empty contribution_id should be created according to the information user inputted. Note that the tax_amount will calculated by multiplying amount with tax rate.
   2. a membershipextras_subscription_line should be created linking the line item and the recurring contribution. It's start date and end date should be empty.
   3. a notice should appear with text "LINE_ITEM_LABEL will now be continued in the next period."
   4. the content of "Manage Instalments" modal should be reloaded.
7. If user clicked on "Cancel", the action should be cancelled and no change is made.
8. User can also check "Renew automatically" field for any of membership lines in "Current period" tab to perform the same action. A notice with warning sign will appear with text "This membership type is already enrolled in next period." when there is another membershipextras_subscription_line:
   1. linked to a line item with same membership type and membershipextras_subscription_line
   2. end date is empty
   3. auto-renew is TRUE
9. If user checks the "Renew automatically" field for any of membership lines in "Current period" tab and the scenario in point 8 does not apply, point 5-7 should apply here.

1. In the "View/Modify Future Instalments" next period tab, user can use "Add Membership" and "Add Other Amount" buttons to add line items to the current order.
2. Once the "Add Other Amount" is clicked, a new row should appear in next period tab with the following information:
   1. Item - required - a text box
   2. Financial type - select list with all available financial types
   3. Tax - text showing the tax percentage of the selected financial type, show N/A if there is no tax account in the selected financial type
   4. Amount - required - a money input box
   5. cross icon - cancel action
   6. check icon - confirm action
3. When a row is added but not yet confirmed/ cancelled, any parts of the modal popup other then the row itself should be made unclickable. If the user tries to click on any other parts, the row should flash to remind the user an item is yet to be completed.
4. If user clicked on cross icon, the row should be cancelled and no change is made.
5. When user clicked on the check icon, a dialog with title "Add LINE_ITEM_LABEL ?" should appear with the following components:
   1. dialog body text - "Please note the changes should take effect immediately after "Apply"."
   2. Cancel button
   3. Apply button
6. If user click on "Apply" button:
   1. a line item with empty contribution_id should be created according to the information user inputted. Note that the tax_amount will calculated by multiplying amount with tax rate.
   2. a membershipextras_subscription_line should be created linking the line item and the recurring contribution. It's start date and end date should be empty.
   3. a notice should appear with text "LINE_ITEM_LABEL will now be continued in the next period."
   4. the content of "Manage Instalments" modal should be reloaded.
7. If user clicked on "Cancel", the action should be cancelled and no change is made.
8. User can also check "Renew automatically" field for any of other amount lines in "Current period" tab to perform the same action. Point 5-7 also apply here.

1. When a payment plan is marked as completed, all lines that meet the below conditions should have their end date set to the payment plan end date:
   1. start date is not empty
   2. end date is empty

Part 1:

1. As a part of phase 3 upgrader, the extension should find all pre-existing offline payment plans and populate the "Offline Recurring Contribution Line Item" information for them.
2. For each pre-existing recurring contribution using an offline payment processor (payment processor with Payment Manual class):
   1. create a copy of each line item of the last instalment contribution
   2. the contribution_id of the copied line items should NULL
   3. a record should be created in "membershipextras_subscription_line" table for each of the copied line item:
      1. contribution_recur_id - the id of the recurring contribution
      2. line_item_id - the id of the copied line item
      3. start_date - start date of the recurring contribution
      4. end_date - end date of the recurring contribution. If empty, leave empty.
      5. auto_renew - true if the recurring contribution auto-renews, otherwise false
      6. is_removed - False

Part 2:

1. As a part of phase 3 upgrader, the extension should find all pre-existing payment plans that meet the criteria below and populate the "Related Payment Plan Periods" for them.
   1. payment plan that uses an offline payment processor (payment processor with Payment Manual class)
   2. payment plan whose number of instalment is larger than 0
   3. payment plan whose end date is not empty and is more a month earlier than toady
   4. payment plans whose auto-renew is set to True
   5. the contact has more than one payment plans that meet criteria a, b and c
2. Find all memberships that are linked to payment plan that meets the criteria. Fill in the  "Previous Payment Plan Period" and "Next Payment Plan Period" with number 0.
3. This needs to be part of the installer too.

(ON HOLD) Part 3:

1. As a part of phase 3 upgrader, the extension should find all pre-existing payment plans that meet the criteria below and populate the "Related Payment Plan Periods" for them.
   1. any payment plans that use an offline payment processor (payment processor with Payment Manual class)
   2. any payment plan whose number of instalment is larger than 0
   3. any payment plans whose auto-renew is set to True
   4. the contact has more than one payment plans that meet criteria a, b and c
2. Find all memberships that are linked to payment plan that meets the criteria. If two payment plans are linked to the same membership, fill in the "Previous Payment Plan Period" and "Next Payment Plan Period" with the ID of the payment plans according to payment plan start dates.

Note: we probably don't need to populate any records on installation of the extension since there should not be any offline payment plans without using the extension. If there is, it is probably not created by our extension, so it is probably safe to not populate records for them.

1. When "Renew offline auto-renewal memberships" scheduled job is run, it finds and processes any recurring contribution that meets all following conditions:

   1. it is using an offline payment processor (payment manual class)

   2. has an end date

   3. it is set to auto-renew

   4. it is not in status cancelled

   5. number of instalments is not 0 or null
   6. it's "Next Payment Plan Period" is empty

   7. has any linked membership that meets the following conditions:

      1. end date is equal to or smaller than today

      2. the membership's type matches with any "membershipextras_subscription_line" that is auto-renew and not is_removed
2. if the job finds any payment plan that meets the conditions in point 1:
   1. a new recurring contribution should be created using the existing recurring contribution as a template (unchanged from phase 2)
      1. The "Next Payment Plan Period" of the template recurring contribution should be filled with the id of the new recurring contribution
      2. The "Previous Payment Plan Period" of the new recurring contribution should be filled with the id of the template recurring contribution
   2. for each membershipextras_subscription_line which is auto-renew and not is_removed in the template recurring contribution:
      1. make a copy of the linked line item and link it to the new recurring contribution
      2. make a copy of the membershipextras_subscription_line and link it to the new recurring contribution. The copied membershipextras_subscription_line should have same start date as the recurring contribution and empty end date.
   3. use the last instalment as a template to create the instalments for the new recurring contribution:
      1. All information excepts the amount fields and line items should be generated the same way they are being generated in phase 2
      2. Each instalments should contain a copy of the auto-renew line items linked to the membershipextras_subscription_line
      3. the amount fields should reflect the actual amount based on the line items
   4. for each membership line items:
      1. if the user already have a membership with same type, extend that membership for a term
      2. if the user do not have any membership with same type, a new membership need to be created with start date of the recurring contribution start date.

1. When "Renew offline auto-renewal memberships" scheduled job is run, it finds and processes any recurring contribution that meets all following conditions:

   1. it is using an offline payment processor (payment manual class)

   2. has an end date

   3. it is set to auto-renew

   4. it is not in status cancelled

   5. number of instalments is 0 or null

   6. has any linked membership that meets the following conditions:

      1. end date is equal to or smaller than today

      2. the membership's type matches with any "membershipextras_subscription_line" that is auto-renew and not is_removed
2. if the job finds any payment plan that meets the conditions in point 1:
   1. for each membershipextras_subscription_line which is auto-renew and not is_removed in the recurring contribution: 
      1. make a copy of the linked line item and link it to the recurring contribution
      2. make a copy of the membershipextras_subscription_line and link it to the recurring contribution. The start date of the copied membershipextras_subscription_line should be the received date of the last instalment plus one interval. the end date should be empty.
      3. the end date of the original membershipextras_subscription_line should be 1 day earlier than the new membershipextras_subscription_line's start date.
   2. use the last instalment as a template to create a new pending instalment contribution under the same recurring contribution:
      1. All information excepts the amount fields and line items should be generated the same way they are being generated in phase 2
      2. Each instalments should contain a copy of the auto-renew line items linked to the membershipextras_subscription_line
      3. the amount fields should reflect the actual amount based on the line items
   3. for each membership line items:
      1. if the user already have a membership with same type, extend that membership for a term
      2. if the user do not have any membership with same type, a new membership need to be created with start date of the recurring contribution start date.