commonMain.com.revenuecat.purchases.kmp.models.Period.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of purchases-kmp-models Show documentation

Mobile subscriptions in hours, not months.

There is a newer version: 1.3.7+13.15.0

package com.revenuecat.purchases.kmp.models

private const val DAYS_PER_WEEK = 7.0
private const val DAYS_PER_MONTH = 30.0
private const val DAYS_PER_YEAR = 365.0
private const val MONTHS_PER_YEAR = 12.0
private const val WEEKS_PER_MONTH = DAYS_PER_YEAR / MONTHS_PER_YEAR / DAYS_PER_WEEK

/**
 * Represents subscription or [PricingPhase] billing period.
 * @property value The number of period units.
 * @property unit The increment of time that a subscription period is specified in.
 */
public class Period(
    public val value: Int,
    public val unit: PeriodUnit,
) {

    public val valueInMonths: Double
        get() = when (unit) {
            PeriodUnit.DAY -> value / DAYS_PER_MONTH
            PeriodUnit.WEEK -> value / WEEKS_PER_MONTH
            PeriodUnit.MONTH -> value.toDouble()
            PeriodUnit.YEAR -> value * MONTHS_PER_YEAR
            PeriodUnit.UNKNOWN -> 0.0
        }

}

/**
 * The unit of time a [Period] is denoted in.
 */
public enum class PeriodUnit {
    DAY,
    WEEK,
    MONTH,
    YEAR,
    UNKNOWN,
}