com.cardpay.sdk.model

Class SubscriptionFilterParameters

java.lang.Object

com.cardpay.sdk.model.SubscriptionFilterParameters

public class SubscriptionFilterParameters
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionFilterParameters.StatusEnum Status of subscription
static class	SubscriptionFilterParameters.TypeEnum Type of subscription.

Constructor Summary

Constructors

Constructor and Description
SubscriptionFilterParameters()

Method Summary

Modifier and Type	Method and Description
SubscriptionFilterParameters	currency(String currency)
SubscriptionFilterParameters	customerId(String customerId)
SubscriptionFilterParameters	endTime(OffsetDateTime endTime)
SubscriptionFilterParameters	maxCount(Integer maxCount) minimum: 1 maximum: 10000
SubscriptionFilterParameters	offset(Integer offset) minimum: 0 maximum: 10000
SubscriptionFilterParameters	planId(String planId)
SubscriptionFilterParameters	requestId(String requestId)
void	setCurrency(String currency)
void	setCustomerId(String customerId)
void	setEndTime(OffsetDateTime endTime)
void	setMaxCount(Integer maxCount)
void	setOffset(Integer offset)
void	setPlanId(String planId)
void	setRequestId(String requestId)
void	setSortOrder(String sortOrder)
void	setStartTime(OffsetDateTime startTime)
void	setStatus(SubscriptionFilterParameters.StatusEnum status)
void	setType(SubscriptionFilterParameters.TypeEnum type)
SubscriptionFilterParameters	sortOrder(String sortOrder)
SubscriptionFilterParameters	startTime(OffsetDateTime startTime)
SubscriptionFilterParameters	status(SubscriptionFilterParameters.StatusEnum status)
String	toString()
SubscriptionFilterParameters	type(SubscriptionFilterParameters.TypeEnum type)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionFilterParameters

public SubscriptionFilterParameters()

Method Detail

setRequestId

public void setRequestId(String requestId)

requestId

public SubscriptionFilterParameters requestId(String requestId)

Parameters:

requestId - Request ID

Returns:

bean instance

setMaxCount

public void setMaxCount(Integer maxCount)

maxCount

public SubscriptionFilterParameters maxCount(Integer maxCount)

minimum: 1 maximum: 10000

Parameters:

maxCount - Limit number of returned subscriptions (must be less than 10000, default is 1000)

Returns:

bean instance

setOffset

public void setOffset(Integer offset)

offset

public SubscriptionFilterParameters offset(Integer offset)

minimum: 0 maximum: 10000

Parameters:

offset - Offset (must be less than 10000)

Returns:

bean instance

setSortOrder

public void setSortOrder(String sortOrder)

sortOrder

public SubscriptionFilterParameters sortOrder(String sortOrder)

Parameters:

sortOrder - Sort based on order of results. 'asc' for ascending order or 'desc' for descending order (default value)

Returns:

bean instance

setCustomerId

public void setCustomerId(String customerId)

customerId

public SubscriptionFilterParameters customerId(String customerId)

Parameters:

customerId - Merchant identifier of customer account

Returns:

bean instance

setPlanId

public void setPlanId(String planId)

planId

public SubscriptionFilterParameters planId(String planId)

Parameters:

planId - Id of plan. Use for searching scheduled subscriptions by plan

Returns:

bean instance

setStartTime

public void setStartTime(OffsetDateTime startTime)

startTime

public SubscriptionFilterParameters startTime(OffsetDateTime startTime)

Parameters:

startTime - Date and time up to milliseconds (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when requested period starts (inclusive), UTC time, default is 24 hours before 'end_time' (format: yyyy-MM-dd'T'HH:mm:ss'Z')

Returns:

bean instance

setEndTime

public void setEndTime(OffsetDateTime endTime)

endTime

public SubscriptionFilterParameters endTime(OffsetDateTime endTime)

Parameters:

endTime - Date and time up to milliseconds (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when requested period ends (not inclusive), UTC time, must be less than 7 days after 'start_time', default is current time (format: yyyy-MM-dd'T'HH:mm:ss'Z')

Returns:

bean instance

setCurrency

public void setCurrency(String currency)

currency

public SubscriptionFilterParameters currency(String currency)

Parameters:

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

Returns:

bean instance

setStatus

public void setStatus(SubscriptionFilterParameters.StatusEnum status)

status

public SubscriptionFilterParameters status(SubscriptionFilterParameters.StatusEnum status)

Parameters:

status - Status of subscription

Returns:

bean instance

setType

public void setType(SubscriptionFilterParameters.TypeEnum type)

type

public SubscriptionFilterParameters type(SubscriptionFilterParameters.TypeEnum type)

Parameters:

type - Type of subscription. 'ONECLICK' type will be ignored.

Returns:

bean instance

toString

public String toString()

Overrides:

toString in class Object