Skip to main content

SubscriptionFrequency

How often a subscription plan generates orders, with optional limits on the number of billing cycles.

type SubscriptionFrequency {
  description: String
  interval: SubscriptionInterval!
  intervalCount: NonZeroCount!
  maxCycles: NonZeroCount
  minCycles: NonZeroCount
}

Fields​

SubscriptionFrequency.description ● String scalar types​

A readable summary of the frequency, such as "Every 2 weeks".

SubscriptionFrequency.interval ● SubscriptionInterval! non-null enum types​

The unit of time between orders.

SubscriptionFrequency.intervalCount ● NonZeroCount! non-null scalar types​

The number of intervals between orders.

SubscriptionFrequency.maxCycles ● NonZeroCount scalar types​

The maximum number of billing cycles a subscription on the plan runs for. Empty means no limit.

SubscriptionFrequency.minCycles ● NonZeroCount scalar types​

The minimum number of billing cycles for a subscription on the plan.

Member Of​

SubscriptionPlan object