Customer Portal and Octane Components

Octane can easily integrate with your product's customer experience. Our integrations can be used to show invoice history and usage data to your customers, or collect payment and contact information from them. We support two types of customer-facing integrations: the Customer Portal for a fast and effective setup, and octane-components for a powerful, customizable integration.

Customer Portal

The Customer Portal is a hosted customer-facing dashboard. It contains customer subscription data, payment and contact information, usage graphs, and a history of their invoices. Integrating is as simple as requesting a URL through our API.

Using the Customer Portal

Access to the Customer Portal is granted through a URL that encodes a short-lived customer token. A URL can be obtained through our API, or through the customer drilldown page (as shown in the screenshot below). Because anyone with the link has access to a customer's settings, the link is only valid for 1 hour before it needs to be regenerated.

Configuring the Customer Portal

You can configure the Customer Portal in your settings, under the "Hosted Page" section. From here, you can enable and disable the ability for your customers to choose their own price plans. You can also update the Customer Portal's theme to match your site's branding.

Color customization can be done by clicking "View and edit theme," which launches our theme editor. The editor allows you to override the default colors, and includes a light theme as a helpful starting point. Note that you can edit the portal's color theme while leaving the "Use a custom theme on the hosted page" setting disabled, allowing you to iterate on the theme without making it public.

octane-components

The octane-components SDK is a library of building blocks for integrating with Octane. It contains pre-built React components for things like selecting Price Plans and collecting credit card information, as well as a number of React hooks and framework-agnostic methods for fetching and using Octane data directly from the browser.

For more details, the octane-components repo has full documentation, code snippets, and an example application.