Package com.adyen.model.checkout

Class SubscriptionDetails

java.lang.Object

com.adyen.model.checkout.SubscriptionDetails

public class SubscriptionDetails
extends Object

SubscriptionDetails

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubscriptionDetails.AmountRuleEnum	The limitation rule of the billing amount.
static class	SubscriptionDetails.BillingAttemptsRuleEnum	The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.
static class	SubscriptionDetails.FrequencyEnum	The frequency with which a shopper should be charged.

Constructor Summary

Constructors

Constructor	Description
SubscriptionDetails()

Method Summary

Modifier and Type	Method	Description
SubscriptionDetails	amount(String amount)
SubscriptionDetails	amountRule(SubscriptionDetails.AmountRuleEnum amountRule)
SubscriptionDetails	billingAttemptsRule(SubscriptionDetails.BillingAttemptsRuleEnum billingAttemptsRule)
SubscriptionDetails	billingDay(String billingDay)
SubscriptionDetails	endAt(String endAt)
boolean	equals(Object o)
SubscriptionDetails	frequency(SubscriptionDetails.FrequencyEnum frequency)
String	getAmount()	The billing amount of the recurring transactions.
SubscriptionDetails.AmountRuleEnum	getAmountRule()	The limitation rule of the billing amount.
SubscriptionDetails.BillingAttemptsRuleEnum	getBillingAttemptsRule()	The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.
String	getBillingDay()	The number of the day, on which the recurring debit can happen.
String	getEndAt()	End date of the billing plan, in YYYY-MM-DD format.
SubscriptionDetails.FrequencyEnum	getFrequency()	The frequency with which a shopper should be charged.
String	getRemarks()	The message shown by UPI to the shopper on the approval screen.
String	getStartAt()	Start date of the billing plan, in YYYY-MM-DD format.
int	hashCode()
SubscriptionDetails	remarks(String remarks)
void	setAmount(String amount)
void	setAmountRule(SubscriptionDetails.AmountRuleEnum amountRule)
void	setBillingAttemptsRule(SubscriptionDetails.BillingAttemptsRuleEnum billingAttemptsRule)
void	setBillingDay(String billingDay)
void	setEndAt(String endAt)
void	setFrequency(SubscriptionDetails.FrequencyEnum frequency)
void	setRemarks(String remarks)
void	setStartAt(String startAt)
SubscriptionDetails	startAt(String startAt)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SubscriptionDetails

public SubscriptionDetails()

Method Detail

amount

public SubscriptionDetails amount(String amount)

getAmount

public String getAmount()

The billing amount of the recurring transactions.

Returns:

amount

setAmount

public void setAmount(String amount)

amountRule

public SubscriptionDetails amountRule(SubscriptionDetails.AmountRuleEnum amountRule)

getAmountRule

public SubscriptionDetails.AmountRuleEnum getAmountRule()

The limitation rule of the billing amount. Possible values: * `max`: The transaction amount can not exceed the `amount`. * `exact`: The transaction amount should be the same as the `amount`.

Returns:

amountRule

setAmountRule

public void setAmountRule(SubscriptionDetails.AmountRuleEnum amountRule)

billingAttemptsRule

public SubscriptionDetails billingAttemptsRule(SubscriptionDetails.BillingAttemptsRuleEnum billingAttemptsRule)

getBillingAttemptsRule

public SubscriptionDetails.BillingAttemptsRuleEnum getBillingAttemptsRule()

The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * `on`: On a specific date. * `before`: Before and on a specific date. * `after`: On and after a specific date.

Returns:

billingAttemptsRule

setBillingAttemptsRule

public void setBillingAttemptsRule(SubscriptionDetails.BillingAttemptsRuleEnum billingAttemptsRule)

billingDay

public SubscriptionDetails billingDay(String billingDay)

getBillingDay

public String getBillingDay()

The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`.

Returns:

billingDay

setBillingDay

public void setBillingDay(String billingDay)

endAt

public SubscriptionDetails endAt(String endAt)

getEndAt

public String getEndAt()

End date of the billing plan, in YYYY-MM-DD format.

Returns:

endAt

setEndAt

public void setEndAt(String endAt)

frequency

public SubscriptionDetails frequency(SubscriptionDetails.FrequencyEnum frequency)

getFrequency

public SubscriptionDetails.FrequencyEnum getFrequency()

The frequency with which a shopper should be charged. Possible values: daily, weekly, biWeekly, monthly, quarterly, halfYearly, yearly.

Returns:

frequency

setFrequency

public void setFrequency(SubscriptionDetails.FrequencyEnum frequency)

remarks

public SubscriptionDetails remarks(String remarks)

getRemarks

public String getRemarks()

The message shown by UPI to the shopper on the approval screen.

Returns:

remarks

setRemarks

public void setRemarks(String remarks)

startAt

public SubscriptionDetails startAt(String startAt)

getStartAt

public String getStartAt()

Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.

Returns:

startAt

setStartAt

public void setStartAt(String startAt)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object