Cycle Execution

The regular and trial execution details for a billing cycle.

Structure

CycleExecution

Fields

Name	Type	Tags	Description	Getter	Setter
TenureType	TenureType	Required, Read-only	The type of the billing cycle. Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[A-Z_]+$	TenureType getTenureType()	setTenureType(TenureType tenureType)
Sequence	int	Required	The order in which to run this cycle among other billing cycles. Constraints: >= 0, <= 99	int getSequence()	setSequence(int sequence)
CyclesCompleted	int	Required, Read-only	The number of billing cycles that have completed. Constraints: >= 0, <= 9999	int getCyclesCompleted()	setCyclesCompleted(int cyclesCompleted)
CyclesRemaining	Integer	Optional, Read-only	For a finite billing cycle, cycles_remaining is the number of remaining cycles. For an infinite billing cycle, cycles_remaining is set as 0. Constraints: >= 0, <= 9999	Integer getCyclesRemaining()	setCyclesRemaining(Integer cyclesRemaining)
CurrentPricingSchemeVersion	Integer	Optional, Read-only	The active pricing scheme version for the billing cycle. Constraints: >= 1, <= 99	Integer getCurrentPricingSchemeVersion()	setCurrentPricingSchemeVersion(Integer currentPricingSchemeVersion)
TotalCycles	Integer	Optional, Read-only	The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles). Constraints: >= 0, <= 999	Integer getTotalCycles()	setTotalCycles(Integer totalCycles)

Example

import com.paypal.sdk.models.CycleExecution;

CycleExecution cycleExecution = new CycleExecution.Builder(
    null,
    99,
    0
)
.build();