Set Up Embeddable Components for Self-Service Subscription Management

Embeddable Components, also known as Reusable Components, are self-service, headless components developers use to build and customize a subscription journey inside their own application. Maxio delivers them as a TypeScript SDK, aimed at improving both the developer experience and the subscriber experience.

For how the components authenticate against the API, see the Understand Embeddable Components Authentication help article.

Why use Embeddable Components

Embeddable Components let you build a subscriber experience that fits your product, which suits self-service Subscriptions in a product-led strategy. You configure them in your billing portal settings, enable or disable functionality either through Advanced Billing or in code, and style them with dynamic or static code to match your brand.

They fall into three functions:

• Billing History - Viewing, sorting, and filtering Customer Invoices.
• Subscription Manager - Self-serve Subscription management, including Subscription details, Payment Profiles, product migrations, and coupon application.
• Customer Details - Viewing and editing Customer contact details, address, and custom fields.

For help at any point, contact support@maxio.com.

Step 1 - Enable Embeddable Components in Advanced Billing

Identify the domain that hosts your site, then generate a sign-in key so your host server can authenticate. Add localhost as a domain while you develop locally, and remove it once development finishes.

Important: Maxio displays the sign-in key once and never again. Copy it before you leave the page. An account holds a maximum of two sign-in keys at a time.

To enable Embeddable Components

1. From Advanced Billing, go to Config > Integrations > Embeddable Components.

   

2. Enter a Domain, then select Enable Maxio Components. Maxio generates a Base64-encoded Token Sign in Key.

   

3. Copy the token and store it somewhere safe.

4. Go to Config > Settings > Billing Portal and select Enabled for this site.

   

5. Select the Features available to your Customers.

6. Select Save.

Not every Billing Portal feature affects a self-hosted application. Remove Maxio Advanced Billing Logo has no effect on your own application, for example, while Allow Plan Changes does. Enable the features your application actually depends on.

Manage domains and keys afterwards

The settings page changes once the integration is enabled, and this is where you do the follow-up work the steps above set you up for:

• Add new domain adds another allowed domain, and Remove deletes one. Use Remove to drop localhost when you finish developing.
• Generate Another Sign in Key issues a second key, up to the limit of two.
• Disable Maxio Components Integration turns the integration off. Maxio asks you to confirm, because the integration stops working immediately.

Step 2 - Install the SDK from npm

npm is the main package manager for node.js, the JavaScript runtime. Installing node.js also installs npm, and you need node.js to run the Vue or React examples in Step 3.

To install the SDK

1. Go to the @maxio-com/self-service package on npmjs.com. The package page, "Headless Billing Portal", covers installation, links to the Vue and React examples, and walks through repository setup.

2. Create a project directory on your machine.

3. Open a terminal and navigate to that directory.

4. Install the package:

   bash

   npm install @maxio-com/self-service

A successful install creates a node_modules directory containing @maxio-com/self-service.

Step 3 - Run an example application

Maxio provides Vue and React examples you can run as-is. The steps below use the Vue example on localhost.

To run the Vue example

1. From the package page, under Installation and usage, open Examples and select vue-self-service-example. This opens the Maxio Vue example repository.

2. Clone the repository:

   bash

   git clone https://github.com/maxio-com/vue-self-service-example

3. Open the cloned repository and install its dependencies:

   bash

   pnpm install

   Or, if you use npm:

   bash

   npm install

4. Run the development server:

   bash

   pnpm run dev

   Or:

   bash

   npm run dev

5. Open http://localhost:3000/ to view the running components.

   

Configure the example components

Each component takes its own options. Edit the files under src > components, then reload the example in your browser to see the change.

Billing History options, in BillingHistory.vue

Customer Details options, in CustomerDetails.vue

Subscription Manager options, in SubscriptionManager.vue

Step 4 - Optional configurations

Use as a standalone library from a CDN

To use Embeddable Components as a standalone library from a content delivery network:

1. Add the library script to your page:

   html

   <script src="https://cdn.jsdelivr.net/npm/@maxio-com/self-service@1.9.0/dist/maxio-components.umd.min.js"></script>

2. Initialize the components:

   javascript

   const factory = new window.Maxio.Components(options);
   // Render Billing History to the document.body element
   let element = factory.create('billing-history');
    
   element.render(document.body);

3. Make sure your local environment matches a domain you configured. Add localhost if you want to run it locally.

A complete page

<html>
  <head>
    <meta charset="utf-8">
    <script src="https://cdn.jsdelivr.net/npm/@maxio-com/self-service@1.9.0/dist/maxio-components.umd.min.js"></script>
  </head>
  <body>
    <script>
      const factory = new window.Maxio.Components({
        i18nSettings: {
          loadPath: '<path to localization file>',
          language: 'en',
        },
        accessTokenUrl: '<path to authorization service>'
      });
 
      let element = factory.create('billing-history');
 
      element.render(document.body);
    </script>
  </body>
</html>

Control custom field visibility

You set how far each custom field, or metafield, is exposed to customers in Embeddable Components. The scopes apply to both Subscription-level and Customer-level custom fields:

• public_show set to 1 makes the custom field visible in the application.
• public_edit set to 1 makes it editable.

These metafield settings are available through the API only.

Allow customer updates for one component

Alongside the global components update setting, each component carries its own property controlling whether a billing portal can update it. Embeddable Components respects that property too.

To allow customer updates for a component

1. From Advanced Billing, go to Catalog > Products.

2. Select the Products family the component belongs to.

3. Select the Components tab.

4. Choose a component.

5. At the bottom of the component page, next to Advanced Options, select Edit.

6. Enable Allow Customer Updates In Billing Portal.

   

Related information

For authentication endpoint examples and other code, see the Embeddable Components Code Samples help article.