com.cardpay.sdk.model

Class SubscriptionGetResponse

java.lang.Object

com.cardpay.sdk.model.SubscriptionGetResponse

public class SubscriptionGetResponse
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionGetResponse.PeriodEnum Period of subscription
static class	SubscriptionGetResponse.StatusEnum Status of subscription
static class	SubscriptionGetResponse.TypeEnum Recurring payment type name; can be ONECLICK, SCHEDULED, INSTALLMENT

Constructor Summary

Constructors

Constructor and Description
SubscriptionGetResponse()

Method Summary

Modifier and Type	Method and Description
SubscriptionGetResponse	amountDue(BigDecimal amountDue)
SubscriptionGetResponse	amountTotal(BigDecimal amountTotal)
SubscriptionGetResponse	created(OffsetDateTime created)
SubscriptionGetResponse	currency(String currency)
SubscriptionGetResponse	customer(SubscriptionCustomer customer)
SubscriptionGetResponse	description(String description)
SubscriptionGetResponse	id(String id)
SubscriptionGetResponse	interval(Integer interval)
SubscriptionGetResponse	nextPayment(NextSubscriptionPayment nextPayment)
SubscriptionGetResponse	paymentsDue(Integer paymentsDue)
SubscriptionGetResponse	period(SubscriptionGetResponse.PeriodEnum period)
SubscriptionGetResponse	plan(SubscriptionGetResponsePlan plan)
SubscriptionGetResponse	retries(Integer retries)
void	setAmountDue(BigDecimal amountDue)
void	setAmountTotal(BigDecimal amountTotal)
void	setCreated(OffsetDateTime created)
void	setCurrency(String currency)
void	setCustomer(SubscriptionCustomer customer)
void	setDescription(String description)
void	setId(String id)
void	setInterval(Integer interval)
void	setNextPayment(NextSubscriptionPayment nextPayment)
void	setPaymentsDue(Integer paymentsDue)
void	setPeriod(SubscriptionGetResponse.PeriodEnum period)
void	setPlan(SubscriptionGetResponsePlan plan)
void	setRetries(Integer retries)
void	setStatus(SubscriptionGetResponse.StatusEnum status)
void	setStatusReason(String statusReason)
void	setSubscriptionStart(OffsetDateTime subscriptionStart)
void	setType(SubscriptionGetResponse.TypeEnum type)
SubscriptionGetResponse	status(SubscriptionGetResponse.StatusEnum status)
SubscriptionGetResponse	statusReason(String statusReason)
SubscriptionGetResponse	subscriptionStart(OffsetDateTime subscriptionStart)
String	toString()
SubscriptionGetResponse	type(SubscriptionGetResponse.TypeEnum type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SubscriptionGetResponse

public SubscriptionGetResponse()

Method Detail

setAmountDue

public void setAmountDue(BigDecimal amountDue)

amountDue

public SubscriptionGetResponse amountDue(BigDecimal amountDue)

Parameters:

amountDue - Amount of payments left to be captured

Returns:

bean instance

setAmountTotal

public void setAmountTotal(BigDecimal amountTotal)

amountTotal

public SubscriptionGetResponse amountTotal(BigDecimal amountTotal)

Parameters:

amountTotal - Total amount of subscription to be paid before completion

Returns:

bean instance

setCreated

public void setCreated(OffsetDateTime created)

created

public SubscriptionGetResponse created(OffsetDateTime created)

Parameters:

created - Creation time [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format

Returns:

bean instance

setCurrency

public void setCurrency(String currency)

currency

public SubscriptionGetResponse currency(String currency)

Parameters:

currency - [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code

Returns:

bean instance

setCustomer

public void setCustomer(SubscriptionCustomer customer)

customer

public SubscriptionGetResponse customer(SubscriptionCustomer customer)

Parameters:

customer - Customer data

Returns:

bean instance

setDescription

public void setDescription(String description)

description

public SubscriptionGetResponse description(String description)

Parameters:

description - Description of subscription

Returns:

bean instance

setId

public void setId(String id)

id

public SubscriptionGetResponse id(String id)

Parameters:

id - ID of subscription

Returns:

bean instance

setInterval

public void setInterval(Integer interval)

interval

public SubscriptionGetResponse interval(Integer interval)

Parameters:

interval - Interval of subscription

Returns:

bean instance

setNextPayment

public void setNextPayment(NextSubscriptionPayment nextPayment)

nextPayment

public SubscriptionGetResponse nextPayment(NextSubscriptionPayment nextPayment)

Parameters:

nextPayment - Next payment data

Returns:

bean instance

setPaymentsDue

public void setPaymentsDue(Integer paymentsDue)

paymentsDue

public SubscriptionGetResponse paymentsDue(Integer paymentsDue)

Parameters:

paymentsDue - Number of payments left to be captured

Returns:

bean instance

setPeriod

public void setPeriod(SubscriptionGetResponse.PeriodEnum period)

period

public SubscriptionGetResponse period(SubscriptionGetResponse.PeriodEnum period)

Parameters:

period - Period of subscription

Returns:

bean instance

setPlan

public void setPlan(SubscriptionGetResponsePlan plan)

plan

public SubscriptionGetResponse plan(SubscriptionGetResponsePlan plan)

Parameters:

plan - Plan data

Returns:

bean instance

setRetries

public void setRetries(Integer retries)

retries

public SubscriptionGetResponse retries(Integer retries)

Parameters:

retries - Number of daily basis retry attempts in case of payment has not been captured successfully.

Returns:

bean instance

setStatus

public void setStatus(SubscriptionGetResponse.StatusEnum status)

status

public SubscriptionGetResponse status(SubscriptionGetResponse.StatusEnum status)

Parameters:

status - Status of subscription

Returns:

bean instance

setStatusReason

public void setStatusReason(String statusReason)

statusReason

public SubscriptionGetResponse statusReason(String statusReason)

Parameters:

statusReason - Reason of subscription cancellation that was made by CardPay

Returns:

bean instance

setSubscriptionStart

public void setSubscriptionStart(OffsetDateTime subscriptionStart)

subscriptionStart

public SubscriptionGetResponse subscriptionStart(OffsetDateTime subscriptionStart)

Parameters:

subscriptionStart - The time in 'yyyy-MM-dd' format when subscription actually becomes activated (grace period)

Returns:

bean instance

setType

public void setType(SubscriptionGetResponse.TypeEnum type)

type

public SubscriptionGetResponse type(SubscriptionGetResponse.TypeEnum type)

Parameters:

type - Recurring payment type name; can be ONECLICK, SCHEDULED, INSTALLMENT

Returns:

bean instance

toString

public String toString()

Overrides:

toString in class Object