Frequency

November 13, 2025 ยท View on GitHub

The frequency of the billing cycle.

Structure

Frequency

Fields

NameTypeTagsDescriptionGetterSetter
IntervalUnitIntervalUnitRequiredThe interval at which the subscription is charged or billed.

Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[A-Z_]+$
IntervalUnit getIntervalUnit()setIntervalUnit(IntervalUnit intervalUnit)
IntervalCountIntegerOptionalThe number of intervals after which a subscriber is billed. For example, if the interval_unit is DAY with an interval_count of 2, the subscription is billed once every two days. The following table lists the maximum allowed values for the interval_count for each interval_unit: Interval unit Maximum interval count DAY 365 WEEK 52 MONTH 12 YEAR 1

Default: 1

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

Example (as JSON)

{
  "interval_unit": "DAY",
  "interval_count": 1
}