Products

In Revenium, Products are bundles of Assets that are sold as a package to customers. Products have associated subscription terms and fees, overage rates, quotas, SLAs, and more attached to them.

Access to Products

  1. Search for the 'Products' link in the navigation menu.

  2. After clicking on the Products link, the Products dashboard appears (Figure 1).

Create a Product

  1. Click on the Products create button, located in the upper right corner (Figure 3).

  2. After clicking on the Products create button, the Products form appears (Figure 4a, Figure 4b, Figure 4c).

  3. Fill in the required inputs on each page and click on Save to create a new Product. Below is an explanation of the fields available during product creation.

Page One:

  • Product Name: used by front-end commerce portals to display the name of your product to end users

  • Product Version: allows you to keep a history of product changes by versioning new products as they are created. In order to properly synchronize products in Revenium with third party gateways, product versions must use the following format: x.x.x (i.e. 1.1.0, 1.0.0, 1.2.3)

  • Pricing Model: This allows you to choose from the supported pricing models. (explained here)

  • A Payment Configuration can be chosen to enable the Product to collect revenue using Stripe. More detail on creating these configurations is available here.

  • The Product Quota field defines a limit on the number of transactions to be enforced. Depending on the payment model chosen, the behavior of this field differs (either to absolutely block traffic once the quota is reached or to begin rating transactions at the overage rate once the quota is reached)

  • Default Quota Notification Threshold allows you to set a percentage of the maximum transactions when a notification will be sent to the configured e-mail addresses chosen in the Provider Notification Addresses field on page 2 of the product creation process. Note that end user notifications can be configured for each Product License that is created for a product.

    • For products using volume-based pricing, a notification will be sent when this percentage is reached for each tier in the plan. For example, if a volume-based plan had a 50% notification threshold set, and included tiers with prices that changed at volumes of 200, 500, and 1000 transactions, a notification would be sent at 100 calls, 250 calls, and 500 calls (50% of each volume tier limit).

  • Flat Rate Charge: Defines the amount (if any) that will be charged at the beginning of each settlement period.

Note that the elements configuration option below only exists if Metering Elements have been created prior to creating the product.

  • Define Charges for Metering Elements: Define the amounts to charge per distinct value observed during a settlement period (Figure 5). The metering engine will charge the end user the amount specified a maximum of once per period once the 'distinct value' is observed.

    • For example, if 1,000 API calls in a settlement period contained the region of "Singapore", and a single call was made containing the region of "Australia, a charge of 3000 and 5000 would be added to the invoice, one for each distinct value observed.

    • See Metering Elements for a more detailed explanation.

  • Allow immediate cancelations and pro-rated invoices? :

    • By default, product licenses that are deactivated will remain valid until the end of their existing settlement period. This means that customers with a monthly settlement period cancels a product license in the middle of the month, they will continue to have access to their products through the end of the settlement period and pay for the entire period.

    • However, if you select the 'allow immediate cancelations' option, as soon as an associated product license for this product is canceled, it will take effect immediately, and a pro-rated invoice will be created to charge only for the time of the subscription prior to cancelation.

  • Include free trial? If this option is selected, all product licenses created for this product will default to include a free trial period of the duration specified. Free trials automatically convert to the paid version of the product after the trial period expires if they are not canceled during the trial period.

  • Notify customer before end of trial? If this option selected, the owner of the product license will receive a notification 24-hours before the end of the trial period reminding them that their trial will automatically convert to paid if not canceled. If this option is not selected, the user will receive no notification before the product license converts to the paid version of the product.

  • One-time setup fee: If you enter an amount in this field, new subscribers will be charged a setup fee according to the options set below.

    • Charge setup fee per product license - If this option is chosen, every new product license that is created will charge the setup fee. If the same client subscribes more than once to a product, they will pay a setup fee each time.

    • Charge setup fee per client - If this option is chosen, every new client that signs up for the product will pay the setup fee. If the same client subscribes more than once to a product, they will only pay the setup one time.

    • Charge immediately - if this option is chosen, the customer must pay the setup fee before the product license is created.

    • Charge in first invoice (end of first settlement period) - under this option, the setup fee is sent in the first invoice at the end of a settlement period and no pre-payment is required.

  • Settlement period determines how often an invoice is generated for the Product. Note that the settlement period for a product cannot be changed after the product is created. Lastly, there are two options included for product testing that may not be completely intuitive, so they are explained further below:

    • 5 Minutes (no synthetic transactions) - for one hour, this will open and close a settlement period every 5 minutes for every active Product License under this product. This will generate customer notifications and invoices each five minutes so that you can test that everything is working as expected without waiting for actual settlement periods to close.

    • 5 Minutes (randomized synthetic transactions) - this option behaves identically to the previous option, but in addition, a randomized number of transactions will be simulated for assets included in the products throughout the one-hour period so you can check how charges are applied to randomized usage scenarios and ensure your product's payment model is configured as you intended.

  • Pricing Rules allow you to select a previously configured Pricing Rule that will apply for product licenses issued under this product.

