Home > Tech Writers Hub > Knowledge Services Sandbox > Aria Crescendo APIs Bucket > Developer's Guide > USS Use Cases > Add a Master Plan on a Future Date

Add a Master Plan on a Future Date

Overview

You can add a plan (product) with a future activation date if:

  • you have a customer who wants service to start on a date after the current date (example: for financial convenience); or
  • you first need to complete processes such as these:
    • Install equipment; or
    • Screen/obtain confirmation from the customer.

Example: you have a customer who is subscribed to an internet plan who now wants to add a streaming plan.

In addition, as shown in the sample call below, you can provide the customer with a discounted rate (as an incentive) on the added subscription.

 

Sample Call

  1. Authenticate the customer logging into your user self-service (USS) application by calling the set_session_auth_m API.
  2. Call the get_acct_details_all_m API to obtain the customer's billing group information. 
  3. Call the get_client_plans_basic_m API to obtain the plan(s) that the customer can add and their available rate schedules.
  4. Call the assign_acct_plan_m API as follows:
  1. Pass in your client number and authorization key: 
    <lit:client_no>12345_sample_client_no</lit:client_no>
<lit:auth_key>AbCdEfG_sample_auth_key</lit:auth_key>
  2. Identify the customer who is adding a plan as shown below:

clipboard_e6c9d57d990b85cdb1e8ab7bb4243c443.png

  1. Identify the new plan to be assigned as shown below.

    Obtain the identifier of the new plan from the <plan_no> field returned by the get_client_plans_basic_m API.

clipboard_e021a2d83811201ec68e2d915b55b6ddc.png

  1. Identify the billing group to be associated with the new plan as shown below.

    This will ensure that payments for the new plan are made using the payment method associated with that billing group.

    Obtain the billing group identifier from the <billing_group_no> or <client_billing_group_id> field returned by the get_acct_details_all_m API.

 

Note: You may choose to associate the plan with:

  • an existing billing group if the customer wants to pay for the new plan with the same payment method; or
  • a different billing group, if the customer wants to pay for the new plan with another payment method.



clipboard_efe5d978d296c9ab4c7c33bb7378fdc89.png

  1. Specify the dunning group to be associated with the new plan as shown below.

    This will ensure that if the customer is behind on payments for this new plan, Aria will take actions on the account as you specified in the dunning process associated with that dunning group.

    Obtain the dunning group identifier from the <dunning_group_no> or <client_dunning_group_id> field returned by the get_acct_details_all_m API.

    clipboard_e175d7afeca474bd3663218f757032784.png
     
  2. If you want the customer to be billed on a day of the month other than the plan's <effective_date>, specify that chosen day as shown below.

Notes:

  • If you specify an <alt_bill_day>, then the customer will be billed on multiple days of the month if any existing subscriptions to other plan(s) are invoiced on a day different from the <alt_bill_day>.
  • If you do not specify an <alt_bill_day>, then Aria will use the <effective_date> to set the bill day.

    Example, if the <effective_date> is 22 February 2019, then Aria will set the 22nd as the bill day. Then, for a monthly plan, the customer would be billed from 22 February 2019 to 21 March 2019. After that the customer would be billed on the 22nd of every month.

clipboard_e28da06ad3a5be3b35e6d4d5c5ac6a18b.png

  1. If you are offering the customer a rate on the new plan assignment that is different from the default rate, specify which rate to apply as shown below:

    Obtain the identifier of the available rate schedules for the assigned plan from the <schedule_no> field returned by the get_client_plans_basic_m API.

    As an alternative, you may choose to assign a specific rate schedule only for that particular customer by passing values into the <custom_rates> array.

    clipboard_e01aba03c4baaed93b366cde9f062803e.png
  2. Identify the quantity of the new product that the customer wants to purchase as shown below:

clipboard_ef0177e5bef260e81de76ff8ecba74caf.png

  1. Specify the status that the new plan should be in as shown below:

clipboard_e7db3bfd02ec92c29f9c1949de7f7b628.png

  1. Specify when the new plan assignment should take place and which proration rule should be applied as shown below.

Notes:

  • If you are assigning a supplemental plan and you do not pass in an <assignment_directive>, then by default, the new plan will go into effect on the specified parent plan's anniversary date.
  • If you are assigning a master plan and you do not pass in an <assignment_directive>, then by default, the plan will go into effect on the plan assignment date (current date or your specified future date or retroactive date).
  • The proration rule that you specify will match or override your Invoicing Options On New Master Plan Assignment parameter (in the Aria application under Configuration > Billing > Invoice Settings).

 

clipboard_e2bf470ac3e71da7f5bd2b06a481d6a53.png

  1. Specify when the new plan should go into effect as shown below:

    clipboard_e5cb7785930faaad2171703e1f68c2c1e.png
 

Sample Response

You can check the customer's account in the Aria application to confirm that the plan addition was completed correctly as described in the use case above.

clipboard_e3fb3622de7c85f86c00cda1d958fdba4.png

 

Notes:

  • In this example:
    • The scheduled plan assignment will be listed in the Aria application under Accounts > search for the account > Plans > Future Plan Changes.
    • The plan will be placed in Pending Activation status until the specified <effective_date>, on which the status will be set to Active and the customer will start getting billed.
  • On the specified <effective_date>, Aria will create a prorated invoice for the new plan assignment. The invoice will cover the period from the <effective_date> (22 February 2019 in this example) to the plan's bill through date (day before the <alt_bill_day> in this example).

    Then the plan will be invoiced for a full billing period (monthly in this example) on the plan's anniversary date (<alt_bill_day> in this example).

    Example: If you made the plan assignment effective as of 22 February 2019 and the <alt_bill_day> is 2, then:
    • on the 22 February 2019, Aria will generate a prorated invoice covering 22 February 2019 (<effective_date>) to 1 March 2019 (day before the <alt_bill_day>);
    • after that, on the 2nd of every month, Aria will generate a full invoice covering a date range from the 2nd to the 1st of the month.

 

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®