PayPal-PHP-Server-SDK/doc/models/cycle-execution.md

Cycle Execution

The regular and trial execution details for a billing cycle.

Structure

CycleExecution

Fields

Name	Type	Tags	Description	Getter	Setter
tenureType	string(TenureType)	Required	The type of the billing cycle. Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[A-Z_]+$	getTenureType(): string	setTenureType(string tenureType): void
sequence	int	Required	The order in which to run this cycle among other billing cycles. Constraints: >= 0, <= 99	getSequence(): int	setSequence(int sequence): void
cyclesCompleted	int	Required	The number of billing cycles that have completed. Constraints: >= 0, <= 9999	getCyclesCompleted(): int	setCyclesCompleted(int cyclesCompleted): void
cyclesRemaining	?int	Optional	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	getCyclesRemaining(): ?int	setCyclesRemaining(?int cyclesRemaining): void
currentPricingSchemeVersion	?int	Optional	The active pricing scheme version for the billing cycle. Constraints: >= 1, <= 99	getCurrentPricingSchemeVersion(): ?int	setCurrentPricingSchemeVersion(?int currentPricingSchemeVersion): void
totalCycles	?int	Optional	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	getTotalCycles(): ?int	setTotalCycles(?int totalCycles): void

Example (as JSON)

{
  "tenure_type": "REGULAR",
  "sequence": 99,
  "cycles_completed": 172,
  "cycles_remaining": 208,
  "current_pricing_scheme_version": 99,
  "total_cycles": 60
}