Credit Burndown Usage Model

the credit burndown, also known as prepaid and rollover, or prepay and drawdown, is a usage pricing model that allows customers to purchase a specific amount of credits upfront, which can be either in the form of credit tokens or cash these credits are then gradually burned down over time as customers consume various products or services credit burndown pricing models can be useful for businesses that sell digital goods or services that can be consumed in a specific period of time it can also be useful for businesses that want to encourage customers to purchase more frequently or in larger quantities by implementing the credit burndown model, customers have the flexibility to allocate their credits across multiple products or services, depending on their specific needs this pricing model allows for efficient resource management, as customers only pay for what they consume and have the ability to track their credit usage in real time how credit burndown works to implement a credit burndown usage model, we will need 2 different types of products type 1 product(s) that accumulates credits this type of products are designed for customers to add credits to a credit pool in nue, you can create a product with revenue model "credit burndown" this type of product typically has billing timing bill in advance so that the credits are prepaid type 2 product(s) that consumes credits this type of products are designed for customers to consume credits from a credit pool in nue, you can create a product with revenue model "overage usage" the usage of this type of products, once uploaded and rated, will be converted to credits and deducted from the credit pool this type of product typically has billing timing bill in arrears so that the overage usage (i e , usage over the credit limits) will be billed at the end of the billing period the following diagram illustrates this flow in summary products with revenue model "credit burndown" can be ordered to accumulate credits into the customer's credit pool when the order containing such products is activated, the credit purchased will be added to the credit pool with a credit inflow transaction the order containing such products will be billed in advance (typically) products with revenue model "overage usage" can be used to consume credits from the customer's credit pool when the usage is uploaded and rated as credits, the credit purchased will be deducted from the credit pool with a credit outflow transaction if all credits in the credit pool are consumed, the overage usage amount will be billed in arrears note in a system, there can be more than one credit burndown products that accumulate credits, and more than one overage usage products that consume credits all transactions are being processed through the credit pool and are recorded as credit inflow and credit outflow enable credit burndown permissions required the following permissions are required in the user role billing schedule manage credits credit type and credit pool admin users can enable the credit burndown feature by configuring the following settings login to nue app https //app nue io and navigate to settings → credits set the default credit type credit type indicates the type of credit your organization issues to your customers there are 2 supported credit types credit and cash the credit type determines whether the credit pool stores credits, or cash set the default credit pool credit pool contains credits issued to the customer each customer may have one or more credit pool the default credit pool is used to store credits if no specific pool is specified credit options admin users can also configure additional credit burndown options credit name admin users can rename the credits, for example, points, files, minutes, etc click on the edit icon next to the credit type setting, and update the name in the popup rollover unused credits indicates if the unused credits will be rolled over to the next usage term rollover period the rollover period in month for example, a customer purchases 100 credits every month, and the unused credits will be rolled over to the next month admin users can set the rollover period to 1, so that the expiration date will be set to the end of next month enable credit proration for partial periods determines if the credits can be prorated in a partial period by default it is false, the credits can only be issued to full periods, otherwise, they can be prorated and issued to a partial period for more information about how credit proration works, please refer to credit proration docid\ mcd65qcdde5c5tn1s oh2 align credits with the subscription's bill cycle day determines if the credits are aligned with the subscription's bill cycle day by default it is false, and the credits are aligned with the subscription's start date enable credit tab in the lifecycle manager to enable credit table in the lifecycle manager, navigate to settings → customer lifecycle tabs, and enable credits credit burndown scenario now let's take a look at a scenario let's consider vroom inc , our fictional company offering the vroom sdk product each credit in this example is priced at $2 customers can utilize their credits for different purposes, such as api calls, transcript storage, and cpu computing minutes it's important to note that each of these products has a distinct burndown rate for the credits, indicating how quickly they are consumed the credits will be issued to or consumed from the default credit pool for these products, you can choose to use different credit pools for different products create products we plan to create the following products product name bundle or product revenue model list price credit pool credit conversion vroom sdk bundle credit burndown $2 credit/year default credit pool n/a api calls product overage usage $0 01 per call/month default credit pool 100 calls = 1 credit cpu computing product overage usage $0 1 minute/month default credit pool 10 minutes = 1 credit transcript storage product overage usage $1 gb/month default credit pool 10 gb = 1 credit to configure the credit conversion of each product, you can follow the steps below navigate to price builder → product catalog, and click edit action icon of the usage type product click + icon next to the credit conversion field, and specify the conversion equation, decimal scale, and rounding mode the decimal scale and rounding mode determines how the credits are converted for example, for transcript storage product, we configured the following credit conversion conversion equation 10 gb = 1 credit, decimal scale 1, rounding mode up if a customer consumes 13 23 gb, then it will be rated as 1 3 credit we configure vroom sdk as a bundle that contains all 3 of the usage products api calls, cpu computing, and transcript storage as required add ons please note that typically, we use a bundle product to associate the credit burndown product with the usage type products however, this is not a nessary step create quote and subscriptions as usual, we create a sales opportunity in nue on salesforce, and create a primary quote with start date 04/01/2023 note please use this start date in order to use the usage upload files in this tutorial if you choose other dates, when you upload raw usage files, or bill the subscriptions, you may also need to use your own dates in the line editor, we search for bundle product vroom sdk, and drag it to the line editor in the product configurator, i saw all 3 usage products in the line editor, i configure 1000 units (credits) for the vroom sdk line item in the line editor, the total price is $2000 because vroom sdk is priced at $2 credit/year all the usage type products have quantity 0 and total price 0 we can also add discount tags or discretional discounts to the quote if we want to give discounts for the credits if there is a need now we can close won the opportunity, which will finalize the primary quote into an activev order, and provision the subscriptions each line item will be provisioned into a subscription 3 usage type subscriptions will be grouped under the bundle subscription credit pool and credit inflow to see the credit pool, and credit inflow and outflows, you can follow the steps below login to salesforce and navigate to accounts click to open an account in the account details page, click manage customer lifecycle click credits tab in the credits tab, we can clearly see that 1000 credits have been issued and entered into the credit pool the credit balance is 1000 in the following screenshot, we can see that there is a credit inflow transaction with a transaction type issue created from credit burndown subscription (sub 0001357) the credit start date and credit end date determine when the credit can be used note if the credit burndown product has a uom term dimension month, then monthly credit inflows will be created if the subscription term is 12 month, then we will see 12 monthly credit inflows created these credits will have the start and end date aligned with the start and end date of the monthly term if the credit burndown subscription is evergreen, credits will only be generated up to the current term for instance, if the subscription term lasts 12 months and it began three months ago, only three credit flows will have been created so far at the end of each term, a new credit flow will be generated for the upcoming term invoice credits when the order is activated, the first invoice will be created for vroom sdk product, which has a credit burndown credit model, and bill in advance billing timing navigate to the lifecycle manager, and click on the invoices tab an invoice of $166 67 is created, containing an invoice line item for product vroom sdk with start date 04/01/2023, and end date 04/30/2023 usage and credit outflow now let's ingest some raw usage for all 3 the following usage products api calls, cpu computing and transcript storage all the raw usage records have timestamps between 04/01/2023 and 04/30/2023 we have created example csv files here https //drive google com/drive/folders/1tshljstxyuvg jkf gackyyayoe5xkkn?usp=sharing for you to download please follow the steps below login to salesforce, and navigate to the account ("sharp revenue" in this example) detail page click manage customer lifecycle button to enter the lifecycle manager copy the customer id as part of the url, for example, if the url is https //nueio lightning force com/lightning/cmp/ruby lifecyclemanager?c customerid=0015f00001zjym1aal https //nueio lightning force com/lightning/cmp/ruby lifecyclemanager?c customerid=0015f00001zjym1aal , the customer id is 0015f00001zjym1aal navigate to the subscriptions tab find vroom sdk, and click show details to show the children usage subscriptions download vroom api calls csv https //drive google com/file/d/1 lid 0du8xun2spmcsvo27yr8vtcwjqu/view?usp=share link file replace the customer id in the downloaded csv file with your own customer id for all usage rows copy the subscription number of the api calls subscription, for example, sub 001380 replace the subscription number in the download csv file with your own subscription number for all usage rows download vroom cpu usage csv https //drive google com/file/d/1capqrrpzh bvn7kv6g0r1jxum4wgpwrb/view?usp=share link file replace the customer id in the downloaded csv file with your own customer id for all usage rows copy the subscription number of the cpu computing subscription, for example, sub 001381 replace the subscription number in the download csv file with your own subscription number for all usage rows download vroom storage csv https //drive google com/file/d/1knx5najxsbfc fg3uxmbqsy41hndvovg/view?usp=share link file replace the customer id in the downloaded csv file with your own customer id for all usage rows copy the subscription number of the transcript storage subscription, for example, sub 001382 replace the subscription number in the download csv file with your own subscription number for all usage rows login to nue app, https //app nue io and search usage in the menu, and select to enter the usage page click 'upload' action icon on the upper right side of the usage list, and upload all 3 csv files one by one please note that even though we upload raw usage in 3 different csv files, you can mix them together into one csv file if you have a large number of raw usage to ingest, you should consider using post raw usage api https //api docs nue io/#post raw usage instead of using csv upload caution if you receive error "subscription {{subscriptionnumber}} is not found", there could be the following reasons the subscription does not exist for this customer please check if the subscription number in the usage record is correct the subscription with the subscription number does exist, but it is not one of the usage types supported by nue overage usage the subscription with the subscription number does exist, and it is of overage usage revenue model however, its uom does not have a term dimension we do require a term dimension of the uom associated to the overage usage revenue model the subscription with the subscription number does exist, but the usage's transaction timestamp is not within the start and end date of the subscription after the raw usage files are successfully uploaded, you can see the raw usage records already sliced by the configured window size (in our example, day) and merged into usage records the usage records have status open they will be picked up by nue's rating engine the following image shows that the usage records of api calls are rated, and the usage records of other products are still open after a few minutes, all usage records are rated usage records are rated into credits , not dollar amounts they are rated according to the credit conversion definition we have defined the conversion rates earlier api calls has a 1000 1 credit conversion with decimal scale 0 and rounding mode "up"; cpu computing has a 10 1 credit conversion with decimal scale 0 and rounding mode "up"; transcript storage has a 10 1 conversion with a decimal scale 1 and rounding mode "up" in the following image, we can see how quantities of each usage record is being rated into credits in the above image, we can also see that the usage statuese have been changed to billed this is because once a usage is rated into credits, the credit amount will be deducted immediately from the credit pool, which is recorded as a credit outflow transaction users can see the usage as well as the credit outflow transactions in the credits tab of the lifecycle manager in the above image, we can see that after we ingested all 3 csv files containing raw usage records, 953 5 credits are consumed, and 46 5 credits remain to be active assuming we discovered a batch of api calls raw usage occurred on 04/01/2023 that was missed in the last csv files so we want to upload another csv file containing 58,863 api calls this should be rated into additional 59 credits, which will result in a 12 5 (=59 46 5) overage credits download vroom api calls overage file https //drive google com/file/d/16lcybgbgqv7qqin1fnr2fswnsuvk41vf/view?usp=share link replace the customer id in the downloaded csv file with your own customer id for all usage rows copy the subscription number of the api calls subscription, for example, sub 001380 replace the subscription number in the download csv file with your own subscription number for all usage rows upload the updated csv file into nue after a few minutes, we can see that the usage of api calls on 04/01/2023 and all subsequent days is re aggregated and re rated, which results in the credits in the credit pool being credited back and consumed and all 1000 credits are now consumed ingesting raw usage records admin users can ingest new raw usage records after raw usage records on particular days have been aggregated and rated into usage records, or even after usage records are in billed status, i e , invoiced, or deducted from a credit pool invoice credit overage since the customer doesn't have sufficient credits for the last batch of usage consumption the customer has a 12 5 credit overage we can run a billing schedule to bill for the overage credits in arrears login to nue app https //app nue io , and navigate to revenue manager → billing schedules click 'new billing schedule', and create an on demand billing schedule with billing target date as 05/01/2023 for customer sharp revenue click save after the billing job completes, we can see a new invoice is generated with the following invoice line items in this invoice, vroom sdk is billed in advance for the 05/2023 biling cycle, and api calls is billed with $125 credits overage this is because there is 12 5 credit overage, and each credit is priced at $10 at the organization level both cpu computing and transcript storage do not have credit overage so the invoice amount is $0 additional notes in scenarios where users have insufficient credit balance during rating of uploaded usages, the rated credits will not be immediately deducted from the credit pool instead, the rated amount will be billed in the subsequent billing cycle however, if users purchase enough credits before the next billing cycle, they would prefer to utilize the credits rather than making an additional payment therefore, when credit burndown is enabled and a billing job is initiated, the following steps are taken for order products with usage data that will be billed if the rated amount of a usage record is not fully applied with credits (applied credit amount < rated credit amount), deduct the remaining amount if sufficient credit balance is available, and do not generate invoices if the credit balance is less than the remaining, unapplied amount, apply the entire available balance and generate invoices for the remaining rated, but unapplied amount after deducting the credit balance, generate the corresponding credit outflow transactions and update the applied amount of the usage accordingly note this process applies only to the rated amount of a usage product for order products with a non zero quantity and usage type, they will be billed through the regular billing cycle and will not consume credits in conclusion, this comprehensive tutorial has provided you with a thorough understanding of credit burndown within the nue usage accelerator we have guided you through the entire process, covering essential steps such as defining credits and products, creating quotes and subscriptions, managing usage ingestion, monitoring credit inflows and outflows, and creating invoices for overage credits however, our journey doesn't end here in future tutorials, we will delve into the topic of modifying credit burndown subscriptions, with and without prorations, empowering you with even more advanced techniques