Package org.killbill.billing.catalog.api

Interface Plan

    • Method Detail

      • getCatalog

        StaticCatalog getCatalog()
        Returns:
        the catalog this plan belongs to

      • getRecurringBillingMode

        BillingMode getRecurringBillingMode()
        Returns:
        the recurring billing mode for this catalog

      • getInitialPhases

        PlanPhase[] getInitialPhases()
        Returns:
        an array of PlanPhase

      • getProduct

        Product getProduct()
        Returns:
        the Product associated with that Plan

      • getPriceList

        PriceList getPriceList()
        Returns:
        the in which that Plan is defined

      • getInitialPhaseIterator

        Iterator<PlanPhase> getInitialPhaseIterator()
        Returns:
        an iterator through the PlanPhase

      • getFinalPhase

        PlanPhase getFinalPhase()
        Returns:
        the final PlanPhase

      • getRecurringBillingPeriod

        BillingPeriod getRecurringBillingPeriod()
        Returns:
        the BillingPeriod

      • getPlansAllowedInBundle

        int getPlansAllowedInBundle()
        Returns:
        the number of instance of subscriptions in a bundle with that Plan

      • getAllPhases

        PlanPhase[] getAllPhases()
        Returns:
        an array of PlanPhase

      • getEffectiveDateForExistingSubscriptions

        Date getEffectiveDateForExistingSubscriptions()
        Returns:
        the date for which existing subscriptions become effective with that Plan

      • dateOfFirstRecurringNonZeroCharge

        org.joda.time.DateTime dateOfFirstRecurringNonZeroCharge​(org.joda.time.DateTime subscriptionStartDate,
                                                         PhaseType intialPhaseType)
        Parameters:
        subscriptionStartDate - the subscriptionStartDate
        intialPhaseType - the type of the initial phase
        Returns:
        the date at which we see the first recurring non zero charge