Type Alias RecurringFeeEnrollmentCandidate

A customer paying a manual platform fee with no recurring one configured, and what enrolling them would configure.

type RecurringFeeEnrollmentCandidate = {
    basedOnPeriodKey: string;
    chargeCount: number;
    customerId: SelectCustomer["externalId"];
    customerName: SelectCustomer["name"];
    latestDescription: string | null;
    paidThisMonth: boolean;
    sourceAccountId: RecurringFeeConfig["sourceAccountId"];
    suggestedAmount: BigNumber;
    suggestedBillingStartDate: NonNullable<
        StoredRecurringFee["billingStartDate"],
    >;
}

Properties

basedOnPeriodKey: string

The period the charges were read from.

chargeCount: number

customerId: SelectCustomer["externalId"]

customerName: SelectCustomer["name"]

latestDescription: string | null

paidThisMonth: boolean

Whether a manual charge is PROCESSING or COMPLETED in the current period.

Source account of the most recent of those charges.

suggestedAmount: BigNumber

Sum of the customer's charges in basedOnPeriodKey, in MOVEUSD.

suggestedBillingStartDate: NonNullable<StoredRecurringFee["billingStartDate"]>

The day of the month of the customer's latest PROCESSING or COMPLETED manual charge, one month later, clamped to that month's last day.