Portal Quickstart

Get setup with the portal in a blitz

πŸ‘

Jump to Developer Quickstart

If you have already completed the setup guide on the Octane portal, feel free to jump directly to the developer quick-start guide.

1. Sign up for Octane

You can use GitHub, Google, or your email to sign up for Octane through the Octane Portal.

2. Create a project

In this guide, we are going to walk through creating a project for our fictional company, Antler DB.

You can begin by typing in a project name and clicking Create. Once the project is created, you can track your setup progress on the bottom-left corner of the dashboard.

3. Create your first meter

The first thing to set up is a meter to measure your customer's usage.

πŸ“˜

Meter configuration fields

Learn more about the fields available when Creating a new meter.

Steps

  1. Navigate to the Meters tab.
  2. Click Create New.
  3. Enter configuration details for the new meter.

Antler DB Example Scenario

This is an example using a fictional company, Antler DB. The purpose of these examples is to demonstrate one way you could complete the steps in this guide.

At Antler DB, we want to bill customers based on amount of storage space they use. We will use the following settings for the primary configuration of this meter:

  • We are creating a meter named storage for Antler DB.
  • The meter's type is set to gauge, indicating that the measurement is time-dependent.
  • Values for this meter will be assigned the unit gigabyte.

We also attached the primary label customer_id, which will allow us to identify the customer that originates each measurement value received by Octane.

🚧

Primary Labels

Primary labels are necessary if you want to differentiate measurements for this meter by customer, deployment environment, etc. Without a primary label to associate each measurement with a customer, individual measurements may overwrite each other.

Learn more about how Primary Labels are used to handle Independent Streams.

4. Create a Price Plan

Next, we will set up a price plan that can bill customers based on the meter we just created.

πŸ“˜

Price plan configuration

To learn more about the fields available when creating price plans, metered components, or discounts, have a look at these pages:

Steps

  1. Click on Price Plans tab.
  2. Click Create New.
  3. Enter basic price plan details.
  4. Optionally, add metered components (i.e., usage-based components).
  5. Optionally, add a discount.

Antler DB Example Scenario

This is an example using a fictional company, Antler DB. The purpose of these examples is to demonstrate one way you could complete the steps in this guide.

Our Antler DB pricing is very simple. We want to charge a base rate of $100 every month. Additionally, we want to charge based on our storage meter with a simple rate: $1/GB/hour.

This utilizes the basic per unit price scheme, which will charge $1 for every GB of storage for every hour that it is stored.

5. Create a test customer

🚧

Customers should be created programmatically

This step is for creating a test customer. All customers should generally be created through the SDKs/APIs - see developer quickstart to learn more.

Steps

  1. Click on the + symbol on the All Customers table within the Customers tab.
  2. Click Register Via Portal.
  3. Enter details for the text customer:
  • Name - The display name used in UI and invoices.
  • ID (autofilled) - Used for subscribing customers to price plans and other API calls.
  • Phone, Email, Website - Optional information for customer.
  • Measurement Mapping (autofilled) - The label key and value which will identify this customer. This is will be used to map a measurement to a customer.

6. Create a test subscription

🚧

Subscriptions should be created programmatically

This step is for creating a test subscriptions. All subscriptions should generally be created through the SDKs/APIs - see developer quickstart to learn more.

Steps

  1. Navigate to the Customers tab, and select the customer you want to create a subscriptions for.
  2. On the Subscription tile on the bottom left click the + icon.
  3. Select a price plan that should be associated with this subscription.
  4. Optionally, Override Discount can be used to override the discount that was associated with the price plan or to add a new discount to the plan.
  5. The Effective Date field specifies whether the subscription should be effective immediately or at a future date.

Antler DB Example Scenario

This is an example using a fictional company, Antler DB. The purpose of these examples is to demonstrate one way you could complete the steps in this guide.

Antler DB wants to subscribe the Test Customer to the Storage Plan (price plan) that we created previously.

Additionally, we want to add a $10 discount for this specific customer, so we need to override the previously non-existent discount associated with this price plan. Finally, we schedule the subscription to be effective immediately, as we want to start viewing the revenue from Test Customer.

7. Send a test measurement

🚧

Measurements should be sent programmatically

This step is for sending a test measurement. All measurements should generally be sent through the SDKs/APIs - see developer quickstart to learn more.

8. View your revenue and invoice

Octane shows you a real-time view of your revenue as well as a historical view of all revenue that has already been invoiced. The Customers tab provides an overview of the complete system as shown below.

The Total Accrued Revenue is a real-time display of the amount of money you are owed for the current billing cycle. It will automatically update as time passes. The Total Invoiced Revenue is the amount of revenue that has already been invoiced to the customer.

Additionally, you can see the usage by meters in the graph to the right. You can get this same view at a per customer level by clicking on the customer you are interested in.

To preview an invoice (as of the current date) for a customer, follow the steps below:

Steps:

  1. Click on the customer you are interested in.
  2. Click on the Preview Invoice button in the revenue tile.

Next Steps

Make sure to complete the developer quickstart next!

Did this page help you?