構造体

Product.SubscriptionInfo.RenewalInfo

自動更新サブスクリプションの更新情報。

iOS 15.0+ iPadOS 15.0+ macOS 12.0+

tvOS 15.0+ visionOS 1.0+ watchOS 8.0+

struct RenewalInfo

以下で言及

あなたのアプリ内での商取引による再獲得提供
(Merchandising win-back offers in your app)

あなたのアプリでサブスクリプション提供コードをサポート
(Supporting subscription offer codes in your app)

サブスクリプションの更新とアプリ内購入の失敗をテストする
(Testing failing subscription renewals and In-App Purchases)

概観

Product.SubscriptionInfo.RenewalInfo は、次のサブスクリプション更新期間に関する情報を提供します。 state をチェックして、次の更新期間にサブスクリプションがアクティブ (サブスクライブ済み) か、期限切れか、または別の状態になるかを判断します。

トピックス

環境の取得

let environment: AppStore.Environment

自動更新サブスクリプションの更新情報に署名するサーバー環境。

取引 ID の取得

let originalTransactionID: UInt64

オリジナルの購入の取引 ID。

製品 ID の取得

let currentProductID: String

顧客がサブスクライブしているサブスクリプション製品 ID。

サブスクリプションの日付を取得

var recentSubscriptionStartDate: Date

60 日未満の有料サービスのすべての失効を無視する、一連の自動更新サブスクリプション購入におけるサブスクリプションの最も早い開始日。

var renewalDate: Date?

最新の自動更新サブスクリプション購入の有効期限が切れる UNIX 時間 (ミリ秒単位)。

更新または有効期限の状況を取得

let state: Product.SubscriptionInfo.RenewalState

自動更新サブスクリプションの更新状況。

let autoRenewPreference: String?

自動的に更新される自動更新サブスクリプションの製品 ID。

let willAutoRenew: Bool

サブスクリプションが次の期間に自動的に更新されるかどうかを示すブール値。

let expirationReason: Product.SubscriptionInfo.RenewalInfo.ExpirationReason?

自動更新サブスクリプションの有効期限が切れた理由。

struct ExpirationReason

自動更新サブスクリプションの有効期限が切れる理由。

サブスクリプション提供の取得

let offer: Transaction.Offer?

次の更新期間の取引に適用されるサブスクリプション提供。

struct Offer

取引に適用されるサブスクリプション提供。

let eligibleWinBackOfferIDs: [String]

顧客が引き換える資格のある再獲得提供の ID を表す文字列の配列。最適な提供を先頭に並べられています。

更新価格と通貨の取得

var renewalPrice: Decimal?

次の請求期間に更新される自動更新サブスクリプションの更新価格。

var currency: Locale.Currency?

サブスクリプションの更新価格の通貨。

請求状況の取得

let isInBillingRetry: Bool

自動更新サブスクリプションが課金再試行期間内にあるかどうかを示すブール値。

let gracePeriodExpirationDate: Date?

自動更新サブスクリプションの請求猶予期間が切れる日付。

価格上昇状況の取得

自動更新サブスクリプションの価格上昇の管理
(Managing Price Increases for Auto-Renewable Subscriptions)

あなたのアプリとサーバ上の自動更新サブスクリプションの価格上昇状況を識別します。

let priceIncreaseStatus: Product.SubscriptionInfo.RenewalInfo.PriceIncreaseStatus

自動更新サブスクリプションが価格上昇の対象となるかどうかを示す状況。

enum PriceIncreaseStatus

自動更新サブスクリプションが価格上昇の対象となるかどうかを示す状況の値。

サブスクリプション更新情報の確認

let deviceVerification: Data

更新情報がデバイスに属しているかどうかを確認するために使用するデバイス検証値。

let deviceVerificationNonce: UUID

デバイス検証値を計算するために使用する UUID。

let signedDate: Date

App Store が JWS 更新情報に署名した日付。

JSON 形式でサブスクリプション更新情報を取得

var jsonRepresentation: Data

サブスクリプション更新情報の JSON 表現。

廃止

~~var environmentStringRepresentation: String~~

自動更新サブスクリプションの更新情報に署名するサーバ環境の文字列表現。

廃止

~~var offerID: String?~~

次のサブスクリプション期間に適用される提供を識別する文字列。

廃止

~~var offerType: Transaction.OfferType?~~

次のサブスクリプション期間のサブスクリプション提供の種類。

廃止

~~var currencyCode: String?~~

製品の価格を表す 3 文字の ISO 4217 通貨コード。

廃止

~~var offerPaymentModeStringRepresentation: String?~~

廃止

以下に準拠

Copyable

CustomDebugStringConvertible

Equatable

Hashable

Sendable

以下も見よ

struct Status

自動更新サブスクリプションの更新状況情報。

struct RenewalState