Page Two:

  • APIM Provider: There are two options. The choice made here cannot be changed once the product is saved.

    • Create a linked gateway product: Select from a previously configured APIM provider. Using a linked gateway will allow API product owners to choose from Assets that have been synchronized from that gateway and allow for the automatic creation of products in a supported gateway once saved in Revenium.

    • Create an unlinked gateway product: in this case, the API product is manually created in a supported gateway and optionally linked using the "External ID" field that is explained below.

  • Gateway Environment: If you selected the linked gateway product above, then this field will allow you to choose which environment you wish to deploy your product (i.e. Staging vs. Production) after saving it in Revenium. (this cannot be changed once saved)

  • External ID: this field allows you to manually link this product to an external gateway so that it can be dynamically displayed in a supported commerce portal like Anypoint Community manager from MuleSoft. More information available here.

  • External Display Name: This field configures how a single instance of your product will be displayed to users in a commerce portal (i.e. if you have a hosted version of your product both in Europe & in the USA, you would define each here so that end users know which to select when purchasing & using your API products). This cannot be changed once saved.

  • Product Code: This field is used to map revenue from this product to integrated ERP systems. Enter your internal identifier here that is used to associate revenue appropriately within your financial system.

  • Assets: choose the assets that are bundled into this product. If you created a linked gateway product above, this list will automatically filter the correct assets from your gateway environment that are available for product bundling. If not, you can manually choose from any configured Assets in Revenium.

    • Note that when changing the assets included in a product linked to a gateway, you must also upgrade the version of the product to the next major version (i.e. from 1.3.2 to 2.x.x). This same product version will be applied in the gateway to avoid conflicts with previous versions.

  • Product Rate Limiting: This option is currently available in MuleSoft linked gateways only. This section allows you to define a traffic throughput limit as a part of the Revenium product.

    • Rate Limit Name: a name for the rate limiting policy that will be visible to end users during the checkout process. i.e. "Gold Policy"

    • Max # of Requests Per # of units of time (define as needed)

      • Example Configuration: 100 requests per 10 minutes

    • Rate Limit Description: This description is for internal purposes only to further describe this rate limiting policy.

  • SLA Definition: Allows you to choose a previously created SLA to associate with this product.

  • Provider Notification Address: The addresses configured here will receive all notifications related to the product (i.e. when new product licenses are issued, when invoices are issued, and when customer quotas are reached). This field is meant for API product owners or other API provider employees, not for end users. Note that end user notifications can be configured for each Product License that is created for a product.

  • Send Invoices from Revenium to Product License owners: By default, this option is selected. In general, only unselect this box if you are set up to provide your own invoicing based on usage data exported from Revenium.

  • Tags: define tags as are useful for your own use case.

Page Three

This page pertains to configuration options for products that will be exposed in a linked Commerce Portal.

The configurations in the expandable section below are only necessary if you are publishing products in a linked commerce portal. If this is not your use case, unlinked gateway products should be created (which is the default), you can ignore all of the optional configurations in this list.

