Skip to navigation
Frontend ComponentsUI components

Subscription schedules

The Subscription schedules component renders the schedule of upcoming plan changes for a specific subscription. Use it when you want to show customers what changes are planned for their subscription.

Overview

Subscription schedules is driven by a portalObject your backend generates for a specific customer. The SDK uses it to load the schedule data for the given subscription. Your frontend never handles API keys directly.

Mount the component

Subscription schedules component
import { createSolvimonCore } from '@solvimon/solvimon-web/core';
// Generated by your backend via the Solvimon API.
const customerPortalObject = {
    object_type: 'PORTAL_URL',
    id: 'purl_example',
    type: 'CUSTOMER_PORTAL',
    customer_id: 'cust_example',
    token: 'replace-with-a-real-portal-token',
    status: 'PUBLISHED',
};
const solvimon = createSolvimonCore({
    environment: 'TEST',
    locale: 'en-US',
});
const unmount = solvimon.createComponent('subscription-schedules', {
    container: '#sdk-root',
    portalObject: customerPortalObject,
    configuration: {
        subscriptionId: 'sub_example',
    },
});
window.addEventListener('beforeunload', () => {
    unmount?.();
});

Configuration

OptionTypeRequiredDescription
subscriptionIdstringYesThe ID of the subscription whose schedules to display.

Events

This component does not fire any events.