User Self-Service Use Cases
This page provides developers with links to commonly used User Self-Service Use Cases.
- Add a Master Plan Immediately with a Queued Rate Change
- This article explains how to add a master plan to a customer's account immediately through the assign_acct_plan_m API. It shows how to assign an introductory rate that changes to a higher rate the following month.
- Add a Master Plan with a Future Start Date and an Alternate Bill Day
- This article explains how to add a plan with a future activation date and a custom bill day through the assign_acct_plan_m API. It shows how Aria prorates the first invoice to the alternate bill day, then bills the full period on that day going forward.
- Add a Master Plan with a Future Start Date and a Queued Rate Change
- This article explains how to add a master plan with a future activation date through the assign_acct_plan_m API. It shows that Aria bills the customer the rate in effect on the activation date, not the rate at the time of the request.
- Add a Master Plan with a Retroactive Start Date and an Alternate Bill Day
- This article explains how to add a plan with a retroactive start date and a custom bill day through the assign_acct_plan_m API. It shows how the chosen bill day, proration setting, and invoicing option interact to determine the customer's first and future invoices.
- Add a Master Plan with a Retroactive Start Date and a Queued Rate Change
- This article explains how to add a plan with a retroactive start date and a rate schedule change through the assign_acct_plan_m API. It shows that Aria charges the rate active on the account creation date for the first billing period, then applies the new rate once it takes effect.
- Add a Supplemental Plan on an Anniversary Date
- This article explains how to add a supplemental plan that activates on its master plan's next anniversary date through the assign_acct_plan_m API. It shows that the supplemental plan takes on the master plan's billing group, dunning group, and bill date.
- Add Multiple Plans Immediately with Different Billing Intervals
- This article explains how to assign a master plan and multiple supplemental plans with different billing intervals in one update_acct_plan_multi_m call. It shows how to align the new plans' anniversary date with an existing master plan and prorate the first invoice.
- Switch to a Different Master Plan
- This article explains how to replace a customer's current plan with a new plan through the replace_acct_plan_m API. It describes how the assignment timing and proration settings determine the resulting invoices, and notes that unassociated supplemental plans are canceled when the master plan changes.
- update_acct_plan_multi_m Walkthrough
- This article explains how the update_acct_plan_multi_m API lets you complete multiple plan changes in a single call. It covers best practices for ordering actions, handling proration, and avoiding conflicting plan directives.
- Update an Assigned Plan and Queue Rate Changes
- This article explains how to add more units of a currently-assigned plan through the update_acct_plan_m API. It shows how Aria prorates the first invoice to the plan's anniversary date, then bills the full period going forward.
- Update Billing Contact and Payment Information
- This article explains how to update a customer's billing contact and replace a payment method through the update_payment_method_m API. It describes how the new payment method attaches to the billing group previously linked to the disabled one.
- User Self-service Best Practices
- This article covers the prerequisites and best practices for building a user self-service application on Aria. It explains how rate schedule changes interact with plan assignments and recommends practices such as confirming changes before writing them.