Nue Knowledge Center

Nue Docs navigation

search
clear
/

Multiple Credit Pools

Multiple Credit Pools

"Multiple Credit Pools" is designed to cater to consumption-based revenue models. If you have a suite of consumption-based products like APIs, Webhook Events, Computing Minutes, and Cloud Storage, etc, with this feature, your customers can have the flexibility to prepay in either credits or cash, held within each dedicated "Credit Pool" for different types of consumption.

 

For each unique type of consumption or usage, your can create a dedicated credit pool.  If you are doing business in multiple currencies, they can create one or more for each currency. It's a game-changer for businesses seeking versatile payment solutions in the dynamic world of consumption-based pricing.

 

This article requires you to have a general understanding of the Credit Burndown Usage Model.

 


 

Enable Multiple Credit Pools

Nue provides two types of credit: Credit and Cash. You can enable either or both of them. The system will generate a default credit pool for each credit type that is enabled.

 

Multiple Credit Pools Setting.jpg

 

You can create multiple credit pools if you need different credit pools for each customer for different purposes:

  • Go to Nue System Settings > Billing Schedules > Credit Burn-down
  • Click the + icon next to the default credit pool
  • On the credit pool creation page, select a credit type and set a name for the newly created credit pool
  • The newly created credit pool will be set as the system default credit pool after it is created
  • You can also rename the credit pool on the edit page by clicking the edit icon
  • For credit pools not being used, clicking the - icon will allow you to delete them

New Credit Pool.jpg

 

Scenarios

Now let's take a look at a scenario on how a customer can use multiple credit pools to track the expenses for the different subscriptions they purchased.

 

EXAMPLE

 

VROOM Inc., our fictional company, offers a Vroom Credit Package product.  Each credit in this package is priced at $2.  Customers can get the credits by purchasing the package and utilize their credits for different purchases, such as API Calls, Transcript Storage, and CPU Computing Minutes.

 

VROOM also offers another Vroom Event Package product that will top up the cash amount to the customers' accounts, and then can be used to pay for the Revenue Stream Event every time the customers generate a revenue stream report.

 

Enable Credit Types

To accomplish the above requirements, the administrator needs to enable credit types for both Credit and Cash:

  • Navigate to Nue System Setting → Credits, and check both Credit and Cash for the Credit Type option. A default credit pool will be generated for each of the credit types automatically. 
  • Rename the default credit pools to meaningful names based on your business requirements, in this example, let's call them 'Credit Account' and 'Cash Account'.  You can also use names such as 'Points', 'Events', etc.

Rename Credit Pools.jpg

 

Configure Products

Let's create the following products: 

PRODUCT NAMEREVENUE MODELLIST PRICECREDIT POOLCREDIT CONVERSION
VROOM Credit PackageCredit Burndown$2 Credit/YearCredit AccountN/A
API CallsOverage Usage$0.02 per CallCredit Account

100 Calls = 1 Credit

 

NOTE: Credit Conversion is required for credit-type pools only.

VROOM Cash PackageCredit Burndown$200 Each/MonthCash AccountN/A
Revenue Stream EventOverage Usage$0.1 per EventCash AccountN/A

 

For simplicity, we will only create one Overage Usage product per credit pool, so only one usage product will be consuming the credits in the credit pool.  However, you can create more than one usage products to consume credits or cash from one credit pool.  

 

To associate the Credit Pool for each product, please follow the steps below: 

  • Navigate to Price Builder → Product Catalog, and click the Edit action icon of the product
  • On the product edit page, specify a Credit Pool for each product:
    • The 'VROOM Credit Package' issues credits to the customers while 'API Calls' consumes credits based on the usage, so set the credit pool to 'Credit Account'.
    • The 'VROOM Cash Package' is to top up the balance of the customer's cash account and the customer can pay the 'Revenue Stream Event' by the account directly, so the associated credit pool for these two products will be 'Cash Account'.
  • Configure the Credit Conversion for the usage product that consumes Credit type of credits (see how to configure the Credit Conversion here). For example, the 'API Calls' will consume the credits based on the number of calls made, so you need to set the conversion rate between the number of API calls and the amount of credits consumed accordingly. For the 'Revenue Stream Event', since it will get paid directly from the cash account, then the credit conversion won't be needed.

Configure Product Credit Pool.jpg

 

NOTE

 

  • For a 'Credit Burndown' type product, you must specify a credit pool for it, since a customer could have multiple credit pools for different purposes, this will determine where the credits will be issued when they purchase the product. 
  • For any 'Overage Usage' type products, assign a credit pool if they need to consume credits or cash from the customer's credit balance. If a usage product doesn't have a credit pool configured, it will be rated by dollar amount and billed through the invoices generated by billing schedules.

 

Create Order and Subscriptions

Now the sales reps can place orders for the customers to purchase the credits and top up their accounts. Let's create an order for the customer 'Ruby Cloud'.

 

