Subscriptions
Subscriptions are issued to each of your subscribers to allow them to access your products (and their associated sources). Subscriptions generate invoices at the end of each invoicing period.
Required Subscription Attributes
Description
Used to name the Subscription to make it easier for you to identify its purpose.
Subscriber Name
indicates the organization who will consume the subscription. Assigning this properly will allow you to report usage and revenue by customer.
Subscriber
The end user who owns the subscription. This Subscriber's email address will receive notifications related to the subscription such as quota alerts, invoices, etc.
Subscriber Credentials (required in almost all scenarios)
Revenium uses subscriber credentials to map metering calls to a subscription for a user to a Product. Most commonly a credential is tied to an API Key, but it can be any unique identifier for your customer's access to a data source. Credentials can also allow a single customer to use multiple tokens while still reporting usage separately by credential. Note that if no credentials are used, Revenium will auto-create a single credential the first time the product is accessed and associate all usage under a single credential (though after this point, you need to update the credential with a unique ID to enable accurate metering)
Products
This field indicates the product that the subscription is associated with.
Optional Subscription Attributes
Future Start Date: If you wish to schedule a subscription to start at a date in the future tied to the execution of a contract, you can use this option on subscriptions to do so. (note that past-dated subscriptions will be supported in a future-release as well — contact us if you need this feature accelerated)
Named Subscribers: If the product associated with this subscription has the audience option of “Named Subscribers” selected, then only the Subscribers listed here will be able to see and request access to this product in a linked storefront. This field will have no effect if the “Named Subscribers” option is not selected for the product audience. (see expanded explanation of the Audience functionality here)
Named Subscribers: If the product associated with this subscription has the audience option of “Named Subscribers” selected, then only Subscribers belonging to the organization in Revenium, or Subscribers with an email domain matching the domains on the selected Subscriber will be able to see and request access to this product in a linked commerce portal. This field will have no effect if the “Named Subscribers” option is not selected for the product audience.
Notification Addresses on Creation: This notification address will be used to provide the new Subscription to the end Subscriber who owns this Subscription, and they will use it to access the associated products. If you are using Revenium Applications to provide API consumers access to products, the end Subscriber does not need to use this Subscription, and you should not populate this notification field.
Notification Addresses on Quota Threshold: This notification address will be used to notify the end Subscriber of this Subscription that they have reached x% of their quota. This differs from the notification address configured at the product level, which is used to notify the API provider organization that their API Subscribers has reached x% of their quota.
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).
Note that if the chosen Product for the new Subscription has a Quota value set, this will become the default for the Subscription. The threshold can be assigned using the 'Quota Notification Threshold' field.
Additional Invoice Recipients: If your customers require invoices to be sent to a specific address in addition to being sent to the owner of the subscription, you can use this field to configure that option.
Expiration Date & Time: This field can be used to establish non-renewing Subscription. The expiration date will cause the Subscription to deactivated as of the date & time you select for this field.
External Quote ID: this field is used to map Subscriptions to external procurement or product management systems for reporting purposes. Example: if you wish to tie a Revenium Subscription to a specific subscription contract and managed in another system, you can use this field to create that connection.
Starting Subscriptions with Credit Card Payments
If you wish to start a subscription for a product with an external payment configurations, you will be prompted to provide the customer's payment information before the subscription can be created. These products will be indicated with a credit card icon as shown in the image below.
Deleting (Canceling) Subscriptions
Clicking on the trash can icons located in each row will allow you to cancel existing Subscriptions.
Note that after clicking on the Product Subscriptions delete button, you must choose between two types of delete operations as explained in the image immediately below.
Choose the correct option for your scenario which will complete the immediate or scheduled deletion of the product Subscription.
Reset Subscription Quota
Normally Subscription quotas are only reset at the end of an invoicing period for products with a recurring subscription. However, if you need to manually reset a quota for a subscriber, you can do so by clicking on the reset icon next to the associated quota in the list of subscriptions.
Last updated
