@maxio-com/advanced-billing-sdk/src/models/createAllocation.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 {
  boolean,
  expandoObject,
  lazy,
  nullable,
  number,
  optional,
  Schema,
  string,
} from '../schema';
import { BillingSchedule, billingScheduleSchema } from './billingSchedule';
import {
  CreateAllocationPricePointId,
  createAllocationPricePointIdSchema,
} from './containers/createAllocationPricePointId';
import { CreditType, creditTypeSchema } from './creditType';

export interface CreateAllocation {
  /** The allocated quantity to which to set the line-items allocated quantity. By default, this is an integer. If decimal allocations are enabled for the component, it will be a decimal number. For On/Off components, use 1for on and 0 for off. */
  quantity: number;
  /** (required for the multiple allocations endpoint) The id associated with the component for which the allocation is being made */
  componentId?: number;
  /** A memo to record along with the allocation */
  memo?: string;
  /** The scheme used if the proration is a downgrade. Defaults to the site setting if one is not provided. */
  prorationDowngradeScheme?: string;
  /** The scheme used if the proration is an upgrade. Defaults to the site setting if one is not provided. */
  prorationUpgradeScheme?: string;
  /** If the change in cost is an upgrade, this determines if the charge should accrue to the next renewal or if capture should be attempted immediately. Defaults to the site setting if one is not provided. */
  accrueCharge?: boolean;
  /**
   * The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
   * Available values: `full`, `prorated`, `none`.
   */
  downgradeCredit?: CreditType | null;
  /**
   * The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
   * Available values: `full`, `prorated`, `none`.
   */
  upgradeCharge?: CreditType | null;
  /**
   * If set to true, if the immediate component payment fails, initiate dunning for the subscription.
   * Otherwise, leave the charges on the subscription to pay for at renewal. Defaults to false.
   */
  initiateDunning?: boolean;
  /** Price point that the allocation should be charged at. Accepts either the price point's id (integer) or handle (string). When not specified, the default price point will be used. */
  pricePointId?: CreateAllocationPricePointId | null;
  /** This attribute is particularly useful when you need to align billing events for different components on distinct schedules within a subscription. Please note this only works for site with Multifrequency enabled */
  billingSchedule?: BillingSchedule;
  [key: string]: unknown;
}

export const createAllocationSchema: Schema<CreateAllocation> = expandoObject({
  quantity: ['quantity', number()],
  componentId: ['component_id', optional(number())],
  memo: ['memo', optional(string())],
  prorationDowngradeScheme: ['proration_downgrade_scheme', optional(string())],
  prorationUpgradeScheme: ['proration_upgrade_scheme', optional(string())],
  accrueCharge: ['accrue_charge', optional(boolean())],
  downgradeCredit: ['downgrade_credit', optional(nullable(creditTypeSchema))],
  upgradeCharge: ['upgrade_charge', optional(nullable(creditTypeSchema))],
  initiateDunning: ['initiate_dunning', optional(boolean())],
  pricePointId: [
    'price_point_id',
    optional(nullable(createAllocationPricePointIdSchema)),
  ],
  billingSchedule: [
    'billing_schedule',
    optional(lazy(() => billingScheduleSchema)),
  ],
});