In the Line Editor, search for the products, and drag them to the line editor. In this example, let's add and configure the quantities as shown below. The customer purchases 1000 credits and top up their cash account for $200/Month, and they also subscribe to the API Calls and Revenue Stream Event services. 

 

Order Line Editor.jpg

 

After activating the order, the credit burndown and usage subscriptions are generated. Navigate to the lifecycle manager of the customer 'Ruby Cloud', under the 'Credit' tab, you can see the details of the credits and credit flows. Since the customer has purchased both credit burndown subscriptions, there will be two credit pools displayed: Credit Account and Cash Account. You can switch the credit pool and check the credit flows for each of them.  In this example, there are 1000 credits issued to the Credit Account and $200 topped up to the Cash Account every month.

 

Credit Account.jpg

 

Cash Account.jpg

 

You can see see credit burndown and usage subscriptions of this customer under the Subscription tab:

Subscriptions.jpg

Consume Credits from Different Credit Pools

 

Now let's ingest some raw usage for API Calls and Revenue Stream Event subscriptions. 

 

You can do this by uploading the usage for each subscription separately or together, depending on your business operations. In this example, let's ingest the following raw usage:

 

SubscriptionSubscription NumberQuantityTimestamp
API CallsSUB-0000091002023-09-01T09:00:06.000Z
API CallsSUB-0000091502023-09-02T09:00:06.000Z
Revenue Stream EventSUB-000010202023-09-05T09:00:06.000Z
Revenue Stream EventSUB-000010302023-09-12T09:00:06.000Z

 

After the raw usage is uploaded, they will be rated immediately.  You can see the status in the usage list for each usage.  If you enable both credit types, Credit and Cash, you will see a switch on the top left corner of the usage list page.  This switch allows you to view the usage chart and usage records for different credit types.

 

Let's switch to Credit first.  You can see there are two usage records of subscription API Calls that get rated:

  • The first one with 100 quantities is rated to 1 Credit (Rated Amount) since the credit conversion rate is set as 100 Calls consume 1 Credit in the product, and it consumes 1 Credit (Applied Amount) from the customer's Credit Account directly.
  • For the second usage record with 150 quantities, you will see the Rated Amount is 2 rather than 1.5, this is because when setting up the credit conversion for the product API Calls, we set the Decimal Scale to 0, and Rounding Mode to Up, so 1.5 will be rounded up to 2. You can adjust these settings of credit conversion according to your business requirements. The rated credits are deducted from the customer's Credit Account immediately.

 

Rated Usage for Credit.jpg

 

When you switch to the Cash list, you can see the rated cash amount for the usage of 'Revenue Stream Event' subscription:

  • These usage are rated based on cash amount since the product is a cash-based usage product and associated with a Cash credit pool
  • The Rated Amount for these usage records is a dollar amount, the amount 2 indicates $2 in this case
  • You can also see the numbers in the Applied Credit column, which indicates the rated dollar amount is deducted from the customer's Cash account directly

 

Rated Usage for Cash.jpg

 

Now if you navigate to the lifecycle manager of the customer, under the Credit tab, you will see the Credit Outflows in each credit pool, consuming the credit or cash amount accordingly

 

Consumed Credits.jpg

 

Consumed Cash.jpg

Advanced Scenarios

 

Credit Pools for Different Billing Accounts

Enabling the Billing Account Hierarchy allows customers to track budgets and expenses for different departments, sales regions, or financial processes. By associating different billing accounts with different subscriptions, credit pools will be generated for each billing account. On the customer lifecycle page, users can view the credit flows for each credit pool under different billing accounts.

 

Credit Pools for Different Billing Accounts.jpg

 

Credit Pools for Different Currencies

Enabling multiple currencies in the system will sort cash-type credits into different categories based on their respective currencies. As a result, separate credit pools will be generated for each currency. On the customer lifecycle page, users will be able to see credit flows for each credit pool in different currencies.

 

Credit Pools for Different Currencies.jpg

Putting it Altogether

With Multiple Credit Pools, you can effectively manage a diverse suite of consumption-based products and services. This feature helps you to:

  • Create different credit pools for each specific type of consumption or usage, whether they are credit-based or cash-based. You can customize pool names to align with your business requirements.

  • Create and manage products using Credit Burndown, Credit, or Overage Usage revenue models, associating them with designated credit pools.

  • In the case of Credit Burndown products, when orders containing them are activated, the order amount is added to the assigned credit pool, generating a Credit Inflow.

  • For Overage Usage products, as usage is processed and rated, the corresponding amount is deducted from the designated credit pool, leading to a Credit Outflow.

  • You may have Multiple Credit Burndown products to contribute to a single credit pool and have multiple Overage Usage products to draw from a shared credit pool.

  • Easily access credit statistics, credit inflows, and credit outflows for all available credit pools through the Credits tab within the Lifecycle Manager.

This feature provides a comprehensive solution for managing diverse consumption-based products and their associated financial transactions efficiently and transparently.