Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Tech Writers Hub > Knowledge Services Sandbox > USS Use Cases > Update an Assigned Plan and Queue Rate Changes

Update an Assigned Plan and Queue Rate Changes

This article applies to:Aria Crescendo

Overview

In this use case, you have a customer who wants to add more subscriptions of a currently-assigned plan (product).

Example: a customer wants to add one more mobile phone line on a future date.

In addition, as shown in the sample call below, you can provide the customer with a discounted rate (as an incentive) on the total number of subscriptions purchased.

 

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 plan information. 
  3. Call the get_rate_schedules_for_plan_m API to obtain the available rate schedules for the assigned plan.
  4. Call the update_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 whose plan will be updated as shown below:

clipboard_e6c9d57d990b85cdb1e8ab7bb4243c443.png

  1. Identify which plan should be updated as shown below.

    Obtain the plan identifier of the assigned plan from the <master_plan_instance_no>/<client_master_plan_instance_id> field (for a master plan) or <supp_plan_instance_no>/<client_supp_plan_instance_id> field (for a supplemental plan) returned by the get_acct_details_all_m API.

clipboard_e4437c41c74cb84061b16746dd2524ca1.png

  1. If you are offering the customer a pre-existing rate on the updated 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_rate_schedules_for_plan_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

  1. Identify the total quantity of the product that the customer wants to purchase as shown below:

clipboard_ef41077c37e49808fc7a13e5d82610c75.png

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

Note: If you do not pass in an <assignment_directive>, then by default, the update will go into effect on the plan's next anniversary date. In addition, the plan will be invoiced for a full billing period and no proration will take place.

clipboard_e2bf470ac3e71da7f5bd2b06a481d6a53.png

  1. Specify when the plan update 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 update was completed correctly as described in the use case above.

clipboard_e2857a59390ffcc9e4867d4649eae21e8.png

 

Notes: On the specified <effective_date>, Aria will create a prorated invoice for the updated 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.

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

Example: If the plan's anniversary date is on the 15th of the month and you made the plan assignment effective as of 22 February 2019, then the customer will be billed as follows:

  • on the 22 February 2019, Aria will generate a prorated invoice covering 22 February 2019 (<effective_date>) to 14 March 2019 (the plan's bill through date);
  • after that, on the 15th of every month, Aria will generate a full invoice covering a date range from the 15th to the 14th.

 


Subtopics 

USS Best Practices

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.