Package com.broadleafcommerce.cartoperation.service.provider.domain

Class EstimatedFuturePayment

java.lang.Object
com.broadleafcommerce.cartoperation.service.provider.domain.EstimatedFuturePayment
All Implemented Interfaces:
Serializable
public class EstimatedFuturePayment extends Object implements Serializable
Describes the timing & amount of future subscription payments.
Since:
Cart Operation Service 2.3.0, Release Train 2.3.0
See Also:

  • Constructor Details

    • EstimatedFuturePayment

      public EstimatedFuturePayment()

  • Method Details

    • getPeriodNumber

      public Integer getPeriodNumber()
      The period number of the billing period.

    • getBillDate

      public Instant getBillDate()
      The date on which the customer is expected to be billed.

    • getPeriodStartDate

      public Instant getPeriodStartDate()
      The date describing the beginning of the billing period that is being billed for.

    • getPeriodEndDate

      public Instant getPeriodEndDate()
      The date describing the end of the billing period that is being billed for.

    • getAmount

      public javax.money.MonetaryAmount getAmount()
      Amount due on the payment schedule date. Equal to getProratedAmount() + getPriorUnbilledAmount() - getCreditedAmount().

    • getProratedAmount

      public javax.money.MonetaryAmount getProratedAmount()
      Prorated amount for this item (for new, this would match the amount)

    • getCreditedAmount

      public javax.money.MonetaryAmount getCreditedAmount()
      For edits, upgrades, and downgrades, the system has partial credits to the prorated amount that the customer already paid. Typically only impacts the first period in the estimatedFuturePaymentsList. For example, consider a customer who is upgrading from 10 to 20 licenses at $1 each half-way through a 30 day month. The user prorated amount would be $10 for 20 licenses. This user has already partially paid for 10 of the licenses, so they will be due a credit of $5 toward the amount.

    • getPriorUnbilledAmount

      public javax.money.MonetaryAmount getPriorUnbilledAmount()
      Prior to an upgrade, downgrade, or edit, the system may have prior unbilled charges that will be part of the next invoice. In this case, the user will owe this in addition to the prorated charges for the changes being made. Typically only impacts the first period in the estimatedFuturePaymentsList.

    • getItemDetails

      public List<SubscriptionItemPriceDetail> getItemDetails()
      A list of SubscriptionPriceItemDetails describing the individual item prices that contributed to the overall getAmount().

    • setPeriodNumber

      public void setPeriodNumber(Integer periodNumber)
      The period number of the billing period.

    • setBillDate

      public void setBillDate(Instant billDate)
      The date on which the customer is expected to be billed.

    • setPeriodStartDate

      public void setPeriodStartDate(Instant periodStartDate)
      The date describing the beginning of the billing period that is being billed for.

    • setPeriodEndDate

      public void setPeriodEndDate(Instant periodEndDate)
      The date describing the end of the billing period that is being billed for.

    • setAmount

      public void setAmount(javax.money.MonetaryAmount amount)
      Amount due on the payment schedule date. Equal to getProratedAmount() + getPriorUnbilledAmount() - getCreditedAmount().

    • setProratedAmount

      public void setProratedAmount(javax.money.MonetaryAmount proratedAmount)
      Prorated amount for this item (for new, this would match the amount)

    • setCreditedAmount

      public void setCreditedAmount(javax.money.MonetaryAmount creditedAmount)
      For edits, upgrades, and downgrades, the system has partial credits to the prorated amount that the customer already paid. Typically only impacts the first period in the estimatedFuturePaymentsList. For example, consider a customer who is upgrading from 10 to 20 licenses at $1 each half-way through a 30 day month. The user prorated amount would be $10 for 20 licenses. This user has already partially paid for 10 of the licenses, so they will be due a credit of $5 toward the amount.

    • setPriorUnbilledAmount

      public void setPriorUnbilledAmount(javax.money.MonetaryAmount priorUnbilledAmount)
      Prior to an upgrade, downgrade, or edit, the system may have prior unbilled charges that will be part of the next invoice. In this case, the user will owe this in addition to the prorated charges for the changes being made. Typically only impacts the first period in the estimatedFuturePaymentsList.

    • setItemDetails

      public void setItemDetails(List<SubscriptionItemPriceDetail> itemDetails)
      A list of SubscriptionPriceItemDetails describing the individual item prices that contributed to the overall getAmount().

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object