@maxio-com/advanced-billing-sdk/src/models/activateEventBasedComponent.ts

Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments.

/**
 * AdvancedBilling
 *
 * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import { expandoObject, lazy, number, optional, Schema } from '../schema.js';
import { BillingSchedule, billingScheduleSchema } from './billingSchedule.js';
import {
  ComponentCustomPrice,
  componentCustomPriceSchema,
} from './componentCustomPrice.js';

export interface ActivateEventBasedComponent {
  /** The Chargify id of the price point */
  pricePointId?: number;
  /** This attribute is particularly useful when you need to align billing events for different components on distinct schedules within a subscription. This only works for site with Multifrequency enabled. */
  billingSchedule?: BillingSchedule;
  /** Create or update custom pricing unique to the subscription. Used in place of `price_point_id`. */
  customPrice?: ComponentCustomPrice;
  [key: string]: unknown;
}

export const activateEventBasedComponentSchema: Schema<ActivateEventBasedComponent> = lazy(
  () =>
    expandoObject({
      pricePointId: ['price_point_id', optional(number())],
      billingSchedule: ['billing_schedule', optional(billingScheduleSchema)],
      customPrice: ['custom_price', optional(componentCustomPriceSchema)],
    })
);