Commerce Portal-Related Configurations:

  • Publish to Commerce Portal: If a linked commerce portal has been set up, setting this to Published will display the new Product in your public API Product catalog.

  • Product Audience: This filter is also used in linked commerce portals. The following options are available:

    • All Users: default behavior, the product is public and viewable by anyone

    • Named Consumers: if selected, only commerce portal users with a compatible, pre-configured Product License in Revenium will be able to view this product. Named consumers are matched either to the client owner of a product license or the array of Named Consumers on a product license. If the end user logged into the commerce portal matches either of these lists, a product configured for a named user audience will be visible to them, otherwise, it will not be visible.

    • Named Organizations: Named Organization audiences work the same was as Named Consumers in terms of requiring a compatible, pre-configured Product License, though the matching is done against an array of Organizations listed in the Product License. The match is done in two ways:

      • Commerce portal users who are a member of the Revenium Organization are allowed to access the product (emails are used to match between the commerce portal and Revenium's user record).

      • Commerce portal users whose e-mail domain matches a list of pre-configured domains set in the associated 'Named Organization' will be able to view and register for access to this product.

    • The terms & conditions fields on this page allow you to expose multiple required acceptance boxes when checking out to purchase a product (i.e. privacy agreement, contract terms, etc.). These will be automatically displayed during checkout in linked commerce portals.

    • The short, long, and pricing descriptions are shown in different places in linked commerce portals so that end users can see a brief summary in a catalog listing and full product details once they navigate to a specific product.

      • Note that if including images in these descriptions, you may have to make adjustments to your front end dev portal to trust the sites that are hosting these images. (particularly if using a salesforce front-end, this setting is required)

    • The custom pricing description option allows you to customize how pricing is presented for each product instead of using Revenium's default pricing template for presenting pricing.

Audience Filtering Example: using product audience filtering can be a bit complex. A complete example is provided below to help with implementation.

  • Sample implementation: This configuration would automatically allow all developers who are a member of the AcmeSoft, Inc. Revenium organization, or all developers with an email address from pre-approved domain(s) to access products without naming them individually.

    • AcmeSoft, Inc. is set up as an Organization in Revenium with a list of "associated domains" that includes acmesoft.com and acmesoft.inc. These are the two domains used by AcmeSoft for email and they want all internal users to have access automatically.

    • A new user is created in the AcmeSoft Organization in Revenium for a contractor they have hired who is from contractingcompany.com. This user also requires access to the product for testing purposes. Because he is a user in the Named Organization, he will be able to access the private product.

    • A new product is created with "Named Organization" selected for the product audience because it is meant to be seen only by users who work for AcmeSoft, Inc.

    • A new Product License is created with the named organization of AcmeSoft. This is the final link that will allow any members of AcmeSoft in Revenium, or outside users with a matching email domain to access the private product.

    • The images below step through this list of bullet points in sequential order

Create the Named Organization

Create a User in the Named Organization (optional)

Create a Product With "Named Organization" Audience

Create a Product License

  • Now when members of the named organization or users with matching email domains log into the linked commerce portal, they will be able to see the custom/private product and request credentials to utilize it. Users from other companies will not be able to see this product.

Pricing Models

The following payment models are supported for products. Additional, more complex pricing models are supported via the Pricing Rules page.

  • Analytics Only: choose this option if you are not charging for access to the APIs in this product, but still wish to track all of Revenium's product analytics for usage of the API(s) in this product. If you choose analytics only, the option to define pricing for the product will be removed, though you can still set quotas for usage of your product if you are using a gateway integration that supports this feature.

  • One Time Charge: The amount entered in the Fixed One-Time Cost field will be charged on purchase.

  • Transactional: Allows a rate to be charged per transaction. This rate is defined in the Rate charged per Transaction field and the total fees are charged at the end of each Settlement period.

  • Subscription: Allows the amount configured in the Recurring Subscription Fee to be charged per Settlement Period. This amount is charged at the end of each Settlement period.

  • Subscription + Overage: Allows a fixed amount to be charged per Settlement Period with an optional number of transactions included in the plan under the costs of the fixed charge. Transactions exceeding included transaction amount will be charged at a rate defined in the Overage rate per Transaction field. Both the fixed amount and any overage fees are charged at the end of each Settlement period.

  • Volume-Based Pricing: This is the most flexible pricing model and allows all of the pricing options possible in Subscription + Overage products, plus the ability to charge for your product in volume-based tiers. (i.e. transactions 0-100 cost .10 / call, transactions 101-200 cost .05 / call, etc.)

View, Edit & Delete Products

Clicking on the eye, pencil, or trash can icons located in each row of the Product listing will allow you to view, edit, or delete existing Products respectively.

Please note that Products with active product licenses cannot be deleted.

Product Search & Filters

The top search bar in Figure 11 shows where a user can search products by the product name or settlement period.

Additionally, as an admin user, the option to filter the list of Products by owners is available. Search the owner's name in the Owner search bar (Figure 11) and the table will be updated with the Products owned by that user. Admin users will see an option to view all Products assigned to the current organization.

Lastly, use the toggle next to the owner filter to view all products, or only those products published to third party commerce portals.

Last updated

© Revenium - www.revenium.io