Class Subscription<T>
java.lang.Object
com.broadleafcommerce.paymentgateway.domain.Subscription<T>
- Author:
- Chad Harchar (charchar) Many payment solutions allow you to set up subscriptions (recurring payments) with payment transactions. The following DTO represent the usual parameters that you may wish to pass: recurringAmount: the amount that you charge for every recurring payment frequency: the frequency of the recurring payment numberOfInstallments: the number of payments for this subscription startDate: the start date for this subscription
-
Field Summary
Modifier and TypeFieldDescriptionAny extra properties needed to define the subscriptionprotected String
How often the customer will be chargedprotected String
The number of times that the customer will be chargedprotected T
protected javax.money.MonetaryAmount
The amount that must be paid for each billing cycleprotected Instant
Start of when this subscription should be active. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionadditionalFields
(String key, Object value) done()
Any extra properties needed to define the subscriptionHow often the customer will be chargedThe number of times that the customer will be chargedjavax.money.MonetaryAmount
The amount that must be paid for each billing cycleStart of when this subscription should be active.numberOfInstallments
(String numberOfInstallments) recurringAmount
(javax.money.MonetaryAmount recurringAmount) boolean
-
Field Details
-
parent
-
recurringAmount
protected javax.money.MonetaryAmount recurringAmountThe amount that must be paid for each billing cycle -
frequency
How often the customer will be charged -
numberOfInstallments
The number of times that the customer will be charged -
startDate
Start of when this subscription should be active. Unset indicates that this should always be active. -
additionalFields
Any extra properties needed to define the subscription
-
-
Constructor Details
-
Subscription
public Subscription() -
Subscription
-
-
Method Details
-
done
-
additionalFields
-
recurringAmount
-
frequency
-
numberOfInstallments
-
startDate
-
subscriptionPopulated
public boolean subscriptionPopulated() -
getParent
-
getRecurringAmount
public javax.money.MonetaryAmount getRecurringAmount()The amount that must be paid for each billing cycle- Returns:
- the amount that must be paid for each billing cycle
-
getFrequency
How often the customer will be charged- Returns:
- how often the customer will be charged
-
getNumberOfInstallments
The number of times that the customer will be charged- Returns:
- the number of times that the customer will be charged
-
getStartDate
Start of when this subscription should be active. Unset indicates that this should always be active.- Returns:
- the date when this subscription should start being active
-
getAdditionalFields
Any extra properties needed to define the subscription- Returns:
- any extra properties needed to define the subscription
-