@maxio-com/advanced-billing-sdk
Version:
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.
35 lines • 1.53 kB
TypeScript
/**
* AdvancedBilling
*
* This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { Schema } from '../schema';
import { CollectionMethod } from './collectionMethod';
import { CreateAllocation } from './createAllocation';
import { CreditType } from './creditType';
export interface AllocateComponents {
prorationUpgradeScheme?: string;
prorationDowngradeScheme?: string;
allocations?: CreateAllocation[];
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`.
*/
upgradeCharge?: 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`.
*/
downgradeCredit?: CreditType | null;
/** (Optional) If not passed, the allocation(s) will use the payment collection method on the subscription */
paymentCollectionMethod?: CollectionMethod;
/**
* If true, if the immediate component payment fails, initiate dunning for the subscription.
* Otherwise, leave the charges on the subscription to pay for at renewal.
*/
initiateDunning?: boolean;
[key: string]: unknown;
}
export declare const allocateComponentsSchema: Schema<AllocateComponents>;
//# sourceMappingURL=allocateComponents.d.ts.map