RecurringPlanRequestPlanData (java-sdk 3.73.6 API)

java.lang.Object
- com.cardpay.sdk.model.RecurringPlanRequestPlanData

public class RecurringPlanRequestPlanData
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RecurringPlanRequestPlanData.PeriodEnum
Initial period of recurring, can be `day`, `week`, `month`, `year`.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RecurringPlanRequestPlanData.PeriodEnum` Initial period of recurring, can be `day`, `week`, `month`, `year`.

Constructor Summary

Constructors
Constructor and Description

RecurringPlanRequestPlanData()

Constructors
Constructor and Description
`RecurringPlanRequestPlanData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecurringPlanRequestPlanData`	`addQuantityItem(PlanQuantity quantityItem)`
`RecurringPlanRequestPlanData`	`amount(BigDecimal amount)`
`RecurringPlanRequestPlanData`	`currency(String currency)`
`RecurringPlanRequestPlanData`	`interval(Integer interval)` minimum: 1 maximum: 365
`RecurringPlanRequestPlanData`	`name(String name)`
`RecurringPlanRequestPlanData`	`period(RecurringPlanRequestPlanData.PeriodEnum period)`
`RecurringPlanRequestPlanData`	`pricingModel(String pricingModel)`
`RecurringPlanRequestPlanData`	`quantity(List<PlanQuantity> quantity)`
`RecurringPlanRequestPlanData`	`retries(Integer retries)` minimum: 1 maximum: 15
`void`	`setAmount(BigDecimal amount)`
`void`	`setCurrency(String currency)`
`void`	`setInterval(Integer interval)`
`void`	`setName(String name)`
`void`	`setPeriod(RecurringPlanRequestPlanData.PeriodEnum period)`
`void`	`setPricingModel(String pricingModel)`
`void`	`setQuantity(List<PlanQuantity> quantity)`
`void`	`setRetries(Integer retries)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RecurringPlanRequestPlanData
```
public RecurringPlanRequestPlanData()
```
- Method Detail
  - setAmount
```
public void setAmount(BigDecimal amount)
```
  - amount
```
public RecurringPlanRequestPlanData amount(BigDecimal amount)
```
    Parameters:
    
    amount - The amount charged per period defined in plan in selected currency with dot as a decimal separator, limit is defined by payment method and transaction details.
    
    Returns:
    
    bean instance
  - setCurrency
```
public void setCurrency(String currency)
```
  - currency
```
public RecurringPlanRequestPlanData currency(String currency)
```
    Parameters:
    
    currency - [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of plan
    
    Returns:
    
    bean instance
  - setInterval
```
public void setInterval(Integer interval)
```
  - interval
```
public RecurringPlanRequestPlanData interval(Integer interval)
```
    minimum: 1 maximum: 365
    
    Parameters:
    
    interval - The frequency interval of period, can be 1-365 depending on selected period value. Maximum value of period + interval can be 365 days / 52 weeks / 12 months / 1 year. From 1 to 60 minutes - for **sandbox** environment and testing purpose only
    
    Returns:
    
    bean instance
  - setName
```
public void setName(String name)
```
  - name
```
public RecurringPlanRequestPlanData name(String name)
```
    Parameters:
    
    name - Plan name
    
    Returns:
    
    bean instance
  - setPeriod
```
public void setPeriod(RecurringPlanRequestPlanData.PeriodEnum period)
```
  - period
```
public RecurringPlanRequestPlanData period(RecurringPlanRequestPlanData.PeriodEnum period)
```
    Parameters:
    
    period - Initial period of recurring, can be `day`, `week`, `month`, `year`. Additional period: `minute` - for **sandbox** and testing purpose only.
    
    Returns:
    
    bean instance
  - setPricingModel
```
public void setPricingModel(String pricingModel)
```
  - pricingModel
```
public RecurringPlanRequestPlanData pricingModel(String pricingModel)
```
    Parameters:
    
    pricingModel - Parameter regulates the price calculation pricing_model depending on the number of units Possible values: `FIXED` `TIERED` `VOLUME` By default - `FIXED`
    
    Returns:
    
    bean instance
  - setQuantity
```
public void setQuantity(List<PlanQuantity> quantity)
```
  - quantity
```
public RecurringPlanRequestPlanData quantity(List<PlanQuantity> quantity)
```
    Parameters:
    
    quantity - Array with units quantity. Mandatory if `pricing_model` is `TIERED` or `VOLUME`
    
    Returns:
    
    bean instance
  - addQuantityItem
```
public RecurringPlanRequestPlanData addQuantityItem(PlanQuantity quantityItem)
```
  - setRetries
```
public void setRetries(Integer retries)
```
  - retries
```
public RecurringPlanRequestPlanData retries(Integer retries)
```
    minimum: 1 maximum: 15
    
    Parameters:
    
    retries - Number of daily basis retry attempts in case of payment has not been captured successfully, from 1 to 15 attempts can be specified.
    
    Returns:
    
    bean instance
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RecurringPlanRequestPlanData

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecurringPlanRequestPlanData

Method Detail

setAmount

amount

setCurrency

currency

setInterval

interval

setName

name

setPeriod

period

setPricingModel

pricingModel

setQuantity

quantity

addQuantityItem

setRetries

retries

toString