@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.
67 lines • 3.75 kB
TypeScript
/**
* AdvancedBilling
*
* This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { Schema } from '../schema';
import { AllocationPreviousQuantity } from './containers/allocationPreviousQuantity';
import { AllocationQuantity } from './containers/allocationQuantity';
import { CreditType } from './creditType';
import { IntervalUnit } from './intervalUnit';
import { PaymentForAllocation } from './paymentForAllocation';
export interface Allocation {
/** The allocation unique id */
allocationId?: number;
/** The integer component ID for the allocation. This references a component that you have created in your Product setup */
componentId?: number;
/** The handle of the component. This references a component that you have created in your Product setup */
componentHandle?: string | null;
/** The integer subscription ID for the allocation. This references a unique subscription in your Site */
subscriptionId?: number;
/** The allocated quantity set in to effect by the allocation. String for components supporting fractional quantities */
quantity?: AllocationQuantity;
/** The allocated quantity that was in effect before this allocation was created. String for components supporting fractional quantities */
previousQuantity?: AllocationPreviousQuantity;
/** The memo passed when the allocation was created */
memo?: string | null;
/** The time that the allocation was recorded, in format and UTC timezone, i.e. 2012-11-20T22:00:37Z */
timestamp?: string;
/** Timestamp indicating when this allocation was created */
createdAt?: string;
/** The scheme used if the proration was an upgrade. This is only present when the allocation was created mid-period. */
prorationUpgradeScheme?: string;
/** The scheme used if the proration was a downgrade. This is only present when the allocation was created mid-period. */
prorationDowngradeScheme?: string;
pricePointId?: number;
pricePointName?: string;
pricePointHandle?: string;
/** The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */
interval?: number;
/** A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. */
intervalUnit?: IntervalUnit | null;
previousPricePointId?: number;
/** 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. */
accrueCharge?: boolean;
/**
* 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;
/**
* 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;
payment?: PaymentForAllocation | null;
expiresAt?: string;
usedQuantity?: bigint;
chargeId?: bigint;
[key: string]: unknown;
}
export declare const allocationSchema: Schema<Allocation>;
//# sourceMappingURL=allocation.d.ts.map