getRateForCohort
This content is not available in your language yet.
function getRateForCohort(input, options?): CohortRateResult;Defined in: core/rates.ts:137
Resolves the annual rate that applies to a cohort (defined by
subscriptionDate) for the quarter that contains asOfDate (defaults to
today, UTC).
The quarter is anchored to the subscription date: the first quarter starts
on subscriptionDate and ends 3 months later, and so on. The annual rate
is the sum of the base rate for the quarter-start month and the permanence
premium for the contract year that the quarter falls into.
Parameters
Seção intitulada “Parameters”| Parameter | Type |
|---|---|
input | CohortRateInput |
options | RatesOptions |
Returns
Seção intitulada “Returns”when asOfDate lies on or after maturity for finite series
(the certificate has matured), or when the input fails Zod validation.