@maxio-com/advanced-billing-sdk/dist/esm/models/subscriptionComponent.js

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 { array, boolean, expandoObject, lazy, nullable, number, optional, string, } from '../schema';
import { componentKindSchema } from './componentKind';
import { subscriptionComponentAllocatedQuantitySchema, } from './containers/subscriptionComponentAllocatedQuantity';
import { creditTypeSchema } from './creditType';
import { historicUsageSchema } from './historicUsage';
import { intervalUnitSchema } from './intervalUnit';
import { pricePointTypeSchema } from './pricePointType';
import { pricingSchemeSchema } from './pricingScheme';
import { subscriptionComponentSubscriptionSchema, } from './subscriptionComponentSubscription';
export const subscriptionComponentSchema = expandoObject({
    id: ['id', optional(number())],
    name: ['name', optional(string())],
    kind: ['kind', optional(componentKindSchema)],
    unitName: ['unit_name', optional(string())],
    enabled: ['enabled', optional(boolean())],
    unitBalance: ['unit_balance', optional(number())],
    currency: ['currency', optional(string())],
    allocatedQuantity: [
        'allocated_quantity',
        optional(subscriptionComponentAllocatedQuantitySchema),
    ],
    pricingScheme: ['pricing_scheme', optional(nullable(pricingSchemeSchema))],
    componentId: ['component_id', optional(number())],
    componentHandle: ['component_handle', optional(nullable(string()))],
    subscriptionId: ['subscription_id', optional(number())],
    recurring: ['recurring', optional(boolean())],
    upgradeCharge: ['upgrade_charge', optional(nullable(creditTypeSchema))],
    downgradeCredit: ['downgrade_credit', optional(nullable(creditTypeSchema))],
    archivedAt: ['archived_at', optional(nullable(string()))],
    pricePointId: ['price_point_id', optional(nullable(number()))],
    pricePointHandle: ['price_point_handle', optional(nullable(string()))],
    pricePointType: [
        'price_point_type',
        optional(nullable(pricePointTypeSchema)),
    ],
    pricePointName: ['price_point_name', optional(nullable(string()))],
    productFamilyId: ['product_family_id', optional(number())],
    productFamilyHandle: ['product_family_handle', optional(string())],
    createdAt: ['created_at', optional(string())],
    updatedAt: ['updated_at', optional(string())],
    useSiteExchangeRate: [
        'use_site_exchange_rate',
        optional(nullable(boolean())),
    ],
    description: ['description', optional(nullable(string()))],
    allowFractionalQuantities: [
        'allow_fractional_quantities',
        optional(boolean()),
    ],
    subscription: [
        'subscription',
        optional(lazy(() => subscriptionComponentSubscriptionSchema)),
    ],
    historicUsages: [
        'historic_usages',
        optional(array(lazy(() => historicUsageSchema))),
    ],
    displayOnHostedPage: ['display_on_hosted_page', optional(boolean())],
    interval: ['interval', optional(number())],
    intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))],
});
//# sourceMappingURL=subscriptionComponent.js.map