StoreKit · IOS API REFERENCE

Product.SubscriptionPeriod

struct · iOS 15.0+ · SDK 27.1

struct SubscriptionPeriod

Represents the duration of time between subscription renewals.

Members (12)

get · iOS 16.4+

everyTwoWeeks

TypeScript

static get everyTwoWeeks(): Product_SubscriptionPeriod

Swift declaration

@backDeployed(before: iOS 18.0, macOS 15.0, tvOS 18.0, watchOS 11.0, visionOS 2.0)
static var everyTwoWeeks: Product.SubscriptionPeriod { get }

A period of two weeks.

get · iOS 16.4+

everySixMonths

TypeScript

static get everySixMonths(): Product_SubscriptionPeriod

Swift declaration

@backDeployed(before: iOS 18.0, macOS 15.0, tvOS 18.0, watchOS 11.0, visionOS 2.0)
static var everySixMonths: Product.SubscriptionPeriod { get }

A period of six months.

get · iOS 16.4+

everyThreeDays

TypeScript

static get everyThreeDays(): Product_SubscriptionPeriod

Swift declaration

@backDeployed(before: iOS 18.0, macOS 15.0, tvOS 18.0, watchOS 11.0, visionOS 2.0)
static var everyThreeDays: Product.SubscriptionPeriod { get }

A period of three days.

get · iOS 16.4+

everyTwoMonths

TypeScript

static get everyTwoMonths(): Product_SubscriptionPeriod

Swift declaration

@backDeployed(before: iOS 18.0, macOS 15.0, tvOS 18.0, watchOS 11.0, visionOS 2.0)
static var everyTwoMonths: Product.SubscriptionPeriod { get }

A period of two months.

get · iOS 15.0+

debugDescription

TypeScript

get debugDescription(): string

Swift declaration

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.

get · iOS 16.4+

everyThreeMonths

TypeScript

static get everyThreeMonths(): Product_SubscriptionPeriod

Swift declaration

@backDeployed(before: iOS 18.0, macOS 15.0, tvOS 18.0, watchOS 11.0, visionOS 2.0)
static var everyThreeMonths: Product.SubscriptionPeriod { get }

A period of three months.

get · iOS 15.0+

unit

TypeScript

get unit(): Product_SubscriptionPeriod_Unit

Swift declaration

let unit: Product.SubscriptionPeriod.Unit

The unit of time that this period represents.

get · iOS 15.0+

value

TypeScript

get value(): number

Swift declaration

let value: Int

The number of units that the period represents.

get · iOS 16.4+

weekly

TypeScript

static get weekly(): Product_SubscriptionPeriod

Swift declaration

@backDeployed(before: iOS 18.0, macOS 15.0, tvOS 18.0, watchOS 11.0, visionOS 2.0)
static var weekly: Product.SubscriptionPeriod { get }

A period of one week.

get · iOS 16.4+

yearly

TypeScript

static get yearly(): Product_SubscriptionPeriod

Swift declaration

@backDeployed(before: iOS 18.0, macOS 15.0, tvOS 18.0, watchOS 11.0, visionOS 2.0)
static var yearly: Product.SubscriptionPeriod { get }

A period of one year.

get · iOS 16.4+

monthly

TypeScript

static get monthly(): Product_SubscriptionPeriod

Swift declaration

@backDeployed(before: iOS 18.0, macOS 15.0, tvOS 18.0, watchOS 11.0, visionOS 2.0)
static var monthly: Product.SubscriptionPeriod { get }

A period of one month.

method · iOS 15.0+

dateRange

TypeScript

dateRange(referenceDate?: globalThis.Date): SDKHandle

Swift declaration

@backDeployed(before: iOS 16.0, macOS 13.0, tvOS 16.0, watchOS 9.0, macCatalyst 16.0)
func dateRange(referenceDate: Date = .now) -> Range<Date>

The range of the subscription period beginning at a reference date. Use this method with the `subscriptionPeriodFormatStyle` from a `Product`. - Parameter referenceDate: The date the range will begin at, default is now. - Returns: A range starting from `referenceDate` and ending after the subscription period.

Skipped declarations

2 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

Product.SubscriptionPeriod.formatted(_:referenceDate:)

This declaration needs Swift generic type arguments. (no canonical witness for S)

Product.SubscriptionPeriod.formatted(_:referenceDate:)

This declaration needs Swift generic type arguments. (no canonical witness for S)

All StoreKit types →