Cycle Frequency

August 21, 2026 ยท View on GitHub

The frequency of the terms reset cycle.

Structure

CycleFrequency

Fields

NameTypeTagsDescriptionGetterSetter
IntervalUnitFrequencyIntervalUnitRequiredThe interval unit at which the the usage limits will be reset.

Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[A-Z_]+$
FrequencyIntervalUnit getIntervalUnit()setIntervalUnit(FrequencyIntervalUnit intervalUnit)
IntervalCountIntegerOptionalThe interval count at which the terms will be reset, this is ignored if the unit is LIFETIME.

Default: 1

Constraints: >= 1, <= 365
Integer getIntervalCount()setIntervalCount(Integer intervalCount)

Example

import com.paypal.sdk.models.CycleFrequency;
import com.paypal.sdk.models.FrequencyIntervalUnit;

CycleFrequency cycleFrequency = new CycleFrequency.Builder(
    FrequencyIntervalUnit.YEAR
)
.intervalCount(1)
.build();