update_acct_plan_multi_m Use Cases
Overview
Based on your business requirements, you may need to assign plans with various combinations of your chosen start dates, billing dates, and invoicing options.
When you use the update_acct_plan_multi_m API to assign a master plan and supplemental plans at the same time with the date inputs mentioned below, you will achieve the results described in the following use cases:
Note: For each use case described below in which the initial invoice is prorated, all future invoices will be for the full billing cycle unless you specify otherwise.
You passed in your chosen start date(s):
Use Case 1:
Date input(s): <retroactive_start_date>
Plan start date: Based on the <retroactive_start_date>
Bill day: Based on the <retroactive_start_date>
Invoicing: If you set <combine_invoices> to 2-Do Not Combine Invoices (short cycle), Aria will invoice for one billing cycle. If you set <combined_invoices> to 1-Combine Invoices (long cycle) and the <retroactive_start_date> goes back more than one billing cycle, Aria will generate a combined invoice. Regardless of whether you set <invoicing_option> to 1 (Perform full invoicing) or 2 (Perform Prorated invoicing), you will achieve the same results.
Use Case 2:
Date input(s): <alt_start_date>
Plan start date: Based on the <alt_start_date>
Bill day: Based on the <alt_start_date>
Invoicing: If you set <invoicing_option> to 2 (Perform Prorated invoicing), all plans will be prorated up to the <alt_start_date>. If you set <invoicing_option> to 1 (Perform full invoicing), the plans will not be prorated up to the <alt_start_date>. Instead, Aria will set all plans to a status of 32 (registered pending activation) until the <alt_start_date>. On the <alt_start_date>, Aria would set the status to active (1) and start invoicing for the plans. If the number of negative lag days requires invoicing into the future for more than one billing cycle, then Aria will generate a combined invoice regardless of your <combine_invoices> setting.
Use Case 3:
Date input(s): <effective_date>
Plan start date: Based on the <effective_date>
Bill day: Based on the <effective_date>
Invoicing: Regardless of whether you set <invoicing_option> to 1 (Perform full invoicing) or 2 (Perform Prorated invoicing), Aria will set all plans to the status of 32 (registered pending activation). On the <effective_date>, Aria would set the status to active (1) and start invoicing for the plans.
Use Case 4:
Date input(s): <retroactive_start_date> and <alt_start_date>
- If you set <invoicing_option> to 2 (Perform Prorated invoicing):
Bill day: Based on the <alt_start_date>
Invoicing: Aria will prorate charges from the <retroactive_start_date> to the <alt_start_date>. The period between <retroactive_start_date> and <alt_start_date> should do not cover more than one billing cycle. Therefore, setting <combined_invoices> to 1-Combine Invoices (long cycle) has the same effect as setting it to 2-Do Not Combine Invoices (short cycle).
- If you set <invoicing_option> to 1 (Perform full invoicing):
Bill day: Based on the <retroactive_start_date>. <alt_start_date> is ignored.
Invoicing: If the number of negative lag days requires invoicing into the future for more than one billing cycle, then Aria will generate a combined invoice, regardless of your <combine_invoices> setting.
Use Case 5:
Date input(s): master plan has a <retroactive_start_date>, any selected (not mandatory) supplemental plan(s) have an <alt_proration_start_date>
Plan start date: For the master plan and any mandatory supplemental plans, it is based on the <retroactive_start_date>. For the selected supplemental plan(s), it is based on the <alt_proration_start_date>.
Bill day: For the master plan and any mandatory supplemental plans, it is based on the <retroactive_start_date>. For the selected supplemental plan(s), it is based on the <alt_proration_start_date>.
Invoicing: Aria will invoice from the <retroactive_start_date> for master and mandatory supplemental plans. Aria will invoice the selected supplemental plan(s) from the <alt_proration_start_date>.
You passed in your chosen billing date:
Use Case 6:
Date input(s): <alt_bill_day>
Bill day: Based on the <alt_bill_day>
Invoicing: If you set <invoicing_option> to 2 (Perform Prorated invoicing), then Aria will generate an invoice that is prorated up to the next available bill day. If you set <invoicing_option> to 1 (Perform full invoicing), Aria will set all plans to a status of 32 (registered pending activation). Then on the next available bill day, Aria would set the status to active (1) and start invoicing for the plans.
If the number of negative lag days requires invoicing into the future for more than one billing cycle, then Aria will generate a combined invoice regardless of your <combine_invoices> setting.
Use Case 7:
Date input(s): <override_bill_thru_date>
Bill day: Based on the <override_bill_thru_date>
Invoicing: Aria will be able to generate only a prorated invoice. All charges will be prorated from the API run date to the <override_bill_thru_date>. For any supplemental plans whose recurring billing interval is shorter than the master plan's, Aria will backtrack the <override_bill_thru_date> based on the duration of the supplemental plans' recurring billing intervals. If the number of negative lag days requires invoicing into the future for more than one billing cycle, then Aria will generate a combined invoice regardless of your <combine_invoices> setting.
You passed in your chosen start date and billing date:
Use Case 8:
Date input(s): <retroactive_start_date> and <alt_bill_day>
- If you set <invoicing_option> to 2 (Perform Prorated invoicing):
Bill day: Based on the <alt_bill_day>
Invoicing: Aria will prorate the charges on the generated invoice for all plans from the <retroactive_start_date> to the <alt_bill_day>. Regardless of your <combine_invoices> setting, the same results will be achieved.
- If you set <invoicing_option> to 1 (Perform full invoicing):
Bill day: Based on the <retroactive_start_date>
Invoicing: Aria will not generate an invoice. Aria will put all plans in the status of 32 (registered pending activation). On the <alt_bill_day>, Aria would set the status to active (1) and start invoicing for the plans. Regardless of your <combine_invoices> setting, the same results will be achieved.
Use Case 9:
Date input(s): <retroactive_start_date> and <override_bill_thru_date>
Bill day: Set to the <override_bill_thru_date> (+1 day).
Invoicing: Aria will generate only a prorated invoice because <override_bill_thru_date> does not allow for full invoicing. Regardless of whether you set the <override_bill_thru_date> to a past or future date, Aria will prorate charges for all plans from the <retroactive_start_date> to the <override_bill_thru_date>.
Use Case 10:
Date input(s): <alt_start_date> and <override_bill_thru_date>
Bill day: Based on the <override_bill_thru_date>
Invoicing: Aria will not generate an invoice. Aria will put all plans in the inactive (0) status. Then on the <alt_start_date>, Aria would set the status to active (1) and start invoicing for the plans. The first invoice will be prorated up to the <override_bill_thru_date>. If the number of negative lag days requires invoicing into the future for more than one billing cycle, then the first invoice will be a combined invoice regardless of your <combine_invoices> setting. For any supplemental plans whose recurring billing interval is shorter than the master plan's, Aria will backtrack the <override_bill_thru_date> based on the:
- duration of the supplemental plans' recurring billing intervals; and
- the <alt_start_date>.
Use Case 11:
Date input(s): <effective_date> and <override_bill_thru_date>
Bill day: Based on the <override_bill_thru_date>
Invoicing: Aria will generate only a prorated invoice. Aria will put all plans in the status of 32 (registered pending activation). Then on the <effective_date>, Aria would set the status to active (1) and start invoicing for the plans. For any supplemental plans whose recurring billing interval is shorter than the master plan's, Aria will backtrack the <override_bill_thru_date> based on the:
- duration of the supplemental plans' recurring billing intervals; and
- the <effective_date>.