@maxio-com/advanced-billing-sdk/src/models/createPrepayment.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, number, optional, Schema, string } from '../schema';
import {
  CreatePrepaymentMethod,
  createPrepaymentMethodSchema,
} from './createPrepaymentMethod';

export interface CreatePrepayment {
  amount: number;
  details: string;
  memo: string;
  /** :- When the `method` specified is `"credit_card_on_file"`, the prepayment amount will be collected using the default credit card payment profile and applied to the prepayment account balance. This is especially useful for manual replenishment of prepaid subscriptions. */
  method: CreatePrepaymentMethod;
  paymentProfileId?: number;
  [key: string]: unknown;
}

export const createPrepaymentSchema: Schema<CreatePrepayment> = expandoObject({
  amount: ['amount', number()],
  details: ['details', string()],
  memo: ['memo', string()],
  method: ['method', createPrepaymentMethodSchema],
  paymentProfileId: ['payment_profile_id', optional(number())],
});